ht.ui.GroupColumn()

new GroupColumn()

分组列，只用于对普通列进行分组，不能用使用排序、编辑等功能

Example
var column1 = new ht.ui.Column();
// init column1

var column2 = new ht.ui.Column();
// init column2

var groupColumn = new ht.ui.GroupColumn();
groupColumn.setName('Group Column');
groupColumn.addChild(column1);
groupColumn.addChild(column2);

columnModel.add(column1);
columnModel.add(column2);
columnModel.add(groupColumn);

Extends

Methods

addChild(column) → {void}

增加子列

Parameters:
Name Type Description
column ht.ui.Column

被嵌套的列
Returns:
void

formatValue(value, data) → {any}

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

Parameters:
Name Type Attributes Description
value any

格式化之前值
data ht.Data <optional>

数据元素
Returns:
any -

格式化之后的值

Inherited From:

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
Inherited From:

getAlign() → {string}

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

Returns:
string
Inherited From:

getEditorClass() → {string|function}

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

Returns:
string | function -

编辑器类或类名

Inherited From:

getFixed() → {string}

获取锁定方式

Returns:
string
Inherited From:

getPaddingLeft() → {number}

获取列左侧内边距

Returns:
number -

左侧内边距

Inherited From:

getPaddingRight() → {number}

获取列右侧内边距

Returns:
number -

右侧内边距

Inherited From:

getSortFunc() → {Object}

获取排序函数

Returns:
Object -

排序函数

Inherited From:

getSortOrder() → {string}

获取排序状态

asc: 升序
desc: 降序

Returns:
string
Inherited From:

getSummary() → {string}

获取统计方式

Returns:
string -

统计方式

Inherited From:

getToolTip(data, tableView) → {string}

获取提示文字

Parameters:
Name Type Attributes Description
data ht.Data <optional>

数据元素
tableView ht.ui.TableView <optional>

视图对象
Returns:
string
Inherited From:

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

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

Parameters:
Name Type Description
data ht.Data

数据元素
column ht.ui.Column

列
view ht.ui.View

视图组件
Returns:
any -

自定义的显示内容

Inherited From:

getValueType() → {string}

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

Returns:
string
Inherited From:

getWidth() → {number}

获取列宽度, 默认为 80

Returns:
number -

宽度值

Inherited From:

isBatchEditable() → {boolean}

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

Returns:
boolean -

是否可批量编辑

Inherited From:

isEditable(data) → {boolean}

判断此列是否可编辑

Parameters:
Name Type Description
data ht.Data

数据元素
Returns:
boolean -

是否可编辑

Inherited From:

isSortable() → {boolean}

判断当前列是否可排序

Returns:
boolean -

是否可排序

Inherited From:

isVisible() → {boolean}

判断当前列是否是否可见

Returns:
boolean -

是否可见

Inherited From:

removeChild(column) → {void}

删除子列

Parameters:
Name Type Description
column ht.ui.Column

被嵌套的列
Returns:
void

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
Inherited From:

setAlign(align) → {void}

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

Parameters:
Name Type Description
align string

对齐方式
Returns:
void
Inherited From:

setBatchEditable(batchEditable) → {void}

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

Parameters:
Name Type Description
batchEditable boolean

是否可批量编辑
Returns:
void
Inherited From:

setEditable(editable) → {void}

设置此列是否可编辑

Parameters:
Name Type Description
editable boolean

是否可编辑
Returns:
void
Inherited From:

setEditorClass(editorClass) → {void}

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

Parameters:
Name Type Description
editorClass string | function

编辑器类或类名
Returns:
void
Inherited From:

setFixed(fixed) → {void}

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

Parameters:
Name Type Description
fixed string

'left' 或者 'right'
Returns:
void
Inherited From:

setPaddingLeft(paddingLeft) → {void}

设置列左侧内边距

Parameters:
Name Type Description
paddingLeft number

左侧内边距
Returns:
void
Inherited From:

setPaddingRight(paddingRight) → {void}

获取列右侧内边距

Parameters:
Name Type Description
paddingRight number

右侧内边距
Returns:
void
Inherited From:

setSortable(sortable) → {void}

设置列是否可排序

Parameters:
Name Type Description
sortable boolean

是否允许排序
Returns:
void
Inherited From:

setSortFunc(func) → {void}

设置排序函数

Parameters:
Name Type Description
func Object

排序函数
Returns:
void
Inherited From:

setSortOrder(sortOrder) → {void}

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

Parameters:
Name Type Description
sortOrder string
Returns:
void
Inherited From:

setSummary(summary) → {void}

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

Parameters:
Name Type Description
summary string

统计方式，支持：sum|min|max|average|first
Returns:
void
Inherited From:

setValueType(type) → {void}

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

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

Parameters:
Name Type Description
type string

值类型
Returns:
void
Inherited From:

setVisible(visible) → {void}

设置列是否是否可见

Parameters:
Name Type Description
visible boolean

是否可见
Returns:
void
Inherited From:

setWidth(width) → {void}

设置列宽度

Parameters:
Name Type Description
width number

宽度值，如果值为负数表示占据表格剩余空间的百分比，如 -0.1，表示当前列的宽度为表格剩余宽度的百分之十
Returns:
void
Inherited From: