API Docs for: TWaver HTML5 5.7.5
Show:

twaver.Link Class

Extends twaver.Element

连线对象

Link是一种网元，它表现为Network上的连线。它在电信拓扑中用于展示链路或基于数据的连线。比如带有物理或逻辑意义的电缆，电路,路由线路，环路等。

连线是和节点一起使用的。一条连线必须有起始、结束节点，起始节点和结束节点不能为空。

当起始节点和结束节点相同时，这种连线成为自环连线。自环连线可以展示为半矩形或半圆形。当两个节点之间有多条连线时，默认可以双击绑定。TWaver会根据默认的规则选定一条连线做为代理连线，其他的连线都会隐藏。当然，也可以更改TWaver的这种代理的规则。

连线和一般网元类似，也可以进行序列化和反序列化。

Constructor

Item Index

Methods

Properties

Methods

twaver.Data.addChild

(
  • child
  • [index]
)
Boolean

Inherited from twaver.Data:

在父亲数据下添加孩子数据，index为添加的孩子数据的顺序号，树中同层下的孩子顺序可以通过这个参数来控制。默认为空，添加在最后一个位置

Parameters:

  • child twaver.Data

    添加的孩子数据

  • [index] Number optional

    添加的孩子数据的顺序，树中的同层下的孩子顺序是通过这个参数来控制的。默认为空，也就是添加在最后一个位置

Returns:

Boolean:

添加成功返回true，否则为false

twaver.Data.clearChildren

() Boolean

Inherited from twaver.Data:

清除这个数据下所有的孩子。注意，这个方法只是切断它们之间的父子关系，并不会从DataBox中将孩子数据删除

Returns:

Boolean:

true为操作成功，false为操作失败

twaver.Data.deserializeClientJson

(
  • serializer
  • json
  • clientProp
)

Inherited from twaver.Data:

反序列化JSON数据到数据对象的自定义属性

Parameters:

  • serializer twaver.JsonSerializer

    JSON序列化对象

  • json String

    JSON数据

  • clientProp String

    自定义的属性名

twaver.Data.deserializeClientXml

(
  • serializer
  • clientXml
  • clientProp
)

Inherited from twaver.Data:

反序列化XML数据到数据对象的自定义属性值

Parameters:

  • serializer twaver.XmlSerializer

    XML的序列化对象

  • clientXml String

    XML数据片段

  • clientProp String

    自定义属性名

twaver.Data.deserializeJson

(
  • serializer
  • json
)

Inherited from twaver.Data:

将JSON数据反序列化为数据对象

Parameters:

twaver.Data.deserializePropertyJson

(
  • serializer
  • json
  • property
)

Inherited from twaver.Data:

反序列化JSON数据到数据对象的自身属性

Parameters:

  • serializer twaver.JsonSerializer

    JSON序列化对象

  • json String

    JSON数据片段

  • property String

    数据自身属性名

twaver.Data.deserializePropertyXml

(
  • serializer
  • propertyXml
  • property
)

Inherited from twaver.Data:

反序列化XML数据到数据对象的自身属性

Parameters:

  • serializer twaver.XmlSerializer

    XML序列化对象

  • propertyXml String

    XML数据片段

  • property String

    数据自身属性名

twaver.Data.deserializeXml

(
  • serializer
  • xml
)

Inherited from twaver.Data:

将XML数据反序列化为数据对象

Parameters:

twaver.Data.getChildAt

(
  • index
)
twaver.Data

Inherited from twaver.Data:

获取某个序号值上的孩子对象

Parameters:

  • index Number

    数据的顺序值

Returns:

twaver.Data:

孩子数据对象

twaver.Data.getChildren

() twaver.List

Inherited from twaver.Data:

获取这个数据对象下的所有孩子对象

Returns:

twaver.List:

孩子对象的集合

twaver.Data.getChildrenSize

() Number

Inherited from twaver.Data:

获取数据对象下孩子的数量

Returns:

Number:

孩子数据的数量

twaver.Data.getClient

(
  • clientProp
)
Object

Inherited from twaver.Data:

获取自定义的属性，Client属性一般用于存放用户自定在数据对象上的属性

Parameters:

  • clientProp String

    自定义的属性名

Returns:

Object:

返回属性值

twaver.Data.getClientMap

() twaver.List

Inherited from twaver.Data:

获取所有的自定义属性

Returns:

twaver.List:

自定义属性的集合

twaver.Data.getClientProperties

() twaver.List

Inherited from twaver.Data:

获取所有自定义的属性名。Client属性一般用于存放用户自定在数据对象上的属性

Returns:

twaver.List:

自定义属性的集合

twaver.Data.getIcon

() String

Inherited from twaver.Data:

得到这个数据的图标，图标是用于在树上显示的。

Returns:

String:

返回图标的名称

twaver.Data.getId

() Object

Inherited from twaver.Data:

得到数据的ID，ID是用于唯一标识数据对象的，在同一个数据容器中的数据ID不能重复

Returns:

Object:

数据的ID编号

twaver.Data.getName

() String

Inherited from twaver.Data:

获取数据对象的名称

Returns:

String:

数据对象的名称值

twaver.Data.getName2

() String

Inherited from twaver.Data:

获取数据对象的名称2

Returns:

String:

返回数据对象的名称2

twaver.Data.getParent

() twaver.Data

Inherited from twaver.Data:

获取数据对象的父亲，每个数据对象只能有一个父亲节点

Returns:

twaver.Data:

父亲对象

twaver.Data.getToolTip

() String

Inherited from twaver.Data:

获取数据对象的悬浮标签，悬浮标签是用于在视图上显示的，比如network，tree，table。悬浮标签在视图上显示片刻便会消失。

Returns:

String:

数据对象的悬浮标签内容

twaver.Data.hasChildren

() Boolean

Inherited from twaver.Data:

判断这个数据对象下是否有孩子对象

Returns:

Boolean:

true为有孩子对象，否则为false

twaver.Data.isDescendantOf

(
  • data
)
Boolean

Inherited from twaver.Data:

判断是否是指定数据对象的子孙节点

Parameters:

Returns:

Boolean:

true为子孙节点，否则为false

twaver.Data.isParentOf

(
  • data
)
Boolean

Inherited from twaver.Data:

判断是否是指定数据对象的父亲

Parameters:

Returns:

Boolean:

true为指定数据对象的父亲，否则为false

twaver.Data.isRelatedTo

(
  • data
)
Boolean

Inherited from twaver.Data:

判断是否和指定数据对象有关联关系，如果这个数据是指定数据对象的子孙或者指定数据对象是这个数据的子孙都称为有关联关系

Parameters:

Returns:

Boolean:

true为有关联关系，否则为false

twaver.Data.newInstance

() twaver.Data

Inherited from twaver.Data:

实例化数据对象

Returns:

twaver.Data:

数据对象

twaver.Data.onChildAdded

(
  • child
  • index
)

Inherited from twaver.Data:

添加完孩子成功后会回调这个方法

Parameters:

  • child twaver.Data

    添加的孩子对象

  • index Number

    孩子添加的顺序

twaver.Data.onChildRemoved

(
  • child
  • index
)

Inherited from twaver.Data:

删除指定孩子对象时会回调这个方法

Parameters:

  • child twaver.Data

    删除的孩子对象

  • index Number

    删除的孩子对象的顺序序号

twaver.Data.onChildrenCleared

(
  • children
)

Inherited from twaver.Data:

清除所有指定孩子对象时会回调这个方法

Parameters:

twaver.Data.onClientChanged

(
  • clientProp
  • oldValue
  • newValue
)

Inherited from twaver.Data:

当数据对象的Client属性发生更改时会回调此方法

Parameters:

  • clientProp String

    属性名

  • oldValue String

    原值

  • newValue String

    新值

twaver.Data.onParentChanged

(
  • oldParent
  • parent
)

Inherited from twaver.Data:

当数据对象的父亲发生更改时回调此方法

Parameters:

  • oldParent twaver.Data

    数据对象原来的父亲节点

  • parent String

    数据对象新的父亲节点

twaver.Data.removeChild

(
  • child
)
Boolean

Inherited from twaver.Data:

删除指定的孩子对象

Parameters:

Returns:

Boolean:

返回true表示删除成功，false为删除失败

twaver.Data.serializeClientJson

(
  • serializer
  • clientPrope
  • newInstance
  • dataObject
)

Inherited from twaver.Data:

序列化数据元素的自定义属性到JSON片段

Parameters:

  • serializer twaver.JsonSerializer

    JSON序列化对象

  • clientPrope String

    数据对象的自定义属性名

  • newInstance twaver.Data

    序列化的数据对象

  • dataObject Object

    JSON数据对象

twaver.Data.serializeClientXml

(
  • serializer
  • clientPrope
  • newInstance
)

Inherited from twaver.Data:

序列化数据元素的自定义属性到XML片段

Parameters:

twaver.Data.serializeJson

(
  • serializer
  • newInstance
  • dataObject
)

Inherited from twaver.Data:

将数据元素序列化成JSON片段

Parameters:

twaver.Data.serializePropertyJson

(
  • serializer
  • property
  • newInstance
  • dataObject
)

Inherited from twaver.Data:

序列化数据元素属性到JSON片段

Parameters:

  • serializer twaver.JsonSerializer

    JSON序列化对象

  • property String

    序列化的属性名称

  • newInstance twaver.Data

    序列化的实例对象

  • dataObject Object

    JSON数据对象

twaver.Data.serializePropertyXml

(
  • serializer
  • property
  • newInstance
)

Inherited from twaver.Data:

序列化数据元素属性到XML片段

Parameters:

twaver.Data.serializeXml

(
  • serializer
  • newInstance
)

Inherited from twaver.Data:

将数据元素序列化成XML片段

Parameters:

twaver.Data.setClient

(
  • clientProp
  • newValue
)
twaver.Data

Inherited from twaver.Data:

设置自定义的属性的值

Parameters:

  • clientProp String

    自定义属性的名称

  • newValue Object

    自定义属性的值

Returns:

twaver.Data:

数据对象本身

twaver.Data.setIcon

(
  • v
)

Inherited from twaver.Data:

设置数据元素的Icon。Icon和Image是类似的，但需要注意，Icon一般是在树上显示的，而Image是在network上显示的。

Parameters:

  • v String

    数据元素的Icon名称

twaver.Data.setName

(
  • v
)

Inherited from twaver.Data:

设置数据元素的名称

Parameters:

  • v String

    数据元素的名称

twaver.Data.setName2

(
  • v
)

Inherited from twaver.Data:

设置数据对象的名称2

Parameters:

  • v String

    数据对象的名称2

twaver.Data.setParent

(
  • parent
)

Inherited from twaver.Data:

设置数据元素的父亲，每个数据元素只能设置一个父亲

Parameters:

twaver.Data.setToolTip

(
  • v
)

Inherited from twaver.Data:

设置悬浮标签的显示内容。当鼠标移至数据元素时，视图上就会显示这个悬浮标签一段时间。

Parameters:

  • v String

    悬浮标签显示的内容

twaver.Data.toChildren

(
  • matchFunction
  • scope
)
String

Inherited from twaver.Data:

根据指定的函数，将数据元素的孩子转换成List集合

Parameters:

  • matchFunction Function

    指定的函数

  • scope String

    函数的作用域，为空时指的是window

Returns:

String:

孩子数据的集合

twaver.Element.deserializeStyleJson

(
  • serializer
  • json
  • styleProp
)

Inherited from twaver.Element:

反序列化JSON数据到指定的网元样式

Parameters:

  • serializer twaver.JsonSerializer

    JSON序列化对象

  • json String

    JSON数据

  • styleProp String

    网元样式名

twaver.Element.deserializeStyleXml

(
  • serializer
  • styleXml
  • styleProp
)

Inherited from twaver.Element:

反序列化XML数据到指定的网元样式

Parameters:

  • serializer twaver.XmlSerializer

    XML序列化对象

  • styleXml String

    XML数据

  • styleProp String

    网元样式名

twaver.Element.getAlarmState

() twaver.AlarmState

Inherited from twaver.Element:

获取网元的告警状态对象，告警状态对象是用于存放网元上的所有告警信息

Returns:

twaver.AlarmState:

告警状态对象

twaver.Element.getCanvasUIClass

() String

Inherited from twaver.Element:

获取网元的CanvasUI类名称, twaver.canvas.Network用此类实例化网元对应的UI实例

Returns:

String:

返回网元的CanvasUI类名称

twaver.Element.getElementUIClass

() String

Inherited from twaver.Element:

获取网元UI的类名，网元UI用于在network组件上绘制这个网元。TWaver会用返回的这个UI类去创建UI对象

Returns:

String:

网元UI的类名

twaver.Element.getLayerId

() Object

Inherited from twaver.Element:

获取这个网元所在的图层ID。如果为空，则这个网元处于默认的图层上

Returns:

Object:

图层ID

twaver.Element.getStyle

(
  • styleProp
  • [returnDefaultIfNull]
)
Object

Inherited from twaver.Element:

通过样式名称去获取这个网元样式的值

Parameters:

  • styleProp String

    网元样式名

  • [returnDefaultIfNull] String optional

    当属性为空时，是否需要返回默认的值。默认值为true

Returns:

Object:

网元的样式值

twaver.Element.getStyleProperties

() twaver.List

Inherited from twaver.Element:

获取网元上所有的样式属性集合

Returns:

twaver.List:

网元上所有样式属性名的集合

twaver.Element.getVectorUIClass

() twaver.vector.ElementUI

Inherited from twaver.Element:

获取网元矢量UI的类名，网元UI用于在network组件上绘制这个网元。TWaver会用返回的这个UI类去创建UI对象

Returns:

twaver.vector.ElementUI:

矢量UI类型

twaver.Element.isAdjustedToBottom

() Boolean

Inherited from twaver.Element:

网元是否需要置底

Returns:

Boolean:

true为调整置底，否则为false

twaver.Element.isMovable

() Boolean

Inherited from twaver.Element:

获取网元是否可移动

Returns:

Boolean:

网元是否可移动

twaver.Element.isVisible

() String

Inherited from twaver.Element:

获取网元是否可见

Returns:

String:

网元是否可见

twaver.Element.onStyleChanged

(
  • styleProp
  • oldValue
  • newValue
)

Inherited from twaver.Element:

当更改网元的样式时，回调此方法

Parameters:

  • styleProp String

    网元样式名

  • oldValue String

    网元样式原值

  • newValue String

    网元样式新值

twaver.Element.s

(
  • style
  • value
)
twaver.Element

Inherited from twaver.Element:

如果只有一个参数，则返回指定样式的值，相当于getStyle；否则设置样式，相当于setStyle

Parameters:

  • style String

    样式名称

  • value Object

    样式值

Returns:

twaver.Element:

如果只有一个参数，则返回指定样式的值，否则返回网元自身

twaver.Element.serializeStyleJson

(
  • serializer
  • stylePrope
  • newInstance
  • dataObject
)

Inherited from twaver.Element:

序列化指定的样式到JSON数据

Parameters:

  • serializer twaver.JsonSerializer

    JSON序列化对象

  • stylePrope String

    网元样式名

  • newInstance twaver.Element

    序列化的实例对象

  • dataObject Object

    JSON数据对象

twaver.Element.serializeStyleXml

(
  • serializer
  • stylePrope
  • newInstance
)

Inherited from twaver.Element:

序列化样式到XML数据

Parameters:

twaver.Element.setLayerId

(
  • v
)

Inherited from twaver.Element:

设置图层ID

Parameters:

  • v Object

    图层ID

twaver.Element.setMovable

(
  • v
)

Inherited from twaver.Element:

设置网元是否可移动

Parameters:

  • v Boolean

    网元 是否可移动

twaver.Element.setStyle

(
  • styleProp
  • newValue
)
twaver.Element

Inherited from twaver.Element:

设置网元上指定样式名的属性值

Parameters:

  • styleProp String

    网元样式名

  • newValue String

    网元样式值

Returns:

twaver.Element:

对象本身

twaver.Element.setVisible

(
  • v
)

Inherited from twaver.Element:

设置网元是否可见

Parameters:

  • v String

    网元是否可见，true为可见

twaver.Link.getBundleCount

() Number

获取和这条连线捆绑的连线数量

Returns:

Number:

捆绑数量

twaver.Link.getBundleIndex

() Number

得到捆绑的顺序号

Returns:

Number:

捆绑的顺序号

twaver.Link.getFromAgent

() twaver.Node

获取连线的起始节点的代理

Returns:

twaver.Node:

起始节点代理

twaver.Link.getFromNode

() twaver.Node

获取连线的起始节点

Returns:

twaver.Node:

起始节点

twaver.Link.getToAgent

() twaver.Node

获取连线的结束节点代理

Returns:

twaver.Node:

结束节点的代理

twaver.Link.getToNode

() twaver.Node

获取连线的结束节点

Returns:

twaver.Node:

结束节点

twaver.Link.isBundleAgent

() Boolean

判断是否为绑定连线的代理

Returns:

Boolean:

绑定连线的代理

twaver.Link.isLooped

() Boolean

判断是否为自环连线

Returns:

Boolean:

true为自环，否则为false。

twaver.Link.reverseBundleExpanded

() Boolean

反转连线捆绑的状态。如果这条link处于展开状态，调用这个方法，就会将所有和这条连线捆绑的links都合并，反之亦然。

Returns:

Boolean:

true为反转成功，否则为false

twaver.Link.setFromNode

(
  • fromNode
)

设置连线的起始节点

Parameters:

twaver.Link.setToNode

(
  • toNode
)

设置连线的结束节点

Parameters:

  • toNode Boolean

    结束节点

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

Properties

IClient

Boolean

Inherited from twaver.Data:

IClient标志，默认为true，表明这个对象是IClient类型。

IData

Boolean

Inherited from twaver.Data:

IData属性标志，默认为true，表明这个对象是IData的类型

IElement

Boolean

Inherited from twaver.Element:

是否为网元的标识，默认值为true

IS_INTERESTED_BUNDLE_STYLE

Object static

触发连线捆绑更改的相关属性样式。默认有：'link.bundle.enable'，'link.bundle.id'，'link.bundle.independent'

IStyle

Boolean

Inherited from twaver.Element:

判断这个网元是否具有样式的标识，默认为true。