API Docs for: TWaver HTML5 5.7.5
Show:

twaver.controls.TreeTable Class

Extends twaver.controls.TableBase

树表视图

TreeTable是结合了Tree和Table特性的一种视图组件，它既有树的展开、合并功能，也有表格那种能呈现多列数据的功能。

TreeTable是和数据容器一起工作的，它以图形的方式显示数据容器中的数据

Constructor

twaver.controls.TreeTable

(
  • dataBox
)
twaver.controls.TreeTable

Parameters:

Returns:

twaver.controls.TreeTable:

Item Index

Methods

Methods

twaver.controls.ControlBase.addPool

(
  • pool
)

Inherited from twaver.controls.ControlBase:

添加HTML元素缓存池

Parameters:

twaver.controls.ControlBase.adjustBounds

(
  • rect
)

Inherited from twaver.controls.ControlBase:

设置组件新的位置以及大小，twaver布局管理器（twaver.controls.SplitPane等）在大小变化时会调用此方法

Parameters:

  • rect Object

    新的位置以及大小，值为包含x、y、width和height属性的Object对象

twaver.controls.ControlBase.getView

() HTMLDivElement

Inherited from twaver.controls.ControlBase:

获取组件的HTML元素

Returns:

HTMLDivElement:

返回组件的HTML元素

twaver.controls.ControlBase.invalidate

(
  • [delay]
)

Inherited from twaver.controls.ControlBase:

无效组件，在等待指定毫秒数后，刷新组件（调用validate方法）,当组件属性更改后，须调用此方法，让组件重画

Parameters:

  • [delay] Number optional

    延迟刷新等待的毫秒数，可选，默认为twaver.Defaults.CALL_LATER_DELAY

twaver.controls.ControlBase.isAutoAdjustBounds

() Boolean

Inherited from twaver.controls.ControlBase:

获取视图是否自动计算Bounds（边界）

Returns:

Boolean:

是否自动调整Bounds

twaver.controls.ControlBase.removePool

(
  • pool
)

Inherited from twaver.controls.ControlBase:

删除HTML元素缓存池

Parameters:

twaver.controls.ControlBase.setAutoAdjustBounds

(
  • autoAdjustBounds
)

Inherited from twaver.controls.ControlBase:

设置视图是否自动计算Bounds

Parameters:

  • autoAdjustBounds Boolean

    是否自动计算Bounds

twaver.controls.ControlBase.validate

()

Inherited from twaver.controls.ControlBase:

重画组件，调用invalidate后，此方法会被调用

twaver.controls.ControlBase.validateImpl

()

Inherited from twaver.controls.ControlBase:

调用validate方法后，此方法会被调用，子类须重载此方法以重画组件

twaver.controls.ListBase.adjustRowSize

()

Inherited from twaver.controls.ListBase:

调整行的大小

twaver.controls.ListBase.calculateSumWidth

() String

Inherited from twaver.controls.ListBase:

计算总宽度

Returns:

String:

总宽度

twaver.controls.ListBase.getCurrentSortFunction

() Function

Inherited from twaver.controls.ListBase:

获取当前排序的函数

Returns:

Function:

排序的函数

twaver.controls.ListBase.getDataAt

(
  • e
)
twaver.Data

Inherited from twaver.controls.ListBase:

获取鼠标点击的数据

Parameters:

  • e MouseEvent

    鼠标事件

Returns:

twaver.Data:

鼠标事件下的数据

twaver.controls.ListBase.getDataBox

() twaver.DataBox

Inherited from twaver.controls.ListBase:

获取绑定的数据容器

Returns:

twaver.DataBox:

绑定的数据容器

twaver.controls.ListBase.getDataDiv

() HTMLDivElement

Inherited from twaver.controls.ListBase:

获得所有数据的div

Returns:

HTMLDivElement:

数据div对象

twaver.controls.ListBase.getEndRowIndex

() Number

Inherited from twaver.controls.ListBase:

获取可见区域结束的行号

Returns:

Number:

结束的行号

twaver.controls.ListBase.getRowDatas

() twaver.List

Inherited from twaver.controls.ListBase:

获取所有的行数据

Returns:

twaver.List:

所有行的数据

twaver.controls.ListBase.getRowIndexAt

(
  • e
)
Number

Inherited from twaver.controls.ListBase:

获取鼠标下数据的行号

Parameters:

  • e MouseEvent

    鼠标事件

Returns:

Number:

数据的行号

twaver.controls.ListBase.getRowIndexByData

(
  • data
)
Number

Inherited from twaver.controls.ListBase:

获取指定数据的行号

Parameters:

Returns:

Number:

行号

twaver.controls.ListBase.getRowIndexById

(
  • id
)
Number

Inherited from twaver.controls.ListBase:

通过指定数据的ID编号获取数据所在行的行号

Parameters:

  • id Object

    指定数据的ID编号

Returns:

Number:

行的Index值

twaver.controls.ListBase.getRowSize

() Number

Inherited from twaver.controls.ListBase:

获取列表上行的数量

Returns:

Number:

行的数量

twaver.controls.ListBase.getStartRowIndex

() Number

Inherited from twaver.controls.ListBase:

获取可见区域开始的行号，当列表的滚动条滚动时，开始的行号是随之变化的

Returns:

Number:

开始的行号

twaver.controls.ListBase.handleChange

(
  • e
)

Inherited from twaver.controls.ListBase:

当视图组件发生更改时，twaver会调用此方法。用户不需要直接调用此方法，但是可以重载此方法来实现自己的逻辑

Parameters:

  • e Object

    视图更改事件

twaver.controls.ListBase.handleDataBoxChange

(
  • e
)

Inherited from twaver.controls.ListBase:

当DataBox中的数据发生变化时调用此方法，用于更新视图的显示内容。用户不需要调用此方法，但可以重写此方式实现自己的逻辑

Parameters:

  • e Object

    数据发生变化的事件

twaver.controls.ListBase.handleHierarchyChange

(
  • e
)

Inherited from twaver.controls.ListBase:

当DataBox中的数据的层次发生变化时调用此方法，用于更新视图的显示内容。用户不需要调用此方法，但可以重写此方式实现自己的逻辑

Parameters:

  • e Object

    数据的层次发生变化的事件

twaver.controls.ListBase.handlePropertyChange

(
  • e
)

Inherited from twaver.controls.ListBase:

当DataBox中的数据的属性发生变化时调用此方法，用于更新视图的显示内容。用户不需要调用此方法，但可以重写此方式实现自己的逻辑

Parameters:

  • e Object

    数据的属性发生变化的事件

twaver.controls.ListBase.handleSelectionChange

(
  • e
)

Inherited from twaver.controls.ListBase:

当DataBox中的选择的数据发生变化时调用此方法，用于更新视图的显示内容。用户不需要调用此方法，但可以重写此方式实现自己的逻辑

Parameters:

  • e Object

    DataBox中的选择的数据发生变化的事件

twaver.controls.ListBase.invalidateData

(
  • data
)

Inherited from twaver.controls.ListBase:

无效视图中的指定的数据，在等待数毫秒后刷新视图，当视图数据容器中指定的数据发生变化时，须调用此方法，让组件重画

Parameters:

twaver.controls.ListBase.invalidateDisplay

()

Inherited from twaver.controls.ListBase:

无效视图的组件，在等待数毫秒后刷新视图组件，当视图发生变化时，须调用此方法，让组件重画

twaver.controls.ListBase.invalidateModel

()

Inherited from twaver.controls.ListBase:

无效视图的模型，当视图模型中的数据发生变化时，调用此方法，在等待数毫秒数后刷新视图组件

twaver.controls.ListBase.isInnerText

() Boolean

Inherited from twaver.controls.ListBase:

获取列表列内容是否为纯文本

Returns:

Boolean:

返回列表列内容是否为纯文本

twaver.controls.ListBase.isVisible

(
  • data
)
Boolean

Inherited from twaver.controls.ListBase:

判断指定的数据在视图上是否可见

Parameters:

Returns:

Boolean:

true为可见，否则为false

twaver.controls.ListBase.makeVisible

(
  • data
)

Inherited from twaver.controls.ListBase:

让指定的数据处于可见区域

Parameters:

twaver.controls.ListBase.onDataRendered

(
  • div
  • data
  • row
  • selected
)

Inherited from twaver.controls.ListBase:

当调用renderData时，会调用此方法。用户不需要直接调用此方法，但是可以重写此方法实现自己的逻辑

Parameters:

  • div HTMLDivElement

    包含数据的div

  • data twaver.Data

    指定的数据

  • row Number

    数据所在的行

  • selected Boolean

    是否为选中状态

twaver.controls.ListBase.onSelectionChanged

(
  • e
)

Inherited from twaver.controls.ListBase:

当数据容器中选择的数据发生变化时，会调用此方法。用户不需要直接调用此方法，但可以重写此方法实现自己的逻辑

Parameters:

  • e Object

    DataBox中选择的数据发生变化的事件

twaver.controls.ListBase.onShareSelectionModelChanged

()

Inherited from twaver.controls.ListBase:

当共享选择模型发生更改时调用此方法

twaver.controls.ListBase.onValidated

()

Inherited from twaver.controls.ListBase:

当调用validate后，twaver会调用此方法，用户不需自己调用此方法，但可以重载此方法，实现自己的逻辑

twaver.controls.ListBase.scrollToData

(
  • data
)

Inherited from twaver.controls.ListBase:

让滚动条滚动到指定的数据，让指定的数据可见

Parameters:

twaver.controls.ListBase.setDataBox

(
  • dataBox
)

Inherited from twaver.controls.ListBase:

设置绑定的数据容器

Parameters:

twaver.controls.ListBase.setInnerText

(
  • v
)

Inherited from twaver.controls.ListBase:

设置列表列内容是否为纯文本

Parameters:

  • v Boolean

    列表列内容是否为纯文本

twaver.controls.ListBase.validateModel

()

Inherited from twaver.controls.ListBase:

重画组件，调用validate方法后，此方法会被调用

twaver.controls.TableBase.cancelEditing

()

Inherited from twaver.controls.TableBase:

取消当前编辑器的编辑状态

twaver.controls.TableBase.commitEditValue

(
  • editInfo
  • target
)

Inherited from twaver.controls.TableBase:

提交单元格中编辑的值，将这个值回写到Data的属性中

Parameters:

  • editInfo Object

    指定的单元格编辑器的信息，它是一个包含column和data的对象

  • target Object

    编辑器所对应的对象类型，它是一个包含type的对象类型，用于判断编辑器的类型

twaver.controls.TableBase.getColumnAt

(
  • e
)
twaver.Column

Inherited from twaver.controls.TableBase:

获取鼠标位置所在的列

Parameters:

  • e MouseEvent

    鼠标事件

Returns:

twaver.Column:

返回鼠标位置所在的列

twaver.controls.TableBase.getColumnBox

() twaver.ColumnBox

Inherited from twaver.controls.TableBase:

获取表格上列的数据容器

Returns:

twaver.ColumnBox:

列数据容器

twaver.controls.TableBase.getCurrentEditor

() HTMLElement

Inherited from twaver.controls.TableBase:

获取当前编辑器

Returns:

HTMLElement:

返回当前编辑器

twaver.controls.TableBase.getValue

(
  • data
  • column
)
Object

Inherited from twaver.controls.TableBase:

从Data中获取对应的表格列的值，TWaver内部使用

Parameters:

Returns:

Object:

返回表格列的值

twaver.controls.TableBase.handleColumnBoxChange

(
  • e
)

Inherited from twaver.controls.TableBase:

当列的容器中列发生变化时调用此方法，用于更新表格的显示内容。用户不需要调用此方法，但可以重写此方法实现自己的逻辑

Parameters:

  • e Object

    列容器发生变化的事件

twaver.controls.TableBase.handleColumnHierarchyChange

(
  • e
)

Inherited from twaver.controls.TableBase:

当列的容器中列的顺序关系发生变化时调用此方法，用于更新表格的显示内容。用户不需要调用此方法，但可以重写此方法实现自己的逻辑

Parameters:

  • e Object

    列容器中列的顺序发生变化的事件

twaver.controls.TableBase.handleColumnPropertyChange

(
  • e
)

Inherited from twaver.controls.TableBase:

当列的容器中列的属性发生变化时调用此方法，用于更新表格的显示内容。用户不需要调用此方法，但可以重写此方法实现自己的逻辑

Parameters:

  • e Object

    ColumnBox中列的属性变化事件

twaver.controls.TableBase.isCellEditable

(
  • [data]
  • column
)
Boolean

Inherited from twaver.controls.TableBase:

判断指定的表格列的单元格是否可编辑

Parameters:

Returns:

Boolean:

true为可编辑，否则为false

twaver.controls.TableBase.onCellRendered

(
  • params
)

Inherited from twaver.controls.TableBase:

当绘制表格单元格时调用此方法，用户不需要自己调用此方法，但可以重载这个方法实现自己的逻辑处理

Parameters:

  • params Object

    params是一个包含多个数据的对象，params的格式为： params = {data: data, value: this.getValue(data, column), div: cell, view: this, column: column, rowIndex: row, selected: selected}

twaver.controls.TableBase.onColumnSorted

(
  • column
)

Inherited from twaver.controls.TableBase:

排序列时的回调函数

Parameters:

twaver.controls.TableBase.onEditorRendered

(
  • params
)

Inherited from twaver.controls.TableBase:

编辑器渲染结束之后调用此方法

Parameters:

  • params String

twaver.controls.TableBase.renderCell

(
  • params
)

Inherited from twaver.controls.TableBase:

渲染表格的单元格

Parameters:

  • params Object

    params是一个包含多个数据的对象，params的格式为： params = {data: data, value: this.getValue(data, column), div: cell, view: this, column: column, rowIndex: row, selected: selected}

twaver.controls.TableBase.renderData

(
  • div
  • data
  • row
  • selected
)

Inherited from twaver.controls.TableBase:

绘制表格中的数据，用户可以重写此方法实现自己的逻辑

Parameters:

  • div HTMLDivElement

    包含指定表格上行数据的DIV

  • data twaver.Data

    指定的数据对象

  • row Number

    表格指定的行

  • selected Boolean

    表格数据是否是选中状态

twaver.controls.TableBase.renderEditor

(
  • params
)

Inherited from twaver.controls.TableBase:

用于过滤渲染编辑器

Parameters:

  • params String

twaver.controls.TableBase.setValue

(
  • data
  • column
  • value
)

Inherited from twaver.controls.TableBase:

设置表格上的值回写到data中，TWaver内部使用

Parameters:

  • data twaver.Data

    表格或树表格绑定的数据对象

  • column twaver.Column

    表格列对象

  • value Object

    表格列的值

twaver.controls.TableBase.updateCurrentEditor

(
  • e
)

Inherited from twaver.controls.TableBase:

当鼠标点击到某个单元格上时，更新当前单元格的编辑器

Parameters:

  • e MouseEvent

    鼠标的点击事件

twaver.controls.TreeTable.collapse

(
  • data
)

合并指定的节点

Parameters:

twaver.controls.TreeTable.collapseAll

()

合并所有的树节点对象，调用这个方法后，所有的孩子都会处于合并状态

twaver.controls.TreeTable.expand

(
  • data
)

展开指定的树节点对象

Parameters:

twaver.controls.TreeTable.expandAll

()

展开所有的树节点对象，调用这个方法后，所有的孩子都会处于打开状态

twaver.controls.TreeTable.getCheckMode

() String

获取TreeTable的勾选方式。勾选方式的可选值有： 'default'：默认 'children':勾选父亲时，会将孩子也勾选上 'descendant':勾选父亲时，将孩子以及所有的子孙节点都勾选上 'descendantAncestor':勾选节点时，会将其下的所有孩子以及子孙节点都勾选上，并且将这个节点的所有祖先节点也勾选上

Returns:

String:

TreeTable的勾选模式

twaver.controls.TreeTable.getCollapseIcon

() String

获取TreeTable节点合并的图标，默认为twaver.Defaults.TREETABLE_COLLAPSE_ICON

Returns:

String:

TreeTable节点合并的图标

twaver.controls.TreeTable.getColumnLineColor

() String

获取TreeTable中每列的线的颜色，默认为 twaver.Defaults.TREETABLE_COLUMN_LINE_COLOR

Returns:

String:

每列线的颜色

twaver.controls.TreeTable.getColumnLineWidth

() Number

获取TreeTable上每列线的宽度，默认为twaver.Defaults.TREETABLE_COLUMN_LINE_WIDTH

Returns:

Number:

列的线宽

twaver.controls.TreeTable.getExpandIcon

() String

获取TreeTable展开的图标，默认为twaver.Defaults.TREETABLE_EXPAND_ICON

Returns:

String:

TreeTable展开的图标

twaver.controls.TreeTable.getIndent

() Number

获取TreeTable上父亲和孩子之间的缩进，默认为twaver.Defaults.TREETABLE_INDENT

Returns:

Number:

树节点的缩进

twaver.controls.TreeTable.getLevel

(
  • data
)
Number

获取指定的节点数据所在的层次

Parameters:

Returns:

Number:

节点的层次数

twaver.controls.TreeTable.getLineAlpha

() Number

获取线的透明度

Returns:

Number:

透明度

twaver.controls.TreeTable.getLineColor

() String

获取线的颜色

Returns:

String:

颜色

twaver.controls.TreeTable.getLineDash

() String

获取线的虚线样式

Returns:

String:

虚线

twaver.controls.TreeTable.getLineThickness

() String

获取线的厚度

Returns:

String:

厚度

twaver.controls.TreeTable.getLineType

() String

获取线的类型

Returns:

String:

类型

twaver.controls.TreeTable.getRootData

() twaver.Data

获取根节点数据

Returns:

twaver.Data:

TreeTable的根节点

twaver.controls.TreeTable.getRowHeight

() Number

获取TreeTable的行高，默认为twaver.Defaults.TREETABLE_ROW_HEIGHT

Returns:

Number:

TreeTable的行高

twaver.controls.TreeTable.getRowLineColor

() String

获取TreeTable上行之间线的颜色，默认为twaver.Defaults.TREETABLE_ROW_LINE_COLOR

Returns:

String:

TreeTable上行之间线的颜色

twaver.controls.TreeTable.getRowLineWidth

() Number

获取TreeTable上行之间线的宽度，默认为twaver.Defaults.TREETABLE_COLUMN_LINE_WIDTH

Returns:

Number:

TreeTable上行之间线的宽度

twaver.controls.TreeTable.getSortColumn

() twaver.Column

获取TreeTable上排序的列

Returns:

twaver.Column:

排序的列

twaver.controls.TreeTable.getSortFunction

() Function

获取TreeTable上排序的函数

Returns:

Function:

排序的函数

twaver.controls.TreeTable.getToggleImage

(
  • data
)
String

获取指定数据当前显示的图标，如果指定的数据是处于合并状态，就返回合并时的图标；如果是展开状态，返回的是展开的图标

Parameters:

Returns:

String:

TreeTable上指定的节点当前显示的图标

twaver.controls.TreeTable.getTreeColumn

() twaver.Column

获取TreeTable上树的那一列

Returns:

twaver.Column:

包含树的那一列

twaver.controls.TreeTable.getTreeValue

(
  • data
  • table
)
String

获取指定的数据在TreeTable上显示的标签值

Parameters:

Returns:

String:

标签值

twaver.controls.TreeTable.getUncheckableStyle

() String

获取TreeTable的树节点不可勾选时的样式，默认为'none'。可选值有： 'none'：没有任何样式 'disabled':不可用

Returns:

String:

树节点不可勾选时的样式

twaver.controls.TreeTable.getVisibleFunction

() Function

获取TreeTable上是否可见的过滤器，用于过滤哪些网元可见，哪些不可见

Returns:

Function:

是否可见的过滤器

twaver.controls.TreeTable.isCheckable

(
  • data
)
Boolean

获取指定的数据是否可勾选

Parameters:

Returns:

Boolean:

是否可勾选，true为可勾选，否则为false

twaver.controls.TreeTable.isCheckMode

() Boolean

是否为勾选模型

Returns:

Boolean:

true为勾选模型，否则为false

twaver.controls.TreeTable.isChildrenSortable

(
  • parent
)
Boolean

判断指定的节点数据下的孩子是否可以排序。默认实现为可排序，用户可以重写此方法实现自己的逻辑

Parameters:

Returns:

Boolean:

true为可排序，否则为false

twaver.controls.TreeTable.isEditable

() Boolean

判断树表是否可编辑，默认为twaver.Defaults.TREETABLE_EDITABLE

Returns:

Boolean:

true为可编辑，否则为false

twaver.controls.TreeTable.isExpanded

(
  • data
)
Boolean

判断指定的TreeTable上的节点是否处于展开状态

Parameters:

Returns:

Boolean:

true为展开状态，否则为false

twaver.controls.TreeTable.isKeyboardRemoveEnabled

() Boolean

判断TreeTable上是否支持键盘删除数据的操作，默认为 twaver.Defaults.TREETABLE_KEYBOARD_REMOVE_ENABLED

Returns:

Boolean:

true为支持键盘删除，否则为false

twaver.controls.TreeTable.isKeyboardSelectEnabled

() Boolean

判断TreeTable上是否支持键盘选择节点的操作，默认为twaver.Defaults.TREE_KEYBOARD_SELECT_ENABLED

Returns:

Boolean:

true为可以键盘选择节点，否则为false

twaver.controls.TreeTable.isMakeVisibleOnSelected

() Boolean

判断当选中TreeTable中某个节点时，是否让其处于可见区域，默认为twaver.Defaults.TREETABLE_MAKE_VISIBLE_ON_SELECTED

Returns:

Boolean:

true为处于可见区域，否则为false

twaver.controls.TreeTable.isRootVisible

() Boolean

判断TreeTable的根节点是否可见

Returns:

Boolean:

true为可见，否则为false

twaver.controls.TreeTable.onLabelRendered

(
  • span
  • data
  • label
  • row
  • level
  • selected
)

当渲染TreeTable上的标签时，调用此方法。用户不需要自己调用此方法，但可以重载此方法，添加自定义的逻辑

Parameters:

  • span HTMLSpanElement

    包含数据元标签的Span

  • data twaver.Data

    指定的数据

  • label String

    显示的标签值

  • row Number

    指定的行号

  • level Number

    指定数据的层次数

  • selected Boolean

    是否为选中状态

twaver.controls.TreeTable.onToggleImageRendered

(
  • image
)

Parameters:

  • image String

twaver.controls.TreeTable.renderTreeCell

(
  • params
)

渲染树这一列的单元格显示样式

Parameters:

  • params Object

    参数的格式为 {div：div, data:data, rowIndex:index, selected:selected}的对象

twaver.controls.TreeTable.setCheckMode

(
  • v
)

设置TreeTable的勾选方式。勾选方式的可选值有： 'default'：默认 'children':勾选父亲时，会将孩子也勾选上 'descendant':勾选父亲时，将孩子以及所有的子孙节点都勾选上 'descendantAncestor':勾选节点时，会将其下的所有孩子以及子孙节点都勾选上，并且将这个节点的所有祖先节点也勾选上

Parameters:

  • v String

    TreeTable的勾选模式

twaver.controls.TreeTable.setCollapseIcon

(
  • v
)

设置TreeTable节点合并的图标，默认为twaver.Defaults.TREETABLE_COLLAPSE_ICON

Parameters:

  • v String

    TreeTable节点合并的图标

twaver.controls.TreeTable.setColumnLineColor

(
  • v
)

设置TreeTable中每列的线的颜色，默认为 twaver.Defaults.TREETABLE_COLUMN_LINE_COLOR

Parameters:

  • v String

    每列线的颜色

twaver.controls.TreeTable.setColumnLineWidth

(
  • v
)

获取TreeTable上每列线的宽度，默认为twaver.Defaults.TREETABLE_COLUMN_LINE_WIDTH

Parameters:

  • v Number

    列的线宽

twaver.controls.TreeTable.setEditable

(
  • v
)

设置树表是否可编辑，默认为twaver.Defaults.TREETABLE_EDITABLE

Parameters:

  • v Boolean

    true为可编辑，否则为false

twaver.controls.TreeTable.setExpandIcon

(
  • v
)

设置TreeTable展开的图标，默认为twaver.Defaults.TREETABLE_EXPAND_ICON

Parameters:

  • v String

    TreeTable展开的图标

twaver.controls.TreeTable.setIndent

(
  • v
)

设置TreeTable上父亲和孩子之间的缩进，默认为twaver.Defaults.TREETABLE_INDENT

Parameters:

  • v Number

    树节点的缩进

twaver.controls.TreeTable.setKeyboardRemoveEnabled

(
  • v
)

设置TreeTable上是否支持键盘删除数据的操作，默认为 twaver.Defaults.TREETABLE_KEYBOARD_REMOVE_ENABLED

Parameters:

  • v Boolean

    true为支持键盘删除，否则为false

twaver.controls.TreeTable.setKeyboardSelectEnabled

(
  • v
)

设置TreeTable上是否支持键盘选择节点的操作，默认为twaver.Defaults.TREE_KEYBOARD_SELECT_ENABLED

Parameters:

  • v Boolean

    true为可以键盘选择节点，否则为false

twaver.controls.TreeTable.setLineAlpha

(
  • v
)

设置线的透明度

Parameters:

  • v Number

    透明度

twaver.controls.TreeTable.setLineColor

(
  • v
)

设置线的颜色

Parameters:

  • v String

    颜色

twaver.controls.TreeTable.setLineDash

(
  • v
)

设置线的虚线样式

Parameters:

  • v String

    虚线样式

twaver.controls.TreeTable.setLineThickness

(
  • v
)

设置线的厚度

Parameters:

  • v String

    厚度

twaver.controls.TreeTable.setLineType

(
  • v
)

设置线的样式

Parameters:

  • v String

    样式

twaver.controls.TreeTable.setMakeVisibleOnSelected

(
  • v
)

设置当选中TreeTable中某个节点时，是否让其处于可见区域，默认为twaver.Defaults.TREETABLE_MAKE_VISIBLE_ON_SELECTED

Parameters:

  • v Boolean

    true为处于可见区域，否则为false

twaver.controls.TreeTable.setRootData

(
  • v
)

设置根节点数据

Parameters:

twaver.controls.TreeTable.setRootVisible

(
  • v
)

设置TreeTable的根节点是否可见

Parameters:

  • v Boolean

    true为可见，否则为false

twaver.controls.TreeTable.setRowHeight

(
  • v
)

设置TreeTable的行高，默认为twaver.Defaults.TREETABLE_ROW_HEIGHT

Parameters:

  • v Number

    TreeTable的行高

twaver.controls.TreeTable.setRowLineColor

(
  • v
)

设置TreeTable上行之间线的颜色，默认为twaver.Defaults.TREETABLE_ROW_LINE_COLOR

Parameters:

  • v String

    TreeTable上行之间线的颜色

twaver.controls.TreeTable.setRowLineWidth

(
  • v
)

设置TreeTable上行之间线的宽度，默认为twaver.Defaults.TREETABLE_COLUMN_LINE_WIDTH

Parameters:

  • v Number

    TreeTable上行之间线的宽度

twaver.controls.TreeTable.setSortColumn

(
  • v
)

设置TreeTable上排序的列

Parameters:

twaver.controls.TreeTable.setSortFunction

(
  • v
)

设置TreeTable排序的函数

Parameters:

  • v Function

    排序的函数

Example:

treetable.setSortFunction(function (d1, d2) { if (d1.getName() < d2.getName()) { return 1; } else if (d1.getName() == d2.getName()) { return 0; } else { return -1; } });

twaver.controls.TreeTable.setTreeValue

(
  • data
  • value
  • table
)

设置指定的数据在TreeTable上显示的标签值

Parameters:

twaver.controls.TreeTable.setUncheckableStyle

(
  • v
)

设置TreeTable的树节点不可勾选时的样式，默认为'none'。可选值有： 'none'：没有任何样式 'disabled':不可用

Parameters:

  • v String

    树节点不可勾选时的样式

twaver.controls.TreeTable.setVisibleFunction

(
  • v
)

设置TreeTable上的节点是否可见的过滤器

Parameters:

  • v Function

    是否可见的过滤器

Example:

tree.setVisibleFunction(function (element) { return element instanceof twaver.Node; });

twaver.controls.View.centerByLogicalPoint

(
  • x
  • y
  • [animate]
)

Inherited from twaver.controls.View:

将视图的中心点滚动到指定的逻辑坐标

Parameters:

  • x Number

    视图中心点x坐标

  • y Number

    视图中心点y坐标

  • [animate] Boolean optional

    可选，如果为true，则有动画效果，否者没有，默认为false

twaver.controls.View.checkZoom

(
  • value
)
Number

Inherited from twaver.controls.View:

核查缩放级别，如果缩放级别大于maxZoom，则返回maxZoom；如果小于minZoom，则返回minZoom

Parameters:

  • value Number

    缩放级别

Returns:

Number:

返回修正后的缩放级别

twaver.controls.View.getAlarmFillColor

(
  • data
)
String

Inherited from twaver.controls.View:

获取指定数据元的告警填充色，默认如果数据元是网元，则返回网元的最高新发告警颜色，否则返回null

Parameters:

Returns:

String:

返回指定数据元的告警填充色

twaver.controls.View.getInnerColor

(
  • data
)
String

Inherited from twaver.controls.View:

获取指定数据元的填充颜色，默认如果数据元是网元，而且有新发告警，则返回最高级别新发告警的颜色，否则返回样式属性inner.color的值

Parameters:

Returns:

String:

返回指定数据元的填充颜色

twaver.controls.View.getLogicalPoint

(
  • e
)
Object

Inherited from twaver.controls.View:

获取鼠标所在的逻辑坐标，包含x，y属性

Parameters:

  • e MouseEvent

    鼠标事件

Returns:

Object:

返回鼠标所在的逻辑坐标，包含x，y属性

Example:

network.getView().addEventListener('mousedown', function (e) { var point = network.getLogicalPoint(e); console.log(point.x, point.y); });

twaver.controls.View.getMaxZoom

() Number

Inherited from twaver.controls.View:

获取最大缩放级别

Returns:

Number:

返回最大缩放级别

twaver.controls.View.getMinZoom

() Number

Inherited from twaver.controls.View:

获取最小缩放级别

Returns:

Number:

返回最小缩放级别

twaver.controls.View.getOuterColor

(
  • data
)
String

Inherited from twaver.controls.View:

获取指定数据元的边框颜色，默认情况下，如果数据元是网元，而且有传播告警，则返回传播告警的颜色，否者返回属性为outer.color的style值

Parameters:

Returns:

String:

返回指定数据元的边框颜色

twaver.controls.View.getRootDiv

() HTMLDivElement

Inherited from twaver.controls.View:

获取根div元素

Returns:

HTMLDivElement:

返回根div元素

twaver.controls.View.getZoom

() Number

Inherited from twaver.controls.View:

获取当前缩放级别

Returns:

Number:

返回当前缩放级别

twaver.controls.View.isValidEvent

(
  • e
)
Boolean

Inherited from twaver.controls.View:

获取指定鼠标事件是否合法，如果鼠标所在的位置在滚动条上，则不合法，否则合法

Parameters:

  • e MouseEvent

    鼠标事件

Returns:

Boolean:

如果指定鼠标事件是合法的，则返回true，否则返回false

twaver.controls.View.onZoomChanged

(
  • oldZoom
  • newZoom
)

Inherited from twaver.controls.View:

缩放级别变化时触发的动作，用户不需要调用此方法，但可以重载此方法执行自定义逻辑

Parameters:

  • oldZoom Number

    旧缩放级别

  • newZoom Number

    新缩放级别

twaver.controls.View.panByOffset

(
  • xoffset
  • yoffset
)
Object

Inherited from twaver.controls.View:

滚动水平和垂直滚动条指定偏移量

Parameters:

  • xoffset Number

    x坐标偏移量

  • yoffset Number

    y坐标偏移量

Returns:

Object:

返回实际偏移量，为包含x和y属性的对象

twaver.controls.View.setMaxZoom

(
  • value
)

Inherited from twaver.controls.View:

设置最大缩放级别

Parameters:

  • value Number

    缩放级别

twaver.controls.View.setMinZoom

(
  • value
)

Inherited from twaver.controls.View:

设置最小缩放级别

Parameters:

  • value Number

    缩放级别

twaver.controls.View.setTouchZoom

(
  • z
)

Inherited from twaver.controls.View:

触摸模式下设置缩放级别

Parameters:

  • z Number

    缩放级别

twaver.controls.View.setZoom

(
  • value
  • [animate]
)

Inherited from twaver.controls.View:

设置当前缩放级别

Parameters:

  • value Number

    缩放级别

  • [animate] Boolean optional

    缩放时，是否有动画效果，可选，默认为twaver.Defaults.ZOOM_ANIMATE

twaver.controls.View.zoomIn

(
  • [animate]
)

Inherited from twaver.controls.View:

将视图放大twaver.Defaults.ZOOM_INCREMENT倍

Parameters:

  • [animate] Boolean optional

    是否使用动画效果，可选，默认为twaver.Defaults.ZOOM_ANIMATE

twaver.controls.View.zoomOut

(
  • [animate]
)

Inherited from twaver.controls.View:

将视图缩小twaver.Defaults.ZOOM_INCREMENT倍

Parameters:

  • [animate] Boolean optional

    是否使用动画效果，可选，默认为twaver.Defaults.ZOOM_ANIMATE

twaver.controls.View.zoomOverview

(
  • [animate]
)

Inherited from twaver.controls.View:

将视图缩放到让所有数据元可见

Parameters:

  • [animate] Boolean optional

    是否使用动画效果，可选，默认为twaver.Defaults.ZOOM_ANIMATE

twaver.controls.View.zoomReset

(
  • [animate]
)

Inherited from twaver.controls.View:

还原缩放级别为1

Parameters:

  • [animate] Boolean optional

    是否使用动画效果，可选，默认为twaver.Defaults.ZOOM_ANIMATE

twaver.controls.ViewBase.addInteractionListener

(
  • listener
  • [scope]
  • [ahead]
)

Inherited from twaver.controls.ViewBase:

添加交互事件监听器，用于监听用户各种操作

Parameters:

  • listener Function

    回调函数

  • [scope] Object optional

    可选，回调函数的作用域，默认为null，即全局

  • [ahead] Boolean optional

    可选，是否将此监听放在最前面，默认为false

Example:

viewBase.addInteractionListener(function (e) { console.log(e.kind, e.element); });

kind可以为下列值： createElement 创建网元 clickElement 单击网元 doubleClickElement 双击网元 clickBackground 单击背景 doubleClickBackground 双击背景 removeElement 删除网元 selectAll 选中所有网元 upSubNetwork 进入上一层子网 enterSubNetwork 进入子网 bundleLink 展开或合并连线捆绑 expandGroup 展开组 liveMoveStart 开始实时移动网元 liveMoveBetween 正在实时移动网元 liveMoveEnd 结束实时移动网元 lazyMoveStart 开始延迟移动网元 lazyMoveBetween 正在延迟移动网元 lazyMoveEnd 结束延迟移动网元 liveResizeStart 开始实时改变网元大小 liveResizeBetween 正在实时改变网元大小 liveResizeEnd 结束实时改变网元大小 lazyResizeStart 开始延迟改变网元大小 lazyResizeBetween 正在延迟改变网元大小 lazyResizeEnd 结束延迟改变网元大小 selectStart 开始框选 selectBetween 正在框选 selectEnd 结束框选 liveMovePointStart 开始移动ShapeLink或ShapeNode的点 liveMovePointBetween 正在移动ShapeLink或ShapeNode的点 liveMovePointEnd 结束移动ShapeLink或ShapeNode的点

twaver.controls.ViewBase.addViewListener

(
  • listener
  • [scope]
  • [ahead]
)

Inherited from twaver.controls.ViewBase:

添加视图变化事件，用于在视图无效、刷新之前或刷新之后执行自定义动作

Parameters:

  • listener Function

    回调函数

  • [scope] Object optional

    可选，回调函数的作用域，默认为null，即全局

  • [ahead] Boolean optional

    可选，是否将此监听放在最前面，默认为false

Example:

viewBase.addViewListener(function (e) { console.log(e.kind); }); kind可以为： invalidate 无效视图 validateStart 刷新视图前 validateEnd 刷新视图后

twaver.controls.ViewBase.fireInteractionEvent

(
  • evt
)

Inherited from twaver.controls.ViewBase:

派发交互事件

Parameters:

  • evt Object

    交互事件

twaver.controls.ViewBase.fireViewEvent

(
  • evt
)

Inherited from twaver.controls.ViewBase:

当视图需要重画时，TWaver调用此方法派发视图变化事件

Parameters:

  • evt Object

    视图变化事件

twaver.controls.ViewBase.getIcon

(
  • data
)
String

Inherited from twaver.controls.ViewBase:

获取指定数据元的图标，默认返回data#getIcon

Parameters:

Returns:

String:

返回指定数据元的图标

twaver.controls.ViewBase.getLabel

(
  • data
)
String

Inherited from twaver.controls.ViewBase:

获取指定数据元的标签，默认返回Data#getName

Parameters:

Returns:

String:

返回指定数据元的标签

twaver.controls.ViewBase.getSelectColor

(
  • data
)
String

Inherited from twaver.controls.ViewBase:

获取指定数据元的选中颜色，默认值为twaver.Defaults.SELECT_COLOR

Parameters:

Returns:

String:

返回指定数据元的选中颜色

twaver.controls.ViewBase.getSelectionModel

() twaver.SelectionModel

Inherited from twaver.controls.ViewBase:

获取选择模型，如果ViewBase#isShareSelectionModel为true（默认值为true），则返回和ViewBase绑定的DataBox的SelectionModel，否则返回视图自己独立的SelectionModel

Returns:

twaver.SelectionModel:

返回选择模型

twaver.controls.ViewBase.getToolTip

(
  • data
)
String

Inherited from twaver.controls.ViewBase:

获取指定数据元的提示信息，默认返回Data#getToolTip

Parameters:

Returns:

String:

返回指定数据元的提示信息

twaver.controls.ViewBase.isFocusOnClick

() Boolean

Inherited from twaver.controls.ViewBase:

获取点击时是否让视图获得焦点

Returns:

Boolean:

返回点击时是否让视图获得焦点

twaver.controls.ViewBase.isSelectable

(
  • data
)
Boolean

Inherited from twaver.controls.ViewBase:

判断指定数据元是否可以被选择，此方法包装了SelectionModel的isSelectable方法

Parameters:

Returns:

Boolean:

返回指定数据元是否可以被选择

twaver.controls.ViewBase.isSelected

(
  • data
)
Boolean

Inherited from twaver.controls.ViewBase:

获取指定数据元是否已被选中

Parameters:

Returns:

Boolean:

返回指定数据元是否已被选中

twaver.controls.ViewBase.isShareSelectionModel

() Boolean

Inherited from twaver.controls.ViewBase:

获取是否和视图绑定的数据容器共享选择模型，默认为true

Returns:

Boolean:

返回是否和视图绑定的数据容器共享选择模型

twaver.controls.ViewBase.removeInteractionListener

(
  • listener
  • [scope]
)

Inherited from twaver.controls.ViewBase:

删除指定作用域的交互监听器，作用域必须和添加监听器时的作用域一致，相同的作用域的相同监听器只能成功添加一次

Parameters:

  • listener Function

    交互监听器

  • [scope] Object optional

    交互监听器的作用域，可选，默认为null，代表全局

twaver.controls.ViewBase.removeSelection

() twaver.List

Inherited from twaver.controls.ViewBase:

删除选中的网元

Returns:

twaver.List:

返回被删除的网元集合

twaver.controls.ViewBase.removeViewListener

(
  • listener
  • [scope]
)

Inherited from twaver.controls.ViewBase:

删除指定作用域的视图变化监听器，作用域必须和添加监听器时的作用域一致，相同的作用域的相同监听器只能成功添加一次

Parameters:

  • listener Function

    视图变化监听器

  • [scope] Object optional

    视图变化监听器的作用域，可选，默认为null，代表全局

twaver.controls.ViewBase.selectAll

() twaver.List

Inherited from twaver.controls.ViewBase:

选中所有网元

Returns:

twaver.List:

返回所有选中的网元

twaver.controls.ViewBase.setFocusOnClick

(
  • v
)

Inherited from twaver.controls.ViewBase:

设置点击时是否让Network获得焦点

Parameters:

  • v Boolean

    点击时是否让Network获得焦点

twaver.controls.ViewBase.setShareSelectionModel

(
  • shareSelectionModel
)

Inherited from twaver.controls.ViewBase:

设置是否和Network绑定的ElementBox共享选择模型，默认为true

Parameters:

  • shareSelectionModel Boolean

    是否和Network绑定的ElementBox共享选择模型

twaver.PropertyChangeDispatcher.addPropertyChangeListener

(
  • listener
  • [scope]
  • [ahead]
)

Inherited from twaver.PropertyChangeDispatcher:

添加属性变化监听器，用于监听属性变化

Parameters:

  • listener Function

    属性变化监听器

  • [scope] Object optional

    可选，属性变化监听器的作用域，默认为null，即全局

  • [ahead] Boolean optional

    可选，是否将此监听放在最前面，默认为false

Example:

var dispatcher = new twaver.PropertyChangeDispatcher(); dispatcher.addPropertyChangeListener(function (e) { console.log(e.property, e.newValue, e.oldValue); });

twaver.PropertyChangeDispatcher.firePropertyChange

(
  • property
  • oldValue
  • newValue
)
Boolean

Inherited from twaver.PropertyChangeDispatcher:

派发属性变化事件，属性变化时调用此方法

Parameters:

  • property String

    发生变化的属性

  • oldValue Object

    和此属性相关的旧值

  • newValue Object

    和此属性相关的新值

Returns:

Boolean:

如果新值和旧值相等则返回false，否则返回true

twaver.PropertyChangeDispatcher.getClassName

() String

Inherited from twaver.PropertyChangeDispatcher:

获取此类的字符串类名

Returns:

String:

返回此类的字符串类名

twaver.PropertyChangeDispatcher.onPropertyChanged

(
  • e
)

Inherited from twaver.PropertyChangeDispatcher:

属性变化时（firePropertyChange）触发的动作，不需要调用此方法，但可以重载此方法执行自定义逻辑

Parameters:

  • e Object

    属性变化事件，包含property、oldValue和newValue的Object对象

twaver.PropertyChangeDispatcher.removePropertyChangeListener

(
  • listener
  • [scope]
)

Inherited from twaver.PropertyChangeDispatcher:

删除指定作用域的属性变化监听器，作用域必须和添加监听器时的作用域一致，相同的作用域的相同监听器只能成功添加一次

Parameters:

  • listener Function

    属性变化监听器

  • [scope] Object optional

    属性变化监听器的作用域，可选，默认为null，代表全局