Extends

• ht.ui.Data

Methods

formatValue(value, data) → {any}

将要显示的值传入此方法格式化处理并返回，一般用于将数字转换更易读的文本格式

Parameters:

Name	Type	Attributes	Description
value	any		格式化之前值
data	ht.Data	<optional>	数据元素

Returns:

any -

格式化之后的值

getAccessType() → {string}

获取列的属性类型，值列表如下：
null: 默认类型，如 name 为 age，采用g etAge() 和 setAge(98) 的 get/set 或 is/set 方式存取
style: 如 name 为 age，采用 getStyle('age') 和 setStyle('age', 98) 的方式存取
field：如 name 为age，采用 data.age 和 data.age = 98 的方式存取
attr：如 name 为 age，采用 getAttr('age') 和 setAttr('age', 98) 的方式存取

Returns:

string

getAlign() → {string}

获取文字(表头和内容)的水平对齐方式，可用值有 left|right|center，默认为 left

Returns:

string

getEditorClass() → {string|function}

获取列的编辑类, 如 'ht.editor.StringEditor'

Returns:

string | function -

编辑器类或类名

getFixed() → {string}

获取锁定方式

Returns:

string

getPaddingLeft() → {number}

获取列左侧内边距

Returns:

number -

左侧内边距

getPaddingRight() → {number}

获取列右侧内边距

Returns:

number -

右侧内边距

getSortFunc() → {Object}

获取排序函数

Returns:

Object -

排序函数

getSortOrder() → {string}

获取排序状态

asc: 升序
desc: 降序

Returns:

string

getSummary() → {string}

获取统计方式

Returns:

string -

统计方式

getToolTip(data, tableView) → {string}

获取提示文字

Parameters:

Name	Type	Attributes	Description
data	ht.Data	<optional>	数据元素
tableView	ht.ui.TableView	<optional>	视图对象

Returns:

string

getValue(data, column, view) → {any}

自定义要显示的单元格内容

Parameters:

Name	Type	Description
data	ht.Data	数据元素
column	ht.ui.Column	列
view	ht.ui.View	视图组件

Returns:

any -

自定义的显示内容

getValueType() → {string}

获取值类型，值类型用于提示组件提供合适的 renderer 渲染
null：默认类型，显示为文本方式
string：字符串类型，显示为文本方式
boolean：布尔类型，显示为勾选框
color：颜色类型，以填充背景色的方式显示
int：整型类型，文本编辑器改变值时自动通过 parseInt 进行转换
number：浮点数类型，文本编辑器改变值时自动通过 parseFloat 转换

Returns:

string

getWidth() → {number}

获取列宽度, 默认为 80

Returns:

number -

宽度值

isBatchEditable() → {boolean}

判断该列是否允许多选时批量编辑

Returns:

boolean -

是否可批量编辑

isEditable(data) → {boolean}

判断此列是否可编辑

Parameters:

Name	Type	Description
data	ht.Data	数据元素

Returns:

boolean -

是否可编辑

isSortable() → {boolean}

判断当前列是否可排序

Returns:

boolean -

是否可排序

isVisible() → {boolean}

判断当前列是否是否可见

Returns:

boolean -

是否可见

setAccessType(accessType) → {void}

设置列的属性类型，可选值如下：

null: 默认类型，如 name 为 age，采用 getAge() 和 setAge(98) 的 get/set 或 is/set 方式存取
style: 如 name 为 age，采用 getStyle('age') 和 setStyle('age', 98) 的方式存取
field：如 name 为 age，采用 data.age 和 data.age = 98 的方式存取
attr：如 name 为 age，采用 getAttr('age') 和 setAttr('age', 98) 的方式存取

Parameters:

Name	Type	Description
accessType	string

Returns:

void

setAlign(align) → {void}

设置文字的水平对齐方式，可用值有 left|right|center，默认为 left

Parameters:

Name	Type	Description
align	string	对齐方式

Returns:

void

setBatchEditable(batchEditable) → {void}

设置列是否允许多选时批量编辑

Parameters:

Name	Type	Description
batchEditable	boolean	是否可批量编辑

Returns:

void

setEditable(editable) → {void}

设置此列是否可编辑

Parameters:

Name	Type	Description
editable	boolean	是否可编辑

Returns:

void

setEditorClass(editorClass) → {void}

设置列的编辑类, 如 'ht.editor.StringEditor'

Parameters:

Name	Type	Description
editorClass	string | function	编辑器类或类名

Returns:

void

setFixed(fixed) → {void}

设置锁定方式；锁定列固定显示在表格左侧或右侧，不会跟随横向滚动条滚动

Parameters:

Name	Type	Description
fixed	string	'left' 或者 'right'

Returns:

void

setPaddingLeft(paddingLeft) → {void}

设置列左侧内边距

Parameters:

Name	Type	Description
paddingLeft	number	左侧内边距

Returns:

void

setPaddingRight(paddingRight) → {void}

获取列右侧内边距

Parameters:

Name	Type	Description
paddingRight	number	右侧内边距

Returns:

void

setSortable(sortable) → {void}

设置列是否可排序

Parameters:

Name	Type	Description
sortable	boolean	是否允许排序

Returns:

void

setSortFunc(func) → {void}

设置排序函数

Parameters:

Name	Type	Description
func	Object	排序函数

Returns:

void

setSortOrder(sortOrder) → {void}

设置排序状态
asc: 升序
desc: 降序

Parameters:

Name	Type	Description
sortOrder	string

Returns:

void

setSummary(summary) → {void}

设置统计方式；统计数据显示在 TableFooter 组件中

Parameters:

Name	Type	Description
summary	string	统计方式，支持：sum|min|max|average|first

Returns:

void

setValueType(type) → {void}

设置值类型，值类型用于提示组件提供合适的 renderer 渲染

null：默认类型，显示为文本方式
string：字符串类型，显示为文本方式
boolean：布尔类型，显示为勾选框
color：颜色类型，以填充背景色的方式显示
int：整型类型，文本编辑器改变值时自动通过 parseInt 进行转换
number：浮点数类型，文本编辑器改变值时自动通过 parseFloat 转换

Parameters:

Name	Type	Description
type	string	值类型

Returns:

void

setVisible(visible) → {void}

设置列是否是否可见

Parameters:

Name	Type	Description
visible	boolean	是否可见

Returns:

void

setWidth(width) → {void}

设置列宽度

Parameters:

Name	Type	Description
width	number	宽度值，如果值为负数表示占据表格剩余空间的百分比，如 -0.1，表示当前列的宽度为表格剩余宽度的百分之十

Returns:

void