Class: Property | HT for Web

new Property()

Extends

ht.Data

Methods

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

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

Parameters:

Name	Type	Description
`name`	string	属性名
`value`	any	属性值

Returns:

ht.Data

Inherited From:

ht.Data#a

addChild(child, index) → {void}

添加孩子节点

Parameters:

Name	Type	Attributes	Description
`child`	ht.Data		子元素
`index`	number	<optional>	插入索引，为空则插入作为最后的孩子

Returns:

void

Inherited From:

ht.Data#addChild

addStyleIcon(name, icon) → {void}

增加 style 中 icons 属性

Parameters:

Name	Type	Description
`name`	string	名称
`icon`	any	icon 定义

Returns:

void

Inherited From:

ht.Data#addStyleIcon

appendAnchorMatrix3d(matrix) → {void}

追加锚点矩阵

Parameters:

Name	Type	Description
`matrix`	Array.<number>

Returns:

void

Inherited From:

ht.Data#appendAnchorMatrix3d

beginTransaction() → {void}

开启所在数据模型事务

Returns:

void

Inherited From:

ht.Data#beginTransaction

ca(name) → {any}

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

Parameters:

Name	Type	Description
`name`	string

Returns:

any

Inherited From:

ht.Data#ca

clearChildren() → {void}

删除所有孩子节点，

Returns:

void

Inherited From:

ht.Data#clearChildren

clearChildrenFromDataModel() → {void}

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

Returns:

void

Inherited From:

ht.Data#clearChildrenFromDataModel

dm() → {ht.DataModel}

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

Returns:

ht.DataModel

Inherited From:

ht.Data#dm

eachChild(func, scope) → {void}

遍历所有子节点

Parameters:

Name	Type	Attributes	Description
`func`	Object		遍历函数 (data, index) => {}
`scope`	any	<optional>	作用域

Returns:

void

Inherited From:

ht.Data#eachChild

endTransaction() → {void}

结束所在数据模型事务

Returns:

void

Inherited From:

ht.Data#endTransaction

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

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

Parameters:

Name	Type	Description
`property`	string	属性
`oldValue`	any	旧值
`newValue`	any	新值

Returns:

void

Inherited From:

ht.Data#firePropertyChange

formatValue(value) → {Object}

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

Parameters:

Name	Type	Description
`value`	Object	格式化之前值

Returns:

Object -

格式化之后的值

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

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

Parameters:

Name	Type	Description
`property`	string	属性
`oldValue`	any	旧值
`newValue`	any	新值

Returns:

void

Inherited From:

ht.Data#fp

get3dUIClass() → {function}

获取3D组件上的UI类

Returns:

function -

UI类声明(构造函数)

Since:

7.7.1

Inherited From:

ht.Data#get3dUIClass

getAccessType() → {string}

获取属性类型，值列表如下：

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)的方式存取

Returns:

string

getAlign() → {string}

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

Returns:

string

getAnimation() → {object}

获取动画配置

Requires:

module:ht-animation.js

Returns:

object

Inherited From:

ht.Data#getAnimation

getAttr(name) → {any}

获取attr属性

Parameters:

Name	Type	Description
`name`	string	属性名

Returns:

any

Inherited From:

ht.Data#getAttr

getAttrObject() → {any}

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

Returns:

any

Inherited From:

ht.Data#getAttrObject

getCategoryName() → {string}

获取属性分类名称

Returns:

string

getChildAt(index) → {ht.Data}

返回指定索引位置的孩子

Parameters:

Name	Type	Description
`index`	number	索引

Returns:

ht.Data -

索引对应的孩子

Inherited From:

ht.Data#getChildAt

getChildren() → {ht.List}

获取所有孩子节点

Returns:

ht.List -

孩子元素集合

Inherited From:

ht.Data#getChildren

getClass() → {any}

获取类声明(构造函数)

Returns:

any -

类声明(构造函数)

Inherited From:

ht.Data#getClass

getClassName() → {string}

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

Returns:

string -

类全名

Inherited From:

ht.Data#getClassName

getColor() → {string}

获取属性名文字的颜色

Returns:

string

getColorPicker() → {Object}

获取颜色选择器配置

Returns:

Object

getCurrentPrefix() → {string}

返回当前运行态前缀内容

Returns:

string

Inherited From:

ht.Data#getCurrentPrefix

getDataBindings() → {Object}

获取数据绑定对象

Returns:

Object -

数据绑定对象

Inherited From:

ht.Data#getDataBindings

getDataModel() → {ht.DataModel}

获取所属的DataModel

Returns:

ht.DataModel -

DataModel数据模型

Inherited From:

ht.Data#getDataModel

getDisplayName() → {string}

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

Returns:

string -

显示名称

Inherited From:

ht.Data#getDisplayName

getEnumIcons() → {Array.<string>}

当属性使用下拉列表作为编辑器时，此方法返回下拉列表的所有枚举icon数组

Returns:

Array.<string>

getEnumLabels() → {Array.<string>}

当属性使用下拉列表作为编辑器时，此方法返回下拉列表的所有枚举文字数组

Returns:

Array.<string>

getEnumMaxHeight() → {number}

当属性使用下拉列表作为编辑器时，此方法返回下拉列表的最大高度(超出使用滚动条)

Returns:

number

getEnumValues() → {Array.<Object>}

当属性使用下拉列表作为编辑器时，此方法返回下拉列表的值数组

Returns:

Array.<Object>

getIcon() → {any}

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

Returns:

any -

图标名或矢量

Inherited From:

ht.Data#getIcon

getId() → {string|number}

获取唯一编号

Returns:

string | number -

唯一编号

Inherited From:

ht.Data#getId

getItemEditor() → {function}

获取自定义的单元格编辑器

Returns:

function

getLayer() → {string|number}

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

Returns:

string | number -

图层名

Inherited From:

ht.Data#getLayer

Default Value:

getName() → {string}

获取数据元素名

Returns:

string -

名称

Inherited From:

ht.Data#getName

getOwnStyle(name) → {any}

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

Parameters:

Name	Type	Description
`name`	string	样式

Returns:

any

Since:

7.7.0

Inherited From:

ht.Data#getOwnStyle

getParent() → {ht.Data}

获取父元素

Returns:

ht.Data -

父元素

Inherited From:

ht.Data#getParent

getRenderLayer() → {string|number}

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

Returns:

string | number

Inherited From:

ht.Data#getRenderLayer

getRenderLayerMask() → {string|number}

获取三维渲染层级掩码

Returns:

string | number

Since:

7.7.0

Inherited From:

ht.Data#getRenderLayerMask

getSerializableAttrs() → {any}

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

Returns:

any -

需要被序列化的attr属性map

Inherited From:

ht.Data#getSerializableAttrs

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:

ht.Data#getSerializableProperties

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:

ht.Data#getSerializableStyles

Example

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

getSlider() → {Object}

获取拉条配置

Returns:

Object

getStyle(name) → {any}

获取样式属性

Parameters:

Name	Type	Description
`name`	string	样式名

Returns:

any

Inherited From:

ht.Data#getStyle

getStyleMap() → {any}

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

Returns:

any -

样式映射表

Inherited From:

ht.Data#getStyleMap

getSuperClass() → {function}

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

Returns:

function -

父类声明(构造函数)

Inherited From:

ht.Data#getSuperClass

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:

ht.Data#getTag

getToolTip() → {string}

获取文字提示信息

Returns:

string -

文字提示

Inherited From:

ht.Data#getToolTip

getUIClass() → {function}

获取拓扑组件上的UI类

Returns:

function -

UI类声明(构造函数)

Inherited From:

ht.Data#getUIClass

getValueType() → {string}

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

Returns:

string

hasChildren() → {boolean}

判断是否有孩子

Returns:

boolean -

是否有孩子

Inherited From:

ht.Data#hasChildren

invalidate() → {void}

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

Returns:

void

Inherited From:

ht.Data#invalidate

isAdjustChildrenToTop() → {boolean}

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

Returns:

boolean -

是否将children自动sendToTop

Inherited From:

ht.Data#isAdjustChildrenToTop

isAnimationPlaying() → {boolean}

动画是否正在播放中

Returns:

boolean

Since:

7.7.0

Inherited From:

ht.Data#isAnimationPlaying

isBatchEditable() → {boolean}

判断是否允许多选时批量编辑，默认为true

Returns:

boolean

isDescendantOf(data) → {boolean}

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

Parameters:

Name	Type	Description
`data`	ht.Data	要对比的数据元素

Returns:

boolean -

自身是否为指定data的子孙

Inherited From:

ht.Data#isDescendantOf

isEditable() → {boolean}

判断属性是否可编辑

Returns:

boolean

isEmptiable() → {boolean}

判断属性是否可为空字符串，可避免输入空字符串，空字符串转换成undefined。默认为false

Returns:

boolean

isEmpty() → {boolean}

判断是否有孩子，同hasChildren

Returns:

boolean -

是否有孩子

Inherited From:

ht.Data#isEmpty

isEnumEditable() → {boolean}

枚举下拉编辑器是否允许可输入，默认为false

Returns:

boolean

isEnumStrict() → {boolean}

判断值匹配时是否采用严格的===进行比较，默认为true，若为false则采用==进行比较

Returns:

boolean

isNullable() → {boolean}

判断属性是否可为空，默认为true，设置为false可避免输入null或undefined

Returns:

boolean

isParentOf(data) → {boolean}

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

Parameters:

Name	Type	Description
`data`	ht.Data	要对比的数据元素

Returns:

boolean -

自身是否为指定data的父亲

Inherited From:

ht.Data#isParentOf

isRelatedTo(data) → {boolean}

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

Parameters:

Name	Type	Description
`data`	ht.Data	要对比的数据元素

Returns:

boolean -

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

Inherited From:

ht.Data#isRelatedTo

iv() → {void}

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

Returns:

void

Inherited From:

ht.Data#iv

onChildAdded(child, index) → {void}

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

Parameters:

Name	Type	Description
`child`	ht.Data	新增加的孩子元素
`index`	number	索引

Returns:

void

Inherited From:

ht.Data#onChildAdded

onChildRemoved(child, index) → {void}

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

Parameters:

Name	Type	Description
`child`	ht.Data	被删除的孩子元素
`index`	number	索引

Returns:

void

Inherited From:

ht.Data#onChildRemoved

onParentChanged(oldParent, parent) → {void}

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

Parameters:

Name	Type	Description
`oldParent`	ht.Data	旧的父元素
`parent`	ht.Data	新的父元素

Returns:

void

Inherited From:

ht.Data#onParentChanged

onPropertyChanged(event) → {void}

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

Parameters:

Name	Type	Description
`event`	any	属性变化事件

Returns:

void

Inherited From:

ht.Data#onPropertyChanged

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:

ht.Data#onStyleChanged

pauseAnimation() → {void}

暂停动画

Requires:

module:ht-animation.js

Returns:

void

Inherited From:

ht.Data#pauseAnimation

removeChild(child) → {void}

删除指定孩子元素，内部会自动调用孩子元素的setParent

Parameters:

Name	Type	Description
`child`	ht.Data	要删除的孩子元素

Returns:

void

Inherited From:

ht.Data#removeChild

removeFromDataModel() → {void}

从数据模型中移出

Returns:

void

Inherited From:

ht.Data#removeFromDataModel

removeStyleIcon(name) → {void}

删除icon

Parameters:

Name	Type	Description
`name`	string	要删除的icon名

Returns:

void

Inherited From:

ht.Data#removeStyleIcon

resumeAnimation() → {void}

继续播放动画

Requires:

module:ht-animation.js

Returns:

void

Inherited From:

ht.Data#resumeAnimation

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

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

Parameters:

Name	Type	Description
`name`	string	样式名
`value`	any	样式值

Returns:

ht.Data

Inherited From:

ht.Data#s

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	Attributes	Description
`accessType`	string	<optional>

Returns:

void

setAdjustChildrenToTop(adjustToTop) → {void}

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

Parameters:

Name	Type	Description
`adjustToTop`	boolean	是否将children自动sendToTop

Returns:

void

Inherited From:

ht.Data#setAdjustChildrenToTop

setAlign(align) → {void}

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

Parameters:

Name	Type	Description
`align`	string	对齐方式

Returns:

void

setAnimation(config) → {void}

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

Parameters:

Name	Type	Description
`config`	object	动画配置

Requires:

module:ht-animation.js

Returns:

void

Inherited From:

ht.Data#setAnimation

setAttr(name, value) → {void}

设置attr属性

Parameters:

Name	Type	Description
`name`	string	属性名
`value`	any	属性值

Returns:

void

Inherited From:

ht.Data#setAttr

setAttrObject(attrObject) → {void}

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

Parameters:

Name	Type	Description
`attrObject`	any	attr属性对象

Returns:

void

Inherited From:

ht.Data#setAttrObject

setBatchEditable(v) → {void}

设置是否允许多选时批量编辑，默认为true

Parameters:

Name	Type	Description
`v`	boolean

Returns:

void

setCategoryName(name) → {void}

设置属性分类名称

Parameters:

Name	Type	Description
`name`	string

Returns:

void

setColor(color) → {void}

设置属性名文字的颜色

Parameters:

Name	Type	Description
`color`	string

Returns:

void

setColorPicker(v) → {void}

设置颜色选择器配置，需要引入form插件，设置后将使用颜色选择器作为属性编辑器

Parameters:

Name	Type	Description
`v`	Object	颜色选择器配置，如{background: 'red'}可以指定颜色选择器背景为红色，如果要使用默认配置，使用空对象{}即可

Returns:

void

setDataBindings(dataBindings) → {void}

设置数据绑定

Parameters:

Name	Type	Description
`dataBindings`	Object	数据绑定对象

Returns:

void

Inherited From:

ht.Data#setDataBindings

setDisplayName(displayName) → {void}

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

Parameters:

Name	Type	Description
`displayName`	string	显示名称

Returns:

void

Inherited From:

ht.Data#setDisplayName

setEditable(editable) → {void}

设置属性是否可编辑

Parameters:

Name	Type	Description
`editable`	boolean

Returns:

void

setEmptiable(emptiable) → {void}

设置属性是否可为空字符串，可避免输入空字符串，空字符串转换成undefined。默认为false

Parameters:

Name	Type	Description
`emptiable`	boolean

Returns:

void

setEnum(v) → {void}

设置枚举列表，自动采用下拉列表作为属性编辑器

Parameters:

Name	Type	Description
`v`	Object \| Array.<any>

Returns:

void

Example

//示例，参数依次表示：值，文字、icon
property.setEnum([1,2,3], ['C','C++','JS'], ['c_icon', 'c++_icon', 'js_icon']);
//也可以使用对象的方式：
property.setEnum({values:[1,2,3], labels:['C','C++','JS'], icons:['c_icon', 'c++_icon', 'js_icon']});

setIcon(icon) → {void}

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

Parameters:

Name	Type	Description
`icon`	any	图标名或矢量

Returns:

void

Inherited From:

ht.Data#setIcon

setId(id) → {void}

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

Parameters:

Name	Type	Description
`id`	string \| number	唯一编号

Returns:

void

Inherited From:

ht.Data#setId

setItemEditor(editor) → {void}

设置自定义的属性编辑器

Parameters:

Name	Type	Description
`editor`	function

Returns:

void

setLayer(layer) → {void}

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

Parameters:

Name	Type	Attributes	Description
`layer`	string \| number	<optional>	图层名

Returns:

void

Inherited From:

ht.Data#setLayer

setName(name) → {void}

设置数据元素名称

Parameters:

Name	Type	Description
`name`	string	数据元素名称

Returns:

void

Inherited From:

ht.Data#setName

setNullable(nullable) → {void}

设置属性是否可为空，默认为true，设置为false可避免输入null或undefined

Parameters:

Name	Type	Description
`nullable`	boolean

Returns:

void

setParent(parent) → {void}

设置父元素

Parameters:

Name	Type	Description
`parent`	ht.Data	父元素

Returns:

void

Inherited From:

ht.Data#setParent

setRenderLayer(layerName) → {void}

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

Parameters:

Name	Type	Description
`layerName`	string \| number

Returns:

void

Inherited From:

ht.Data#setRenderLayer

setSlider(v) → {void}

设置拉条配置，需要引入form插件，设置后将使用拉条作为属性编辑器

Parameters:

Name	Type	Description
`v`	Object	拉条配置，如{background: 'red'}可以指定拉条背景为红色，如果要使用默认配置，使用空对象{}即可

Returns:

void

setStyle(name, value) → {void}

设置样式

Parameters:

Name	Type	Description
`name`	string	样式名
`value`	any	样式值

Returns:

void

Inherited From:

ht.Data#setStyle

setStyleMap(styleMap) → {void}

设置节点样式对象

Parameters:

Name	Type	Description
`styleMap`	any

Returns:

void

Inherited From:

ht.Data#setStyleMap

setTag(tag) → {void}

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

Parameters:

Name	Type	Description
`tag`	string	标示号

Returns:

void

Inherited From:

ht.Data#setTag

setToolTip(toolTip) → {void}

设置文字提示信息

Parameters:

Name	Type	Description
`toolTip`	string	文字提示

Returns:

void

Inherited From:

ht.Data#setToolTip

setValueType(type) → {void}

设置值类型，值类型用于提示组件提供合适的renderer渲染，合适的编辑控件，及改变值时必要的类型转换

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

Parameters:

Name	Type	Description
`type`	string

Returns:

void

size() → {number}

获取孩子元素总数

Returns:

number -

孩子元素总数

Inherited From:

ht.Data#size

testRenderLayer(layerName) → {boolean}

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

Parameters:

Name	Type	Description
`layerName`	string	渲染层级

Returns:

boolean

Since:

7.7.0

Inherited From:

ht.Data#testRenderLayer

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

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

Parameters:

Name	Type	Attributes	Description
`matchFunc`	function	<optional>	过滤函数
`scope`	any	<optional>	函数域

Returns:

ht.List -

孩子元素集合

Inherited From:

ht.Data#toChildren

Example

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

toEnumIcon(value, data) → {Object}

根据value查找对应的枚举icon

Parameters:

Name	Type	Description
`value`	string	枚举值
`data`	ht.Data

Returns:

Object

toEnumLabel(value, data) → {string}

根据value查找对应的枚举label文字

Parameters:

Name	Type	Description
`value`	string	枚举值
`data`	ht.Data

Returns:

string

toLabel() → {string}

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

Returns:

string -

文字标签

Inherited From:

ht.Data#toLabel

toString() → {string}

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

Returns:

string -

数据名称/标签/ID

Inherited From:

ht.Data#toString