API Docs for: TWaver HTML5 5.7.5
Show:

twaver.controls.Tree Class

Extends twaver.controls.ListBase

树视图

TWaver HTML5的树是图形组件的一种，它是和DataBox绑定的，以树的形式展示DataBox中的数据以及数据之间的层次关系。

TWaver HTML5的Tree采用了一种新的机制，只展示可见部分的数据，因此它的性能很高，能承载上万的数据

Constructor

twaver.controls.Tree

(
  • dataBox
)
twaver.controls.Tree

Parameters:

Returns:

twaver.controls.Tree:

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.Tree.collapse

(
  • data
)

合并指定的树节点

Parameters:

twaver.controls.Tree.collapseAll

()

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

twaver.controls.Tree.expand

(
  • data
)

展开指定的树节点对象

Parameters:

twaver.controls.Tree.expandAll

()

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

twaver.controls.Tree.getCheckMode

() String

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

Returns:

String:

树上的勾选方式

twaver.controls.Tree.getCollapseIcon

() String

获取树合并的图标，默认为twaver.Defaults.TREE_COLLAPSE_ICON

Returns:

String:

树合并的图标

twaver.controls.Tree.getExpandIcon

() String

获取树展开的图标，默认为twaver.Defaults.TREE_EXPAND_ICON

Returns:

String:

树展开的图标

twaver.controls.Tree.getIndent

() Number

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

Returns:

Number:

树的缩进

twaver.controls.Tree.getLevel

(
  • data
)
Number

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

Parameters:

Returns:

Number:

节点的层次数

twaver.controls.Tree.getLineAlpha

() Number

获取连线透明度

Returns:

Number:

透明度

twaver.controls.Tree.getLineColor

() Number

获取连线颜色

Returns:

Number:

连线颜色

twaver.controls.Tree.getLineDash

() String

获取连线样式

Returns:

String:

连线样式

twaver.controls.Tree.getLineThickness

() Number

获取连线厚度

Returns:

Number:

连线厚度

twaver.controls.Tree.getLineType

() String

获取连线类型，默认值arc 取值范围：arc, triangle, parallel, flexional, flexional.horizontal, flexional.vertical, orthogonal, orthogonal.horizontal, orthogonal.vertical, orthogonal.H.V, orthogonal.V.H, extend.top, extend.left, extend.bottom, extend.right

Returns:

String:

连线类型

twaver.controls.Tree.getRootData

() twaver.Data

获取根节点数据

Returns:

twaver.Data:

树的根节点

twaver.controls.Tree.getRowHeight

() Number

获取树的行高，默认为twaver.Defaults.TREE_ROW_HEIGHT

Returns:

Number:

树的行高

twaver.controls.Tree.getRowLineColor

() String

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

Returns:

String:

树上行之间线的颜色

twaver.controls.Tree.getRowLineWidth

() Number

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

Returns:

Number:

树上行之间线的宽度

twaver.controls.Tree.getSortFunction

() Function

获取树节点排序的函数

Returns:

Function:

排序的函数

Example:

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

twaver.controls.Tree.getToggleImage

(
  • data
)
String

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

Parameters:

Returns:

String:

树节点当前显示的图标

twaver.controls.Tree.getUncheckableStyle

() String

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

Returns:

String:

树节点不可勾选时的样式

twaver.controls.Tree.getVisibleFunction

() Function

获取树上的节点是否可见的过滤器

Returns:

Function:

是否可见的过滤器

Example:

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

twaver.controls.Tree.isCheckable

(
  • [data]
)
Boolean

获取指定的树节点是否可勾选

Parameters:

Returns:

Boolean:

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

twaver.controls.Tree.isCheckMode

() Boolean

是否为勾选模型

Returns:

Boolean:

true为勾选模型，否则为false

twaver.controls.Tree.isChildrenSortable

(
  • parent
)
Boolean

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

Parameters:

Returns:

Boolean:

true为可排序，否则为false

twaver.controls.Tree.isExpanded

(
  • data
)
Boolean

指定的树节点是否处于展开状态

Parameters:

Returns:

Boolean:

true为展开状态，否则为false

twaver.controls.Tree.isKeyboardRemoveEnabled

() Boolean

判断树是否支持键盘删除节点的操作，默认为 twaver.Defaults.TREE_KEYBOARD_REMOVE_ENABLED

Returns:

Boolean:

true为可以键盘删除，否则为false

twaver.controls.Tree.isKeyboardSelectEnabled

() Boolean

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

Returns:

Boolean:

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

twaver.controls.Tree.isMakeVisibleOnSelected

() Boolean

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

Returns:

Boolean:

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

twaver.controls.Tree.isRootVisible

() Boolean

判断根节点是否可见

Returns:

Boolean:

true为可见，否则为false

twaver.controls.Tree.onLabelRendered

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

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

Parameters:

  • span HTMLSpanElement

    包含数据元标签的Span

  • data twaver.Data

    指定的数据

  • label String

    显示的标签值

  • row Number

    指定的行号

  • level Number

    指定数据的层次数

  • selected Boolean

    是否为选中状态

twaver.controls.Tree.onToggleImageRendered

(
  • image
)

当切换显示的图像时调用此函数。用户不需要自己调用此方法，但可以重载此方法，添加自定义的逻辑

Parameters:

twaver.controls.Tree.renderData

(
  • div
  • data
  • row
  • selected
)

渲染树上显示的数据

Parameters:

  • div HTMLDivElement

    包含指定数据的div

  • data twaver.Data

    指定的数据

  • row Number

    指定数据所在的行号

  • selected Boolean

    是否为选中状态

twaver.controls.Tree.setCheckMode

(
  • v
)

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

Parameters:

  • v String

    树上的勾选方式

twaver.controls.Tree.setCollapseIcon

(
  • v
)

获取树合并的图标，默认为twaver.Defaults.TREE_COLLAPSE_ICON

Parameters:

  • v String

    树合并的图标

twaver.controls.Tree.setExpandIcon

(
  • v
)

设置树展开的图标，默认为twaver.Defaults.TREE_EXPAND_ICON

Parameters:

  • v String

    树展开的图标

twaver.controls.Tree.setIndent

(
  • v
)

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

Parameters:

  • v Number

    树上孩子和父亲之间的缩进值

twaver.controls.Tree.setKeyboardRemoveEnabled

(
  • v
)

设置树是否支持键盘删除节点的操作，默认为 twaver.Defaults.TREE_KEYBOARD_REMOVE_ENABLED

Parameters:

  • v Boolean

    true为可以键盘删除，否则为false

twaver.controls.Tree.setKeyboardSelectEnabled

(
  • v
)

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

Parameters:

  • v Boolean

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

twaver.controls.Tree.setLineAlpha

(
  • v
)

设置联系透明度

Parameters:

  • v Number

    连线透明度

twaver.controls.Tree.setLineColor

(
  • v
)

设置连线颜色

Parameters:

  • v Number

    连线颜色值

twaver.controls.Tree.setLineDash

(
  • v
)

设置连线样式

Parameters:

  • v String

    连线样式

twaver.controls.Tree.setLineThickness

(
  • v
)

设置连线厚度

Parameters:

  • v Number

    连线厚度值

twaver.controls.Tree.setLineType

(
  • v
)

设置连线类型

Parameters:

  • v String

    连线类型

twaver.controls.Tree.setMakeVisibleOnSelected

(
  • v
)

设置选中某个树节点时，让其处于可见区域，默认为twaver.Defaults.TREE_MAKE_VISIBLE_ON_SELECTED

Parameters:

  • v Boolean

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

twaver.controls.Tree.setRootData

(
  • v
)

获取根节点数据

Parameters:

twaver.controls.Tree.setRootVisible

(
  • v
)

设置根节点是否可见

Parameters:

  • v Boolean

    true为可见，否则为false

twaver.controls.Tree.setRowHeight

(
  • v
)

设置树的行高，默认为twaver.Defaults.TREE_ROW_HEIGHT

Parameters:

  • v Number

    树的行高

twaver.controls.Tree.setRowLineColor

(
  • v
)

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

Parameters:

  • v String

    树上行之间线的颜色

twaver.controls.Tree.setRowLineWidth

(
  • v
)

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

Parameters:

  • v Number

    树上行之间线的宽度

twaver.controls.Tree.setSortFunction

(
  • v
)

设置树节点排序的函数

Parameters:

  • v Function

    排序的函数

Example:

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

twaver.controls.Tree.setUncheckableStyle

(
  • v
)

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

Parameters:

  • v String

    树节点不可勾选时的样式

twaver.controls.Tree.setVisibleFunction

(
  • v
)

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

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，代表全局