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

a(name, value) → {ht.Data}

设置attr属性, 有两个参数时相当于setAttr

Parameters:
Name Type Description
name string

属性名
value any

属性值
Returns:
ht.Data
Inherited From:

addChild(column) → {void}

增加子列

Parameters:
Name Type Description
column ht.ui.Column

被嵌套的列
Returns:
void
Overrides:

addStyleIcon(name, icon) → {void}

增加 style 中 icons 属性

Parameters:
Name Type Description
name string

名称
icon any

icon 定义
Returns:
void
Inherited From:

appendAnchorMatrix3d(matrix) → {void}

追加锚点矩阵

Parameters:
Name Type Description
matrix Array.<number>
Returns:
void
Inherited From:

beginTransaction() → {void}

开启所在数据模型事务

Returns:
void
Inherited From:

ca(name) → {any}

自动附加当前前缀，获得对应属性

Parameters:
Name Type Description
name string
Returns:
any
Inherited From:

clearChildren() → {void}

删除所有孩子节点，

Returns:
void
Inherited From:

clearChildrenFromDataModel() → {void}

删除所有孩子节点，并从数据模型移出

Returns:
void
Inherited From:

dm() → {ht.DataModel}

获取当前节点所在数据模型

Returns:
ht.DataModel
Inherited From:

eachChild(func, scope) → {void}

遍历所有子节点

Parameters:
Name Type Attributes Description
func Object

遍历函数 (data, index) => {}
scope any <optional>

作用域
Returns:
void
Inherited From:

endTransaction() → {void}

结束所在数据模型事务

Returns:
void
Inherited From:

firePropertyChange(property, oldValue, newValue) → {void}

派发属性变化事件，可使用fp的简写方式

Parameters:
Name Type Description
property string

属性
oldValue any

旧值
newValue any

新值
Returns:
void
Inherited From:

formatValue(value, data) → {any}

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

Parameters:
Name Type Attributes Description
value any

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

数据元素
Returns:
any -

格式化之后的值

Inherited From:

fp(property, oldValue, newValue) → {void}

派发属性变化事件，firePropertyChange 方法的简写

Parameters:
Name Type Description
property string

属性
oldValue any

旧值
newValue any

新值
Returns:
void
Inherited From:

get3dUIClass() → {function}

获取3D组件上的UI类

Returns:
function -

UI类声明(构造函数)

Since:
  • 7.7.1
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:

getAnimation() → {object}

获取动画配置

Requires:
  • module:ht-animation.js
Returns:
object
Inherited From:

getAttr(name) → {any}

获取attr属性

Parameters:
Name Type Description
name string

属性名
Returns:
any
Inherited From:

getAttrObject() → {any}

返回所有属性集合对象，当没设置过任何属性可能会返回 undefined

Returns:
any
Inherited From:

getChildAt(index) → {ht.Data}

返回指定索引位置的孩子

Parameters:
Name Type Description
index number

索引
Returns:
ht.Data -

索引对应的孩子

Inherited From:

getChildren() → {ht.List}

获取所有孩子节点

Returns:
ht.List -

孩子元素集合

Inherited From:

getClass() → {any}

获取类声明(构造函数)

Returns:
any -

类声明(构造函数)

Inherited From:

getClassName() → {string}

获取类全名，继承Data并希望序列化时应该重写此方法返回子类的类名字符串

Returns:
string -

类全名

Inherited From:

getCurrentPrefix() → {string}

返回当前运行态前缀内容

Returns:
string
Inherited From:

getDataBindings() → {Object}

获取数据绑定对象

Returns:
Object -

数据绑定对象

Inherited From:

getDataModel() → {ht.DataModel}

获取所属的DataModel

Returns:
ht.DataModel -

DataModel数据模型

Inherited From:

getDisplayName() → {string}

获取显示名称，常作为Column和Property的列头和属性名称显示

Returns:
string -

显示名称

Inherited From:

getEditorClass() → {string|function}

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

Returns:
string | function -

编辑器类或类名

Inherited From:

getFixed() → {string}

获取锁定方式

Returns:
string
Inherited From:

getIcon() → {any}

获取小图标名称，常作为TreeView和ListView等组件上的节点小图标

Returns:
any -

图标名或矢量

Inherited From:

getId() → {string|number}

获取唯一编号

Returns:
string | number -

唯一编号

Inherited From:

getLayer() → {string|number}

获取数据元素在GraphView组件中的图层位置

Returns:
string | number -

图层名

Inherited From:
Default Value:
  • 0

getName() → {string}

获取数据元素名

Returns:
string -

名称

Inherited From:

getOwnStyle(name) → {any}

获取节点的样式属性值。当前节点上没有这个属性值是会返回 undefined, 而 getStyle 方法会返回默认值

Parameters:
Name Type Description
name string

样式
Returns:
any
Since:
  • 7.7.0
Inherited From:

getPaddingLeft() → {number}

获取列左侧内边距

Returns:
number -

左侧内边距

Inherited From:

getPaddingRight() → {number}

获取列右侧内边距

Returns:
number -

右侧内边距

Inherited From:

getParent() → {ht.Data}

获取父元素

Returns:
ht.Data -

父元素

Inherited From:

getRenderLayer() → {string|number}

获取三维渲染层级, 配合 ht.Default 中的 getRenderLayerInfo 和 setRenderLayerInfo 使用

Returns:
string | number
Inherited From:

getRenderLayerMask() → {string|number}

获取三维渲染层级掩码

Returns:
string | number
Since:
  • 7.7.0
Inherited From:

getSerializableAttrs() → {any}

此函数返回一个map，决定序列化时哪些attr属性可被序列化，默认所有attr对象里的属性都会被序列化

Returns:
any -

需要被序列化的attr属性map

Inherited From:
Example
function(){
    var name, map = ;
    for (name in this._attrObject) {
        map[name] = 1;
    }
    returns map;
}

getSerializableProperties() → {any}

此函数返回一个map，决定序列化时哪些属性可被序列化，如果有自定义的get/set属性并且需要序列化，应该重写此方法

Returns:
any -

需要被序列化的属性map

Inherited From:
Example
function(){
    returns {
        name: 1,
        displayName: 1,
        icon: 1,
        toolTip: 1,
        parent: 1,
        layer: 1,
        tag: 1,
        adjustChildrenToTop: 1
    };
}

getSerializableStyles() → {any}

此函数返回一个map，决定序列化时哪些样式可被序列化，默认所有样式都会被序列化

Returns:
any -

需要被序列化的样式map

Inherited From:
Example
function(){
    var name, map = ;
    for (name in this._styleMap) {
        map[name] = 1;
    }
    returns map;
}

getSortFunc() → {Object}

获取排序函数

Returns:
Object -

排序函数

Inherited From:

getSortOrder() → {string}

获取排序状态

asc: 升序
desc: 降序

Returns:
string
Inherited From:

getStyle(name) → {any}

获取样式属性

Parameters:
Name Type Description
name string

样式名
Returns:
any
Inherited From:

getStyleMap() → {any}

获取图元内部样式映射信息

Returns:
any -

样式映射表

Inherited From:

getSummary() → {string}

获取统计方式

Returns:
string -

统计方式

Inherited From:

getSuperClass() → {function}

获取父类声明(构造函数)，继承类时可以用来调用父类构造或函数

Returns:
function -

父类声明(构造函数)

Inherited From:
Example
function MyNode() {
     this.getSuperClass().call(this);//调用父类构造函数
}
ht.Default.def(MyNode, Data, {
   setName: function(name) {
   	this.getSuperClass().prototype.setName.call(this, name);//调用父类的setName函数
   	this._username = name;
   }
});

getTag() → {string}

获取标示号，可通过getDataByTag快速查找

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:

getUIClass() → {function}

获取拓扑组件上的UI类

Returns:
function -

UI类声明(构造函数)

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:

hasChildren() → {boolean}

判断是否有孩子

Returns:
boolean -

是否有孩子

Inherited From:

invalidate() → {void}

强制触发属性变化事件通知界面更新

Returns:
void
Inherited From:

isAdjustChildrenToTop() → {boolean}

GraphView点击图元会自动sendToTop，该属性决定是否对子图元也进行sendToTop操作

Returns:
boolean -

是否将children自动sendToTop

Inherited From:

isAnimationPlaying() → {boolean}

动画是否正在播放中

Returns:
boolean
Since:
  • 7.7.0
Inherited From:

isBatchEditable() → {boolean}

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

Returns:
boolean -

是否可批量编辑

Inherited From:

isDescendantOf(data) → {boolean}

判断自身是否为指定data的子孙

Parameters:
Name Type Description
data ht.Data

要对比的数据元素
Returns:
boolean -

自身是否为指定data的子孙

Inherited From:

isEditable(data) → {boolean}

判断此列是否可编辑

Parameters:
Name Type Description
data ht.Data

数据元素
Returns:
boolean -

是否可编辑

Inherited From:

isEmpty() → {boolean}

判断是否有孩子，同hasChildren

Returns:
boolean -

是否有孩子

Inherited From:

isParentOf(data) → {boolean}

判断自身是否为指定data的父亲

Parameters:
Name Type Description
data ht.Data

要对比的数据元素
Returns:
boolean -

自身是否为指定data的父亲

Inherited From:

isRelatedTo(data) → {boolean}

判断自身与指定data是否有父子或子孙关系

Parameters:
Name Type Description
data ht.Data

要对比的数据元素
Returns:
boolean -

自身与指定data是否有父子或子孙关系

Inherited From:

isSortable() → {boolean}

判断当前列是否可排序

Returns:
boolean -

是否可排序

Inherited From:

isVisible() → {boolean}

判断当前列是否是否可见

Returns:
boolean -

是否可见

Inherited From:

iv() → {void}

强制触发属性变化事件通知界面更新，invalidate的缩写

Returns:
void
Inherited From:

onChildAdded(child, index) → {void}

添加孩子时的回调函数，可重载做后续处理

Parameters:
Name Type Description
child ht.Data

新增加的孩子元素
index number

索引
Returns:
void
Inherited From:

onChildRemoved(child, index) → {void}

删除孩子时的回调函数，可重载做后续处理

Parameters:
Name Type Description
child ht.Data

被删除的孩子元素
index number

索引
Returns:
void
Inherited From:

onParentChanged(oldParent, parent) → {void}

改变父亲元素时的回调函数，可重载做后续处理

Parameters:
Name Type Description
oldParent ht.Data

旧的父元素
parent ht.Data

新的父元素
Returns:
void
Inherited From:

onPropertyChanged(event) → {void}

属性变化回调函数，可重载做后续处理

Parameters:
Name Type Description
event any

属性变化事件
Returns:
void
Inherited From:
Example
//event格式：
{
	   property: 'name',//发生变化的属性
	   oldValue: 'oldValue',//旧值
	   newValue: 'newValue',''新值
	   data: data//发生变化的data
}

onStyleChanged(name, oldValue, newValue) → {void}

样式属性变化时会回调该函数，可重载做后续处理

Parameters:
Name Type Description
name string

样式名
oldValue any

旧的样式值
newValue any

新的样式值
Returns:
void
Inherited From:

pauseAnimation() → {void}

暂停动画

Requires:
  • module:ht-animation.js
Returns:
void
Inherited From:

removeChild(column) → {void}

删除子列

Parameters:
Name Type Description
column ht.ui.Column

被嵌套的列
Returns:
void
Overrides:

removeFromDataModel() → {void}

从数据模型中移出

Returns:
void
Inherited From:

removeStyleIcon(name) → {void}

删除icon

Parameters:
Name Type Description
name string

要删除的icon名
Returns:
void
Inherited From:

resumeAnimation() → {void}

继续播放动画

Requires:
  • module:ht-animation.js
Returns:
void
Inherited From:

s(name, value) → {ht.Data}

获取或设置样式，仅有一个参数时相当于getStyle，有两个参数时相当于setStyle

Parameters:
Name Type Description
name string

样式名
value any

样式值
Returns:
ht.Data
Inherited From:

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:

setAdjustChildrenToTop(adjustToTop) → {void}

GraphView点击图元会自动sendToTop，该属性决定是否对子图元也进行sendToTop操作

Parameters:
Name Type Description
adjustToTop boolean

是否将children自动sendToTop
Returns:
void
Inherited From:

setAlign(align) → {void}

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

Parameters:
Name Type Description
align string

对齐方式
Returns:
void
Inherited From:

setAnimation(config) → {void}

设置节点动画属性，当属性为 null 时为清除动画

Parameters:
Name Type Description
config object

动画配置
Requires:
  • module:ht-animation.js
Returns:
void
Inherited From:

setAttr(name, value) → {void}

设置attr属性

Parameters:
Name Type Description
name string

属性名
value any

属性值
Returns:
void
Inherited From:

setAttrObject(attrObject) → {void}

设置attr属性对象，该属性默认为空，用于存储用户业务信息

Parameters:
Name Type Description
attrObject any

attr属性对象
Returns:
void
Inherited From:

setBatchEditable(batchEditable) → {void}

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

Parameters:
Name Type Description
batchEditable boolean

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

setDataBindings(dataBindings) → {void}

设置数据绑定

Parameters:
Name Type Description
dataBindings Object

数据绑定对象
Returns:
void
Inherited From:

setDisplayName(displayName) → {void}

设置显示名称，常作为Column和Property的列头和属性名称显示

Parameters:
Name Type Description
displayName string

显示名称
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:

setIcon(icon) → {void}

设置小图标名称，常作为TreeView和ListView等组件上的节点小图标

Parameters:
Name Type Description
icon any

图标名或矢量
Returns:
void
Inherited From:

setId(id) → {void}

设置唯一编号，如果手工设置，一定要确保在data加入到DataModel之前设置并且唯一不重复

Parameters:
Name Type Description
id string | number

唯一编号
Returns:
void
Inherited From:

setLayer(layer) → {void}

设置数据元素在GraphView组件中的图层位置

Parameters:
Name Type Attributes Description
layer string | number <optional>

图层名
Returns:
void
Inherited From:

setName(name) → {void}

设置数据元素名称

Parameters:
Name Type Description
name string

数据元素名称
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:

setParent(parent) → {void}

设置父元素

Parameters:
Name Type Description
parent ht.Data

父元素
Returns:
void
Inherited From:

setRenderLayer(layerName) → {void}

设置节点的三维渲染层级，配合 ht.Default 中的 getRenderLayerInfo 和 setRenderLayerInfo 使用

Parameters:
Name Type Description
layerName string | 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:

setStyle(name, value) → {void}

设置样式

Parameters:
Name Type Description
name string

样式名
value any

样式值
Returns:
void
Inherited From:

setStyleMap(styleMap) → {void}

设置节点样式对象

Parameters:
Name Type Description
styleMap any
Returns:
void
Inherited From:

setSummary(summary) → {void}

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

Parameters:
Name Type Description
summary string

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

setTag(tag) → {void}

设置标示号，可通过getDataByTag快速查找

Parameters:
Name Type Description
tag string

标示号
Returns:
void
Inherited From:

setToolTip(toolTip) → {void}

设置文字提示信息

Parameters:
Name Type Description
toolTip string

文字提示
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:

size() → {number}

获取孩子元素总数

Returns:
number -

孩子元素总数

Inherited From:

testRenderLayer(layerName) → {boolean}

测试对应的渲染层级名是否被注册

Parameters:
Name Type Description
layerName string

渲染层级
Returns:
boolean
Since:
  • 7.7.0
Inherited From:

toChildren(matchFunc, scope) → {ht.List}

以matchFunc为过滤函数构建新的孩子元素集合

Parameters:
Name Type Attributes Description
matchFunc function <optional>

过滤函数
scope any <optional>

函数域
Returns:
ht.List -

孩子元素集合

Inherited From:
Example
var list = data.toChildren(function(child) {
    if (child.a('visible')) {
   	   returns true;
    }
});

toLabel() → {string}

返回值作为TreeView和GraphView等组件上的图元文字标签，默认返回displayName||name信息

Returns:
string -

文字标签

Inherited From:

toString() → {string}

重写 js 默认的 toString, 优先返回 displayName|name，再者是 tag，如果displayName|name|tag都没有值，则返回 ID

Returns:
string -

数据名称/标签/ID

Inherited From: