API Docs for: TWaver HTML5 5.7.5
Show:

twaver.network.GroupUI Class

Extends twaver.network.NodeUI

群组视图

组对应的视图对象，组有合并和展开两种状态，合并时，组的孩子不可见；展开时，孩子可见

Constructor

twaver.network.GroupUI

(
  • network
  • element
)
twaver.network.GroupUI

Parameters:

Returns:

twaver.network.GroupUI:

Item Index

Methods

Methods

twaver.network.ElementUI.addAttachment

(
  • attachment
)

Inherited from twaver.network.ElementUI:

添加附件，如果showInAttachmentDiv为true，则附件被添加到拓扑的附件层（attachmentDiv），否则附件被添加到网元视图上

Parameters:

twaver.network.ElementUI.addBodyBounds

(
  • rect
)

Inherited from twaver.network.ElementUI:

添加内容区域，所有内容区域合并后构成unionBodyBounds

Parameters:

  • rect Object

    区域，值为包含x、y、width和height属性的Object对象

twaver.network.ElementUI.addComponent

(
  • component
)

Inherited from twaver.network.ElementUI:

添加HTML元素到网元内容视图(bodyView)

Parameters:

  • component HTMLElement

    HTML元素

twaver.network.ElementUI.checkAlarmAttachment

()

Inherited from twaver.network.ElementUI:

检查是否显示告警附件，如果Network#getAlarmLabel(element)返回null或空字符串，则不显示

twaver.network.ElementUI.checkAttachments

()

Inherited from twaver.network.ElementUI:

检查所有附件是否显示，网元刷新时（validate）被调用，包括告警AlarmAttachment、标签附件LabelAttachement、编辑附件EditAttachment和图标组附件IconsAttachment

twaver.network.ElementUI.checkEditAttachment

()

Inherited from twaver.network.ElementUI:

检查是否显示编辑附件，如果此网元可选中（Network#isSelected(element)返回true），而且可编辑（Network#isEditable(element)返回true），而且此网元视图可编辑（isEditable()返回true），则显示，否则不显示

twaver.network.ElementUI.checkIconsAttachment

()

Inherited from twaver.network.ElementUI:

检查是否显示图标组附件，如果Network#getIconsNames(element)返回null或者length为0，则不显示

twaver.network.ElementUI.checkLabelAttachment

()

Inherited from twaver.network.ElementUI:

检查是否显示标签附件，如果Network#getLabel(element)返回null或空字符串，则不显示

twaver.network.ElementUI.cleanUp

(
  • names
)

Inherited from twaver.network.ElementUI:

清除未添加到视图中的对象，比如告警消失后，告警附件需要被清除

Parameters:

  • names Array

    需要被删除属性名称数组

twaver.network.ElementUI.dispose

()

Inherited from twaver.network.ElementUI:

销毁网元视图，网元从拓扑关联的网元容器中删除时被调用，用于从拓扑视图中删除网元视图及其附件视图

twaver.network.ElementUI.getAlarmAttachment

() twaver.network.AlarmAttachment

Inherited from twaver.network.ElementUI:

获取告警附件

Returns:

twaver.network.AlarmAttachment:

返回告警附件

twaver.network.ElementUI.getAttachments

() twaver.List

Inherited from twaver.network.ElementUI:

获取所有附件集合，包含告警AlarmAttachment、标签附件LabelAttachement、编辑附件EditAttachment和图标组附件IconsAttachment

Returns:

twaver.List:

返回所有附件集合

twaver.network.ElementUI.getBodyRect

() Object

Inherited from twaver.network.ElementUI:

获得内容区域，默认为createBodyRect返回的结果

Returns:

Object:

返回内容区域，值为包含x、y、width和height属性的Object对象

twaver.network.ElementUI.getBodyView

() HTMLDivElement

Inherited from twaver.network.ElementUI:

获取网元内容视图

Returns:

HTMLDivElement:

返回网元内容视图

twaver.network.ElementUI.getClassName

() String

Inherited from twaver.network.ElementUI:

获取该类字符串类名

Returns:

String:

返回类名

twaver.network.ElementUI.getDyeColor

(
  • styleProp
)
String

Inherited from twaver.network.ElementUI:

获取指定样式的渲染颜色，如果innerColor不为空则返回innerColor，否则返回指定样式的值

Parameters:

  • styleProp String

    样式属性

Returns:

String:

返回渲染颜色

twaver.network.ElementUI.getEditAttachment

() twaver.network.EditAttachment

Inherited from twaver.network.ElementUI:

获取编辑附件

Returns:

twaver.network.EditAttachment:

返回编辑附件

twaver.network.ElementUI.getElement

() twaver.Element

Inherited from twaver.network.ElementUI:

获取和网元视图关联的网元

Returns:

twaver.Element:

返回和网元视图关联的网元

twaver.network.ElementUI.getFont

(
  • styleProp
)
String

Inherited from twaver.network.ElementUI:

获取给定样式属性的值作为字体，如果指定样式的值是null，则返回twaver.Defaults.FONT

Parameters:

  • styleProp String

    样式属性

Returns:

String:

返回字体

twaver.network.ElementUI.getHotSpot

() Object

Inherited from twaver.network.ElementUI:

获取热点，用于定位附件等的位置

Returns:

Object:

返回热点，值为包含x和y属性的Object对象

twaver.network.ElementUI.getIconsAttachment

() twaver.network.IconsAttachment

Inherited from twaver.network.ElementUI:

获取图标组附件

Returns:

twaver.network.IconsAttachment:

返回图标组附件

twaver.network.ElementUI.getInnerColor

() String

Inherited from twaver.network.ElementUI:

获取网元填充色

Returns:

String:

返回网元填充色

twaver.network.ElementUI.getLabelAttachment

() twaver.network.LabelAttachment

Inherited from twaver.network.ElementUI:

获取标签附件

Returns:

twaver.network.LabelAttachment:

返回标签附件

twaver.network.ElementUI.getNetwork

() twaver.network.Network

Inherited from twaver.network.ElementUI:

获取和网元视图关联的拓扑

Returns:

twaver.network.Network:

返回和网元视图关联的拓扑

twaver.network.ElementUI.getOuterColor

() String

Inherited from twaver.network.ElementUI:

获取网元边框颜色

Returns:

String:

返回网元边框颜色

twaver.network.ElementUI.getShadowColor

() String

Inherited from twaver.network.ElementUI:

获取网元选中后阴影颜色

Returns:

String:

返回网元选中后阴影颜色

twaver.network.ElementUI.getStyle

(
  • styleProp
)
Object

Inherited from twaver.network.ElementUI:

获取指定样式属性的值，封装了Element.getStyle

Parameters:

  • styleProp String

    样式属性

Returns:

Object:

返回指定样式属性的值

twaver.network.ElementUI.getUnionBodyBounds

() Object

Inherited from twaver.network.ElementUI:

获取合并的内容区域

Returns:

Object:

返回合并的内容区域，值为包含x、y、width和height属性的Object对象

twaver.network.ElementUI.getView

() HTMLDivElement

Inherited from twaver.network.ElementUI:

获取网元视图，网元视图包含内容视图（bodyview）和附件（告警AlarmAttachment、标签附件LabelAttachement、编辑附件EditAttachment和图标组附件IconsAttachment）

Returns:

HTMLDivElement:

返回网元视图

twaver.network.ElementUI.getViewRect

() Object

Inherited from twaver.network.ElementUI:

获取视图内容区域，包括unionBodyBounds和所有附件的区域

Returns:

Object:

返回视图内容区域，值为包含x、y、width和height属性的Object对象

twaver.network.ElementUI.handlePropertyChange

(
  • e
)

Inherited from twaver.network.ElementUI:

和网元视图关联的网元属性变化时的处理函数，默认实现为调用invalidate方法让网元视图刷新

Parameters:

  • e Object

    属性变化事件，包含property、oldValue和newValue属性

twaver.network.ElementUI.handleSelectionChange

(
  • e
)

Inherited from twaver.network.ElementUI:

和网元视图关联的网元被选中或取消选中时的处理函数，默认实现为调用invalidate方法让网元视图刷新

Parameters:

  • e Object

    选择变化事件，包含kind和data属性

twaver.network.ElementUI.hit

(
  • x
  • y
)
Boolean

Inherited from twaver.network.ElementUI:

命中测试，判断网元视图是否包含指定坐标

Parameters:

  • x Number

    x坐标

  • y Number

    y坐标

Returns:

Boolean:

网元视图是否包含指定坐标，则返回true，否者返回false

twaver.network.ElementUI.hitCanvas

(
  • x
  • y
  • names
)
Boolean

Inherited from twaver.network.ElementUI:

对网元视图中的画布元素进行命中测试，判断网元视图中的画布元素是否包含指定坐标

Parameters:

  • x Number

    x坐标

  • y Number

    y坐标

  • names Array

    画布元素名称数组

Returns:

Boolean:

网元视图中的画布元素是否包含指定坐标，是则返回true，否则返回false

twaver.network.ElementUI.hitComponent

(
  • x
  • y
  • names
)
Boolean

Inherited from twaver.network.ElementUI:

对网元视图中的html元素进行命中测试，判断网元视图中的html元素是否包含指定坐标

Parameters:

  • x Number

    x坐标

  • y Number

    y坐标

  • names Array

    html元素名称数组

Returns:

Boolean:

如果网元视图中的html元素包含指定坐标，则返回true，否则返回false

twaver.network.ElementUI.hitTest

(
  • x
  • y
)
Object

Inherited from twaver.network.ElementUI:

获取指定坐标下的视图对象，为附件或者网元视图本身

Parameters:

  • x Number

    x坐标

  • y Number

    y坐标

Returns:

Object:

返回指定坐标下的视图对象，为附件或者网元视图本身

twaver.network.ElementUI.intersects

(
  • rect
)
Boolean

Inherited from twaver.network.ElementUI:

判断网元视图是否和指定区域相交

Parameters:

  • rect Object

    矩形区域，值为包含x、y、width和height属性的Object对象

Returns:

Boolean:

如果网元视图包含指定矩形区域，则返回true，否则返回false

twaver.network.ElementUI.intersectsCanvas

(
  • rect
  • names
)
Boolean

Inherited from twaver.network.ElementUI:

对网元视图中的html元素进行命中测试，判断网元视图中的画布元素是否包含指定区域

Parameters:

  • rect Object

    矩形区域，包含x、y、width和height属性的Object对象

  • names Array

    画布元素名称数组

Returns:

Boolean:

如果网元视图中的画布元素包含指定区域，则返回true，否则返回false

twaver.network.ElementUI.intersectsComponent

(
  • rect
  • names
)
Boolean

Inherited from twaver.network.ElementUI:

对网元视图中的html元素进行命中测试，判断网元视图中的html元素是否包含指定区域

Parameters:

  • rect Object

    矩形区域，包含x、y、width和height属性的Object对象

  • names Array

    html元素名称数组

Returns:

Boolean:

如果网元视图中的html元素包含指定区域，则返回true，否则返回false

twaver.network.ElementUI.intersectsTest

(
  • rect
)
Object

Inherited from twaver.network.ElementUI:

获取指定矩形区域的视图对象，为附件或者网元视图本身

Parameters:

  • rect Object

    矩形区域，包含x、y、width和height属性的Object对象

Returns:

Object:

返回指定矩形区域的对象，为附件或者网元视图本身

twaver.network.ElementUI.invalidate

(
  • [checkAttachments]
)

Inherited from twaver.network.ElementUI:

使当前网元视图失效，检查所有附件是否可见（checkAttachments），改变内部标识，调用invalidateElementVisibility()方法，刷新网元视图

Parameters:

  • [checkAttachments] String optional

    检查所有附件是否可见，默认为true

twaver.network.ElementUI.isEditable

() Boolean

Inherited from twaver.network.ElementUI:

获取网元视图是否可编辑，默认值为true

Returns:

Boolean:

如果网元视图可编辑，则返回true，否则返回false

twaver.network.ElementUI.isShadowable

() Boolean

Inherited from twaver.network.ElementUI:

判断是否需要设置阴影，默认实现是如果设置了阴影颜色，而且网元被被选中，而且select.style样式为shadow，则返回true，否则返回false

Returns:

Boolean:

如果需要设置阴影，则返回true，否则返回false

twaver.network.ElementUI.isVisible

() Boolean

Inherited from twaver.network.ElementUI:

判断网元视图是否可见

Returns:

Boolean:

如果网元视图可见，则返回true，否则返回false

twaver.network.ElementUI.removeAttachment

(
  • attachment
)

Inherited from twaver.network.ElementUI:

删除指定附件

Parameters:

twaver.network.ElementUI.setHotSpot

(
  • value
)

Inherited from twaver.network.ElementUI:

设置热点，用于定位附件等的位置

Parameters:

  • value Object

    热点，值为包含x和y属性的Object对象

twaver.network.ElementUI.setShadow

(
  • part
  • canvas
  • rect
)
CanvasRenderingContext2D

Inherited from twaver.network.ElementUI:

给指定画布元素设置阴影效果

Parameters:

  • part Object

    网元视图（ElementUI）或者附件（Attachment）

  • canvas HTMLCanvasElement

    画布元素

  • rect Object

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

Returns:

CanvasRenderingContext2D:

画布渲染内容

twaver.network.ElementUI.setVisible

(
  • value
)

Inherited from twaver.network.ElementUI:

设置网元视图是否可见

Parameters:

  • value Boolean

    是否可见

twaver.network.ElementUI.updateMeasure

()

Inherited from twaver.network.ElementUI:

更新网元视图内容，被validate方法调用，一般子类重载此方法，往网元视图添加HTML元素

twaver.network.ElementUI.validate

()

Inherited from twaver.network.ElementUI:

此方法被Network调用，用以重画网元视图内容，此内部检查所有附件是否可见（checkAttachments），并调用updateMeasure方法重画网元内容，最后调用附件的updateMeasure方法，让附件重画

twaver.network.GroupUI.drawExpandedGroup

()

画展开后的组，用group.shape样式属性定义的形状画出矢量图形

twaver.network.GroupUI.getChildrenRects

() twaver.List

获取所有孩子的区域

Returns:

twaver.List:

返回所有孩子的区域

twaver.network.NodeUI.createBodyRect

() Object

Inherited from twaver.network.NodeUI:

创建节点内容区域，默认为网元节点的x坐标、y坐标、宽度和高度组成

Returns:

Object:

返回内容区域，值为包含x、y、width和height属性的Object对象

twaver.network.NodeUI.drawBody

()

Inherited from twaver.network.NodeUI:

画节点内容，根据body.type样式属性填充不同内容，body.type样式可选值为： default 对应drawDefaultBody方法，用图片填充节点内容区域 vector 对应drawVectorBody方法，用矢量图形填充节点内容区域 default.vector 先画图片，再画矢量图形 vector.default 先画矢量图形，再画图片

twaver.network.NodeUI.drawDefaultBody

()

Inherited from twaver.network.NodeUI:

用图片填充节点内容区域

twaver.network.NodeUI.drawOuterBorder

()

Inherited from twaver.network.NodeUI:

画边框

twaver.network.NodeUI.drawSelectBorder

()

Inherited from twaver.network.NodeUI:

节点被选中时，画选中边框

twaver.network.NodeUI.drawVectorBody

()

Inherited from twaver.network.NodeUI:

当body.type为vector或default.vector时，用矢量图形填充节点内容