API Docs for: TWaver HTML5 5.7.5
Show:

twaver.canvas.Network Class

Extends twaver.controls.View

画布对象

用指定的ElementBox构造Network，ElementBox是Network的数据容器，如果为null则twaver内部会创建一个新的ElementBox；而且在构造Network后，也可以用Network#setElementBox方法重新绑定一个新的ElementBox

Constructor

twaver.canvas.Network

(
  • [elementBox]
)
twaver.network.Network

Parameters:

  • [elementBox] twaver.ElementBox optional

    可选，默认为null，和Network关联的数据容器

Returns:

twaver.network.Network:

Example:

var box = new twaver.ElementBox(); var tree = new twaver.controls.Tree(box); var network = new twaver.network.Network(box);

Item Index

Methods

Methods

twaver.canvas.Network.addElementByInteraction

(
  • element
)

添加网元，并派发createElement类型的事件。CreateElementInteraction、CreateLinkInteraction、CreateShapeLinkInteraction和CreateShapeNodeInteraction会调用此方法

Parameters:

twaver.canvas.Network.addMarker

(
  • marker
)

添加标记

Parameters:

  • marker Object

    带paint方法的对象

twaver.canvas.Network.clearMarker

()

清空标记

twaver.canvas.Network.createElementUI

(
  • data
)

创建和指定Element关联的ElementUI，添加网元到和Network关联的ElementBox时会触发调用此方法，用户不需要调用此方法，但可以重载此方法

Parameters:

twaver.canvas.Network.dispose

()

销毁拓扑图

twaver.canvas.Network.getAlarmLabel

(
  • element
)
String

获取指定网元的告警冒泡文字内容，默认返回网元的最高新发告警数和别名，如果还有低级别的新发告警则前面带一个+号（比如+3C代表有3个严重告警，并且还有其他低级别新发告警），如果没有新发告警，则返回null

Parameters:

Returns:

String:

返回指定网元的告警冒泡文字内容

twaver.canvas.Network.getBackgroundImage

() HTMLImageElement

获取背景图片

Returns:

HTMLImageElement:

返回背景图片

twaver.canvas.Network.getBackgroundImageRect

() Object

获取背景图片边界

Returns:

Object:

返回背景图片边界

twaver.canvas.Network.getCanvasSize

() Object

获取拓扑图大小

Returns:

Object:

返回拓扑图大小

twaver.canvas.Network.getCurrentSubNetwork

() twaver.SubNetwork

获取当前子网，如果是最顶层子网则返回null

Returns:

twaver.SubNetwork:

返回当前子网，如果是最顶层子网则返回null

twaver.canvas.Network.getEditableFunction

() Function

获取网元可编辑过滤器，默认值为null，用于判断在编辑模式时是否可以更改节点大小（选中网元时周围有8个可拖拽的控制点），或者移动多边形、折线的点

Returns:

Function:

返回网元可编辑过滤器

twaver.canvas.Network.getEditLineColor

() String

获取创建连线时连线的颜色，默认值为twaver.Defaults.NETWORK_EDIT_LINE_COLOR

Returns:

String:

返回创建连线时连线的颜色

twaver.canvas.Network.getEditLineWidth

() Number

获取创建连线时连线的宽度，默认值为twaver.Defaults.NETWORK_EDIT_LINE_WIDTH

Returns:

Number:

返回创建连线时连线的宽度

twaver.canvas.Network.getEditPointFillColor

() String

获取编辑ShapeNode或ShapeLink时控制点的填充色，默认值为twaver.Defaults.NETWORK_EDIT_POINT_FILL_COLOR

Returns:

String:

返回编辑ShapeNode或ShapeLink时控制点的填充色

twaver.canvas.Network.getEditPointOutlineColor

() String

获取编辑ShapeNode或ShapeLink时控制点的边框颜色，默认值为twaver.Defaults.NETWORK_EDIT_POINT_OUTLINE_COLOR

Returns:

String:

返回编辑ShapeNode或ShapeLink时控制点的边框颜色

twaver.canvas.Network.getEditPointOutlineWidth

() Number

获取编辑ShapeNode或ShapeLink时控制点的边框宽度，默认值为twaver.Defaults.NETWORK_EDIT_POINT_OUTLINE_WIDTH

Returns:

Number:

返回编辑ShapeNode或ShapeLink时控制点的边框宽度

twaver.canvas.Network.getEditPointSize

() Number

获取编辑ShapeNode或ShapeLink时控制点的大小，默认值为twaver.Defaults.NETWORK_EDIT_POINT_SIZE

Returns:

Number:

返回编辑ShapeNode或ShapeLink时控制点的大小

twaver.canvas.Network.getElementAt

(
  • e
  • [selectable]
)
twaver.Element

获取指定坐标点或者当前鼠标下的网元

Parameters:

  • e Object

    可以为坐标点或者鼠标事件

  • [selectable] Boolean optional

    如果为true，则只返回可以被选择的网元，否则不可选中的网元也可以返回，可选，默认值为true

Returns:

twaver.Element:

返回坐标点或者当前鼠标下的网元

Example:

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

twaver.canvas.Network.getElementBox

() twaver.ElementBox

获取和Network绑定的ElementBox网元容器

Returns:

twaver.ElementBox:

返回和Network绑定的ElementBox网元容器

twaver.canvas.Network.getElementsAtRect

(
  • rect
  • [intersectMode]
  • [filter]
  • [selectable]
)
twaver.List

获取矩形区域包含或相交网元

Parameters:

  • rect Object

    矩形区域

  • [intersectMode] Boolean optional

    如果为true则只要和矩形区域相交的网元都返回，否则只返回矩形区域包含的网元，可选，默认值为false

  • [filter] Function optional

    过滤器, 可选, 默认值为null

  • [selectable] Boolean optional

    网元是否可选择，默认为true

Returns:

twaver.List:

返回矩形区域包含或相交网元

Example:

var elements = network.getElementsAtRect({x:0, y:0, width:100, height:100});

twaver.canvas.Network.getElementUI

(
  • data
)
twaver.network.ElementUI

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

Parameters:

Returns:

twaver.network.ElementUI:

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

twaver.canvas.Network.getElementUIFunction

() Function

获取网元视图生成器，用于创建和网元关联的网元视图，默认用element#getElementUIClass返回的类型创建和网元关联的网元视图 twaver.Defaults.ELEMENTUI_FUNCTION = function(network, element){ var clazz = element.getElementUIClass(); if (clazz) { return new clazz(network, element); } return null; }

Returns:

Function:

返回网元视图生成器

twaver.canvas.Network.getGroupChildrenRects

(
  • group
)
twaver.List

返回包含分组孩子视图区域的集合

Parameters:

Returns:

twaver.List:

返回包含孩子视图区域的集合

twaver.canvas.Network.getIconsColors

(
  • element
)
Array

获取指定网元的图标颜色数组，默认返回element#getStyle('icons.colors')

Parameters:

Returns:

Array:

返回指定网元的图标颜色数组

twaver.canvas.Network.getIconsNames

(
  • element
)
Array

获取指定网元的图标名称数组，默认返回element#getStyle('icons.names')

Parameters:

Returns:

Array:

返回指定网元的图标名称数组

twaver.canvas.Network.getInteractions

() Array

获取交互处理器集合，交互处理器用于设置Network相应哪些键盘和鼠标事件。

Returns:

Array:

返回交互处理器集合

twaver.canvas.Network.getLayerByElement

(
  • element
)
twaver.Layer

获取指定网元所在的层，默认为'default'层

Parameters:

Returns:

twaver.Layer:

返回指定网元所在的层

twaver.canvas.Network.getLazyMoveFillColor

() String

获取延迟移动网元时网元的填充色，默认值为twaver.Defaults.NETWORK_LAZYMOVE_FILL_COLOR

Returns:

String:

返回延迟移动网元时网元的填充色

twaver.canvas.Network.getLazyMoveOutlineColor

() String

获取延迟移动网元时网元的边框颜色，默认值为twaver.Defaults.NETWORK_LAZYMOVE_OUTLINE_COLOR

Returns:

String:

返回延迟移动网元时网元的边框颜色

twaver.canvas.Network.getLazyMoveOutlineWidth

() Number

获取延迟移动网元时网元的边框宽度，默认值为twaver.Defaults.NETWORK_LAZYMOVE_OUTLINE_WIDTH

Returns:

Number:

返回延迟移动网元时网元的边框宽度

twaver.canvas.Network.getLinkableFunction

() Function

获取节点是否可以连线的过滤器

Returns:

Function:

返回节点是否可以连线的过滤器

twaver.canvas.Network.getLinkFlowInterval

() String

获得LINK的流动间隔时间

Returns:

String:

返回Link的流动间隔时间

twaver.canvas.Network.getLinkFlowOffset

(
  • link
)
String

获得Link流动时的偏移量

Parameters:

  • link String

    Link实例

Returns:

String:

返回Link流动时的偏移量

twaver.canvas.Network.getLinkFlowStepping

(
  • link
)
String

获得Link流动时的步进量

Parameters:

  • link String

    Link实例

Returns:

String:

返回Link流动时的步进量

twaver.canvas.Network.getLinkHandlerLabel

(
  • link
)
String

获取指定连线捆绑后的标签，默认如果指定的连线是捆绑代理，则返回"+(" + link.getBundleCount() + ")"，否则返回null

Parameters:

Returns:

String:

返回指定连线捆绑后的标签

twaver.canvas.Network.getLinkPathFunction

() Function

获取连线路径生成函数

Returns:

Function:

返回连线路径生成函数

twaver.canvas.Network.getMovableFunction

() Function

获取网元可移动过滤器

Returns:

Function:

返回网元可移动过滤器

twaver.canvas.Network.getMovableSelectedElements

() twaver.List

获取可移动的被选中的网元集合

Returns:

twaver.List:

返回可移动的被选中的网元集合

twaver.canvas.Network.getMovableSelectedElementsRect

() Object

获取可移动的网元的区域

Returns:

Object:

返回可移动的网元的区域

twaver.canvas.Network.getPaddingBottom

() Number

获取下方内边距

Returns:

Number:

返回下方内边距，默认为0

twaver.canvas.Network.getPaddingRight

() Number

获取右边内边距

Returns:

Number:

返回右边内编辑，默认为0

twaver.canvas.Network.getPosition

(
  • position
  • obj
  • tarSize
  • xoffset
  • yoffset
)
Object

获取相对于网元指定位置的坐标，此方法常用于定位和网元相关的附件的位置

Parameters:

  • position String

    相对位置

  • obj Object

    获取位置时的相对网元或网元视图，类型为twaver.Element或者twaver.network.ElementUI

  • tarSize Object

    目标的大小，类型为包含width和height属性的Object对象

  • xoffset String

    x坐标偏移量

  • yoffset String

    y坐标偏移量

Returns:

Object:

返回包含x坐标和y坐标的Object对象

Example:

var node = new twaver.Node({name:'Node', location: {x:100, y:100}}); box.add(node); var position = network.getPosition('top.top', node, {width:10, height:10}, 0, 0); console.log(position.x, position.y); // output: 110 90

position可以为： hotspot from to topleft.topleft topleft.topright top.top topright.topleft topright.topright topleft top topright topleft.bottomleft topleft.bottomright top.bottom topright.bottomleft topright.bottomright left.left left left.right center right.left right right.right bottomleft.topleft bottomleft.topright bottom.top bottomright.topleft bottomright.topright bottomleft bottom bottomright bottomleft.bottomleft bottomleft.bottomright bottom.bottom bottomright.bottomleft bottomright.bottomright

twaver.canvas.Network.getRectSelectFilter

() Function

获取框选网元过滤器

Returns:

Function:

返回框选网元过滤器

twaver.canvas.Network.getResizeLineColor

() String

获取延迟改变网元大小时网元边框的颜色，默认值为twaver.Defaults.NETWORK_RESIZE_LINE_COLOR

Returns:

String:

返回延迟改变网元大小时网元边框的颜色

twaver.canvas.Network.getResizeLineWidth

() Number

获取延迟改变网元大小时网元边框的宽度，默认值为twaver.Defaults.NETWORK_RESIZE_LINE_WIDTH

Returns:

Number:

返回延迟改变网元大小时网元边框的宽度

twaver.canvas.Network.getResizePointFillColor

() String

获取改变网元大小时控制点的填充色，默认为twaver.Defaults.NETWORK_RESIZE_POINT_FILL_COLOR

Returns:

String:

返回改变网元大小时控制点的填充色

twaver.canvas.Network.getResizePointOutlineColor

() String

获取改变网元大小时控制点的边框颜色，默认值为twaver.Defaults.NETWORK_RESIZE_POINT_OUTLINE_COLOR

Returns:

String:

返回改变网元大小时控制点的边框颜色

twaver.canvas.Network.getResizePointOutlineWidth

() Number

获取改变网元大小时控制点的边框宽度，默认值为twaver.Defaults.NETWORK_RESIZE_POINT_OUTLINE_WIDTH

Returns:

Number:

返回改变网元大小时控制点的边框宽度

twaver.canvas.Network.getResizePointSize

() Number

获取更改网元大小的控制点的大小

Returns:

Number:

返回更改网元大小的控制点的大小

twaver.canvas.Network.getRootCanvas

() HTMLCanvasElement

获取主画布，网元视图绘制在主画布上

Returns:

HTMLCanvasElement:

返回主画布

twaver.canvas.Network.getRotatableFunction

() Function

获取网元是否可旋转过滤器

Returns:

Function:

网元是否可旋转过滤器

twaver.canvas.Network.getRotatePointFillColor

() String

获取旋转控制点的填充色

Returns:

String:

返回旋转控制点的填充色

twaver.canvas.Network.getRotatePointOffset

() Number

获取旋转控制点的偏移量

Returns:

Number:

返回旋转控制点的偏移量

twaver.canvas.Network.getRotatePointOutlineColor

() String

获取旋转控制点的边框颜色

Returns:

String:

返回旋转控制点的边框颜色

twaver.canvas.Network.getRotatePointOutlineWidth

() Number

获取旋转控制点的边框宽度

Returns:

Number:

返回旋转控制点的边框宽度

twaver.canvas.Network.getRotatePointSize

() Number

返回旋转控制点的大小

Returns:

Number:

旋转控制点的大小

twaver.canvas.Network.getRotateScaleFillColor

() String

获取旋转刻度填充色

Returns:

String:

返回旋转刻度填充色

twaver.canvas.Network.getRotateScaleFontColor

() String

获取旋转刻度文字字体颜色

Returns:

String:

旋转刻度文字字体颜色

twaver.canvas.Network.getRotateScaleHeight

() Number

获取旋转刻度高度

Returns:

Number:

旋转刻度高度

twaver.canvas.Network.getRotateScaleWidth

() Number

获取旋转刻度宽度

Returns:

Number:

返回旋转刻度宽度

twaver.canvas.Network.getScrollBarWidth

() Number

获取滚动条宽度

Returns:

Number:

返回滚动条宽度，默认为10

twaver.canvas.Network.getSelectFillColor

() String

获取框选时矩形框的填充色，默认值为twaver.Defaults.NETWORK_SELECT_FILL_COLOR

Returns:

String:

返回框选时矩形框的填充色

twaver.canvas.Network.getSelectionTolerance

() twaver.SelectionModel

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

Returns:

twaver.SelectionModel:

返回选择模型

twaver.canvas.Network.getSelectMode

() String

获取选择模式（当框选网元时，哪些网元会被选中），默认值为twaver.Defaults.NETWORK_SELECT_MODE（mix） 可选值为： mix 混合模式（从左上角往右下角框选时为contain模式，从右下角往左上角框选时为intersect模式） intersect 相交模式（只要和选择区域相交的网元都会被选中） contain 包含模式（只有完全被选择区域包含的网元会被选中）

Returns:

String:

返回选择模式

twaver.canvas.Network.getSelectOutlineColor

() String

获取框选时矩形框的边框颜色，默认值为twaver.Defaults.NETWORK_SELECT_OUTLINE_COLOR

Returns:

String:

返回框选时矩形框的边框颜色

twaver.canvas.Network.getSelectOutlineWidth

() String

获取框选时矩形框的边框宽度，默认值为twaver.Defaults.NETWORK_SELECT_OUTLINE_WIDTH

Returns:

String:

返回框选时矩形框的边框宽度

twaver.canvas.Network.getShadowColor

(
  • element
)
String

获得指定网元选中时的阴影颜色，如果网元的style属性shadow.color不为空，则返回style属性shadow.color的值，否则返回style属性select.color的值

Parameters:

Returns:

String:

返回指定网元选中时的阴影颜色

twaver.canvas.Network.getTopCanvas

() HTMLCanvasElement

获取上层画布，默认告警等附件画在上层画布上

Returns:

HTMLCanvasElement:

返回上层画布

twaver.canvas.Network.getViewRect

() Object

获取Network可见网元所占的区域

Returns:

Object:

返回包含x、y、width和height属性的Object对象

twaver.canvas.Network.getVisibleFunction

() Function

获取网元可见过滤器，Network通过可见过滤器判断每个网元是否可见

Returns:

Function:

返回网元可见过滤器

twaver.canvas.Network.handleElementBoxChange

(
  • e
)

ElementBox里网元添加、删除以及清空时的处理函数，用户不需要调用此方法，但可以重载此方法，添加自定义逻辑

Parameters:

  • e Object

    ElementBox里网元变化事件，包含kind和data属性

twaver.canvas.Network.handleElementBoxPropertyChange

()

ElementBox里网元的属性发生变化时的处理函数，用户不需要调用此方法，但可以重载此方法，添加自定义逻辑

twaver.canvas.Network.handleElementPropertyChange

(
  • e
)

ElementBox的属性发生变化时的处理函数，用户不需要调用此方法，但可以重载此方法，添加自定义逻辑

Parameters:

  • e Object

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

twaver.canvas.Network.handleIndexChange

(
  • c
)

ElementBox里网元的顺序发生变化时的处理函数，用户不需要调用此方法，但可以重载此方法，添加自定义逻辑

Parameters:

  • c Object

    网元顺序变化事件，包含element、oldIndex和newIndex属性

twaver.canvas.Network.handleLayerBoxChange

()

ElementBox的LayerBox里Layer添加、删除以及清空时的处理函数，用户不需要调用此方法，但可以重载此方法，添加自定义逻辑

twaver.canvas.Network.handleLayerHierarchyChange

()

ElementBox的LayerBox里Layer层次变化时的处理函数，用户不需要调用此方法，但可以重载此方法，添加自定义逻辑

twaver.canvas.Network.handleLayerPropertyChange

(
  • e
)

ElementBox的LayerBox里Layer属性变化时的处理函数，用户不需要调用此方法，但可以重载此方法，添加自定义逻辑

Parameters:

  • e Object

    LayerBox里Layer属性变化事件，包含kind和data属性

twaver.canvas.Network.handleSelectionChange

(
  • e
)

SelectionModel选择变化时的处理函数，用户不需要调用此方法，但可以重载此方法，添加自定义逻辑

Parameters:

  • e Object

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

twaver.canvas.Network.hasEditInteraction

() Boolean

获取是否包含编辑交互处理器

Returns:

Boolean:

如果包含编辑交互处理器，则返回ture，否则返回false

twaver.canvas.Network.hasMovableSelectedElements

() Boolean

判断是否包含选中的并且可移动的网元

Returns:

Boolean:

如果包含选中的并且可移动的网元，则返回true，否则返回false

twaver.canvas.Network.hitTest

(
  • e
)
Object

获取鼠标下或指定坐标下的网元视图对象或附件对象

Parameters:

  • e Object

    鼠标事件或坐标点

Returns:

Object:

返回鼠标下或指定坐标下的网元视图对象或附件对象

twaver.canvas.Network.invalidateCanvasSize

(
  • delay
)

无效画布大小

Parameters:

  • delay Number

    延迟时间，默认为300ms

twaver.canvas.Network.invalidateElementUI

(
  • element
  • [checkAttachments]
)

使指定网元的视图无效

Parameters:

  • element twaver.Element

    网元

  • [checkAttachments] Boolean optional

    如果为true，则使网元无效的同时使附件无效，否则不使附件无效，可选，默认为false

twaver.canvas.Network.invalidateElementUIs

(
  • [checkAttachments]
)

使所有网元的视图无效

Parameters:

  • [checkAttachments] Boolean optional

    如果为true，则使网元无效的同时使附件无效，否则不使附件无效，可选，默认为false

twaver.canvas.Network.invalidateElementVisibility

()

无效所有网元的可见性，当设置了visibleFunction，并且外部条件变动后，可以用此方法强制刷新所有网元是否可见

twaver.canvas.Network.invalidateSelectedElementUIs

(
  • [checkAttachments]
)

无效所有选中网元的视图

Parameters:

  • [checkAttachments] Boolean optional

    如果为true，则无效网元的同时无效附件，否则不无效附件，可选，默认为false

twaver.canvas.Network.isAutoValidateCanvasSize

() Boolean

获取是否自动计算画布大小

Returns:

Boolean:

返回是否自动计算画布大小

twaver.canvas.Network.isDebug

() Boolean

开启debug模式

Returns:

Boolean:

twaver.canvas.Network.isDoubleClickToEmptySubNetwork

() Boolean

获取是否能双击进入空的子网，默认值为twaver.Defaults.NETWORK_DOUBLECLICK_TO_EMPTYSUBNETWORK

Returns:

Boolean:

返回是否能双击进入空的子网

twaver.canvas.Network.isDoubleClickToGroupExpand

() Boolean

获取是否双击展开组，默认值为twaver.Defaults.NETWORK_DOUBLECLICK_TO_GROUPEXPAND

Returns:

Boolean:

返回是否双击展开组

twaver.canvas.Network.isDoubleClickToLinkBundle

() Boolean

获取是否双击捆绑连线，默认值为twaver.Defaults.NETWORK_DOUBLECLICK_TO_LINKBUNDLE

Returns:

Boolean:

返回是否双击捆绑连线

twaver.canvas.Network.isDoubleClickToSubNetwork

() Boolean

获取是否双击子网时进入子网，默认值为twaver.Defaults.NETWORK_DOUBLECLICK_TO_SUBNETWORK

Returns:

Boolean:

返回是否双击子网时进入子网

twaver.canvas.Network.isDoubleClickToUpSubNetwork

() Boolean

获取是否双击背景返回上一层子网，默认值为twaver.Defaults.NETWORK_DOUBLECLICK_TO_UPSUBNETWORK

Returns:

Boolean:

返回是否双击背景返回上一层子网

twaver.canvas.Network.isEditable

(
  • element
)
Boolean

判断指定网元是否可编辑，如果editableFunction返回false，则不可编辑；如果网元所在的层不可编辑，则不可编辑；否则可编辑

Parameters:

Returns:

Boolean:

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

twaver.canvas.Network.isEditingElement

() Boolean

获取是否正在编辑网元

Returns:

Boolean:

返回是否正在编辑网元

twaver.canvas.Network.isHScrollBarVisible

() Boolean

获取水平滚动条是否可见

Returns:

Boolean:

返回水平滚动条是否可见

twaver.canvas.Network.isKeyboardRemoveEnabled

() Boolean

获取是否允许用键盘Delete键删除选中网元，默认值为twaver.Defaults.NETWORK_KEYBOARD_REMOVE_ENABLED

Returns:

Boolean:

返回是否允许用键盘Delete键删除选中网元

twaver.canvas.Network.isKeyboardSelectEnabled

() Boolean

获取是否允许用键盘Ctrl+A键选择所有网元，默认值为twaver.Defaults.NETWORK_KEYBOARD_SELECT_ENABLED

Returns:

Boolean:

返回是否允许用键盘Ctrl+A键选择所有网元

twaver.canvas.Network.isLazyMoveAnimate

() Boolean

获取延迟移动网元时是否有动画效果，默认值为twaver.Defaults.NETWORK_LAZYMOVE_ANIMATE

Returns:

Boolean:

返回延迟移动网元时是否有动画效果

twaver.canvas.Network.isLazyMoveFill

() Boolean

获取延迟移动网元时轮廓是否填充，默认值为twaver.Defaults.NETWORK_LAZYMOVE_FILL

Returns:

Boolean:

返回延迟移动网元时轮廓是否填充

twaver.canvas.Network.isLimitElementInPositiveLocation

() Boolean

获取是否限制网元坐标不能为负

Returns:

Boolean:

返回是否限制网元坐标不能为负

twaver.canvas.Network.isLimitViewInCanvas

() Boolean

获取是否限制左上角，如果限制左上角，不能看到左上角以外的区域

Returns:

Boolean:

返回是否限制左上角，默认为true

twaver.canvas.Network.isLinkable

(
  • node
)
Boolean

获取指定节点是否可以创建连线

Parameters:

Returns:

Boolean:

返回指定节点是否可以创建连线

twaver.canvas.Network.isLinkFlowEnabled

() String

返回是否启用流动Link，默认是false

Returns:

String:

是否启用流动Link

twaver.canvas.Network.isMakeVisibleOnSelected

() Boolean

获取网元被选择时是否让其可见，默认值为twaver.Defaults.NETWORK_MAKE_VISIBLE_ON_SELECTED

Returns:

Boolean:

返回网元被选择时是否让其可见

twaver.canvas.Network.isMovable

(
  • element
)
Boolean

判断指定网元是否可移动，如果网元是Link，则不可移动；如果movableFunction返回false，则也不可移动；如果网元所在的层不可移动，则也不可移动；否则可以移动

Parameters:

Returns:

Boolean:

如果网元可移动，则返回true，否则返回false

twaver.canvas.Network.isMovingElement

() Boolean

获取是否正在移动网元

Returns:

Boolean:

返回是否正在移动网元

twaver.canvas.Network.isNoAgentLinkVisible

() Boolean

获取不是代理的连线是否可见，默认值为twaver.Defaults.NETWORK_NO_AGENT_LINK_VISIBLE

Returns:

Boolean:

返回不是代理的连线是否可见

twaver.canvas.Network.isRectSelectEnabled

() Boolean

获取是否允许框选网元

Returns:

Boolean:

如果允许框选网元, 返回true, 否则返回false

twaver.canvas.Network.isResizeAnimate

() Boolean

获取改变网元大小时是否有动画效果，默认值为twaver.Defaults.NETWORK_RESIZE_ANIMATE

Returns:

Boolean:

返回改变网元大小时是否有动画效果

twaver.canvas.Network.isRotatable

(
  • element
)
Boolean

获取指定网元是否可旋转

Parameters:

Returns:

Boolean:

返回指定网元是否可旋转

twaver.canvas.Network.isRotatingElement

() Boolean

获取是否正在旋转网元

Returns:

Boolean:

返回是否正在旋转网元

twaver.canvas.Network.isScrollBarVisible

() Boolean

获取滚动条是否可见

Returns:

Boolean:

返回滚动条是否可见

twaver.canvas.Network.isSelectingElement

() Boolean

获取是否正在选择网元

Returns:

Boolean:

返回是否正在选择网元

twaver.canvas.Network.isSendToTopOnSelected

() Boolean

获取网元被选中后是否置顶，默认值为twaver.Defaults.NETWORK_SENDTOTOP_ON_SELECTED

Returns:

Boolean:

返回网元被选中后是否置顶

twaver.canvas.Network.isShowRotateScale

() Boolean

获取是否显示旋转网元时的刻度

Returns:

Boolean:

返回是否显示旋转网元时的刻度

twaver.canvas.Network.isShowShadowInEdit

() Boolean

获取是否在编辑状态显示阴影

Returns:

Boolean:

是否在编辑状态显示阴影

twaver.canvas.Network.isSubNetworkAnimate

() Boolean

获取进入下一层子网或返回上一层子网时是否有动画效果，默认值为twaver.Defaults.NETWORK_SUBNETWORK_ANIMATE

Returns:

Boolean:

返回进入下一层子网或返回上一层子网时是否有动画效果

twaver.canvas.Network.isToolTipEnabled

() Boolean

获取是否让提示信息生效，默认值为twaver.Defaults.NETWORK_TOOLTIP_ENABLED

Returns:

Boolean:

返回是否让提示信息生效

twaver.canvas.Network.isTransparentSelectionEnable

() String

获取网元透明部分是否可选

Returns:

String:

网元透明部分是否可选

twaver.canvas.Network.isVisible

(
  • element
  • visibleFunction
  • defaultLayer
)
Boolean

获取指定的网元是否可见，如果可见过滤器visibleFunction返回false，则不可见；如果网元所在的层不可见，则网元不可见；否则网元可见

Parameters:

  • element twaver.Element

    网元

  • visibleFunction String
  • defaultLayer String

Returns:

Boolean:

如果指定网元可见，则返回true，否则返回false

twaver.canvas.Network.isVScrollBarVisible

() Boolean

获取垂直滚动条是否可见

Returns:

Boolean:

返回垂直滚动条是否可见，默认为true

twaver.canvas.Network.makeVisible

(
  • element
)

滚动水平和垂直滚动条，让指定网元可见

Parameters:

twaver.canvas.Network.moveSelectedElements

(
  • xoffset
  • yoffset
  • [animate]
  • [finishFunction]
)

将选中的网元移动指定偏移量，移动时可以设置是否有动画效果，而且能指定移动结束后执行的动作

Parameters:

  • xoffset Number

    x坐标偏移量

  • yoffset Number

    y坐标偏移量

  • [animate] Boolean optional

    移动时是否有动画效果，可选，默认为false

  • [finishFunction] Function optional

    回调函数，移动结束后执行的动作，可选，默认为null

twaver.canvas.Network.onClickBackground

(
  • e
)

点击画布背景事件

Parameters:

  • e MouseEvent

    鼠标事件

twaver.canvas.Network.onClickElement

(
  • element
  • e
)

点击网元监听事件

Parameters:

twaver.canvas.Network.onDoubleClickBackground

(
  • e
)

双击画布背景事件

Parameters:

  • e MouseEvent

    鼠标事件

twaver.canvas.Network.onDoubleClickElement

(
  • element
  • e
)

双击网元的监听事件

Parameters:

twaver.canvas.Network.onLongClickBackground

(
  • e
)

长按背景监听事件

Parameters:

  • e MouseEvent

    鼠标事件

twaver.canvas.Network.onLongClickElement

(
  • element
  • e
)

长按网元监听事件

Parameters:

twaver.canvas.Network.onMouseEnter

(
  • element
  • e
)

进入网元监听事件

Parameters:

twaver.canvas.Network.onMouseLeave

(
  • element
  • e
)

离开网元监听事件

Parameters:

twaver.canvas.Network.onMouseMove

(
  • element
  • e
)

离开网元监听事件

Parameters:

twaver.canvas.Network.onShareSelectionModelChanged

()

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

twaver.canvas.Network.paintBottom

(
  • ctx
)

绘制最底层元素

Parameters:

  • ctx CanvasRenderingContext2D

    画布上下文

twaver.canvas.Network.paintMarker

(
  • ctx
)

回去标记

Parameters:

  • ctx CanvasRenderingContext2D

    画布上下文

twaver.canvas.Network.paintRoot

()

绘制所有网元视图

twaver.canvas.Network.paintTopCanvas

()

绘制上层画布

twaver.canvas.Network.removeMarker

(
  • marker
)

删除标记

Parameters:

  • marker Object

    带paint方法的对象

twaver.canvas.Network.repaintTopCanvas

()

重绘上层画布

twaver.canvas.Network.sendToTop

(
  • element
)

将指定网元置顶，显示在所有网元的最上面，遮盖其他网元，但也受网元所在的层的制约，还有父子关系以及跟随关系的制约；如果sendToTopOnSelected为true，则点击网元时会调用此方法

Parameters:

twaver.canvas.Network.setAutoValidateCanvasSize

(
  • v
)

设置是否自动计算画布大小

Parameters:

  • v Boolean

    是否自动计算画布大小

twaver.canvas.Network.setBackgroundImage

(
  • backgroundImage
)

设置背景图片

Parameters:

  • backgroundImage HTMLImageElement

    背景图片

twaver.canvas.Network.setCreateElementInteractions

(
  • [type]
)

设置当前交互模式为创建网元模式，在Network上单击时，会创建指定类型的网元

Parameters:

  • [type] Function optional

    网元类型，可选，默认值为twaver.Node

twaver.canvas.Network.setCreateLinkInteractions

(
  • [type]
)

设置当前交互模式为创建连线模式，在Network上单击任意网元设置连线的开始节点，再次点击任意网元设置连线的结束节点

Parameters:

  • [type] Function optional

    连线类型，可选，默认值为twaver.Link

twaver.canvas.Network.setCreateShapeLinkInteractions

(
  • [type]
)

设置当前交互模式为创建折线模式，在Network上单击任意网元设置折线的开始节点，多次点击不同的背景位置设置折线的points属性，再次点击任意网元设置折线的结束节点

Parameters:

  • [type] Function optional

    折线类型，可选，默认值为twaver.ShapeLink

twaver.canvas.Network.setCreateShapeNodeInteractions

(
  • [type]
)

设置当前交互模式为创建多边形模式，在Network上多次点击不同位置设置多边形的points属性，最后双击结束

Parameters:

  • [type] Function optional

    多边形类型，可选，默认值为twaver.ShapeNode

twaver.canvas.Network.setCurrentSubNetwork

(
  • currentSubNetwork
  • [animate]
  • [finishFunction]
)

将当前子网设置为指定子网，并且可以设置是否有动画效果，而且能指定设置当前子网结束后执行的动作

Parameters:

  • currentSubNetwork twaver.SubNetwork

    子网

  • [animate] Boolean optional

    是否有动画效果

  • [finishFunction] Function optional

    设置当前子网结束后的回调函数，可选，默认为null

twaver.canvas.Network.setDebug

(
  • v
)

设置debug模式

Parameters:

  • v Boolean

    调试

twaver.canvas.Network.setDefaultInteractions

(
  • [lazyMode]
)

设置交互模式为默认交互模式，包含选择交互处理器SelectInteraction（处理框选或选择网元）、移动交互处理器MoveInteraction（处理移动网元）和默认交互处理器DefaultInteraction（处理展开或合并组、进入或返回子网、合并或展开连线捆绑、删除或全选网元等）

Parameters:

  • [lazyMode] Boolean optional

    是否使用延迟模式，可选、默认为false

twaver.canvas.Network.setDoubleClickToEmptySubNetwork

(
  • v
)

设置是否能双击进入空的子网

Parameters:

  • v Boolean

    是否能双击进入空的子网

twaver.canvas.Network.setDoubleClickToGroupExpand

(
  • v
)

设置是否双击展开组

Parameters:

  • v Boolean

    是否能双击展开组

twaver.canvas.Network.setDoubleClickToLinkBundle

(
  • v
)

设置是否双击捆绑连线

Parameters:

  • v Boolean

    是否双击捆绑连线

twaver.canvas.Network.setDoubleClickToSubNetwork

(
  • v
)

设置是否双击子网时进入子网

Parameters:

  • v Boolean

    是否双击子网时进入子网

twaver.canvas.Network.setDoubleClickToUpSubNetwork

(
  • v
)

设置是否双击背景返回上一层子网

Parameters:

  • v Boolean

    是否双击背景返回上一层子网

twaver.canvas.Network.setEditableFunction

(
  • value
)

设置网元可编辑过滤器，默认值为null，用于判断在编辑模式时是否可以更改节点大小（选中网元时周围有8个可拖拽的控制点），或者移动多边形、折线的点

Parameters:

  • value Function

    网元可编辑过滤器

Example:

network.setEditInteractions(); network.setEditableFunction(function (element) { return element.getName() === 'From'; });

twaver.canvas.Network.setEditingElement

(
  • v
)

设置是否正在编辑网元

Parameters:

  • v Boolean

    是否正在编辑网元

twaver.canvas.Network.setEditInteractions

(
  • [lazyMode]
)

设置交互模式为编辑交互模式，包含选择交互处理器SelectInteraction（处理框选或选择网元）、编辑处理器EditInteraction（处理改变网元大小）、移动交互处理器MoveInteraction（处理移动网元）和默认交互处理器DefaultInteraction（处理展开或合并组、进入或返回子网、合并或展开连线捆绑、删除或全选网元等）

Parameters:

  • [lazyMode] Boolean optional

    是否使用延迟模式，可选、默认为false

twaver.canvas.Network.setEditLineColor

(
  • v
)

设置创建连线时连线的颜色

Parameters:

  • v String

    创建连线时连线的颜色

twaver.canvas.Network.setEditLineWidth

(
  • v
)

设置创建连线时连线的宽度

Parameters:

  • v Number

    创建连线时连线的宽度

twaver.canvas.Network.setEditPointFillColor

(
  • v
)

设置编辑ShapeNode或ShapeLink时控制点的填充色

Parameters:

  • v String

    编辑ShapeNode或ShapeLink时控制点的填充色

twaver.canvas.Network.setEditPointOutlineColor

(
  • v
)

设置编辑ShapeNode或ShapeLink时控制点的边框颜色

Parameters:

  • v String

    编辑ShapeNode或ShapeLink时控制点的边框颜色

twaver.canvas.Network.setEditPointOutlineWidth

(
  • v
)

设置编辑ShapeNode或ShapeLink时控制点的边框宽度

Parameters:

  • v Number

    编辑ShapeNode或ShapeLink时控制点的边框宽度

twaver.canvas.Network.setEditPointSize

(
  • v
)

设置编辑ShapeNode或ShapeLink时控制点的大小

Parameters:

  • v Number

    编辑ShapeNode或ShapeLink时控制点的大小

twaver.canvas.Network.setElementBox

(
  • elementBox
)

设置和Network绑定的ElementBox网元容器，Network构造时可以设置ElementBox（内部创建一个新的ElementBox），也可以构造完后再设置ElementBox

Parameters:

twaver.canvas.Network.setElementUIFunction

(
  • value
)

设置网元视图生成器，用于创建和网元关联的网元视图，默认用element#getElementUIClass返回的类型创建和网元关联的网元视图 twaver.Defaults.ELEMENTUI_FUNCTION = function(network, element){ var clazz = element.getElementUIClass(); if (clazz) { return new clazz(network, element); } return null; }

Parameters:

  • value Function

    网元视图生成器

twaver.canvas.Network.setHasEditInteraction

(
  • value
)

设置是否包含编辑交互处理器

Parameters:

  • value Boolean

    是否包含编辑交互处理器

twaver.canvas.Network.setHScrollBarVisible

(
  • v
)

设置水平滚动条是否可见

Parameters:

  • v Boolean

    水平滚动条是否可见

twaver.canvas.Network.setInteractions

(
  • interactions
)

设置交互处理器，交互处理器用于设置Network相应哪些键盘和鼠标事件。

Parameters:

  • interactions twaver.List

    包含交互处理器的集合

Example:

network.setInteractions([ new twaver.network.interaction.SelectInteraction(network), new twaver.network.interaction.EditInteraction(network), new twaver.network.interaction.MoveInteraction(network), new twaver.network.interaction.DefaultInteraction(network) ]);

twaver.canvas.Network.setKeyboardRemoveEnabled

(
  • v
)

设置是否允许用键盘Delete键删除选中网元

Parameters:

  • v Boolean

    是否允许用键盘Delete键删除选中网元

twaver.canvas.Network.setKeyboardSelectEnabled

(
  • v
)

设置是否允许用键盘Ctrl+A键选择所有网元

Parameters:

  • v Boolean

    是否允许用键盘Ctrl+A键选择所有网元

twaver.canvas.Network.setLazyMoveAnimate

(
  • v
)

设置延迟移动网元时是否有动画效果

Parameters:

  • v Boolean

    延迟移动网元时是否有动画效果

twaver.canvas.Network.setLazyMoveFill

(
  • v
)

设置延迟移动网元时轮廓是否填充

Parameters:

  • v Boolean

    延迟移动网元时轮廓是否填充

twaver.canvas.Network.setLazyMoveFillColor

(
  • v
)

设置延迟移动网元时网元的填充色

Parameters:

  • v String

    延迟移动网元时网元的填充色

twaver.canvas.Network.setLazyMoveOutlineColor

(
  • v
)

设置延迟移动网元时网元的填充色

Parameters:

  • v String

    延迟移动网元时网元的填充色

twaver.canvas.Network.setLazyMoveOutlineWidth

(
  • v
)

设置延迟移动网元时网元的边框宽度

Parameters:

  • v Number

    延迟移动网元时网元的边框宽度

twaver.canvas.Network.setLimitElementInPositiveLocation

(
  • v
)

设置是否限制网元坐标不能为负

Parameters:

  • v Boolean

    是否限制网元坐标不能为负

twaver.canvas.Network.setLimitViewInCanvas

(
  • v
)

设置是否限制左上角

Parameters:

  • v Boolean

    是否限制左上角

twaver.canvas.Network.setLinkableFunction

(
  • value
)

设置节点是否可以连线的过滤器

Parameters:

  • value Function

    节点是否可以连线的过滤器

twaver.canvas.Network.setLinkFlowEnabled

(
  • value
)

设置是否启用流动Link，默认是false

Parameters:

  • value String

    是否启用流动Link

twaver.canvas.Network.setLinkFlowInterval

(
  • value
)

设置LINK的流动间隔时间

Parameters:

  • value String

    Link的流动间隔时间(毫秒)

twaver.canvas.Network.setLinkPathFunction

(
  • value
)

设置连线路径生成函数function (linkUI, defaultPoints)

Parameters:

  • value Function

    连线路径生成函数

twaver.canvas.Network.setMagnifyInteractions

()

设置交互模式为放大镜模式

twaver.canvas.Network.setMakeVisibleOnSelected

(
  • v
)

设置网元被选择时是否让其可见

Parameters:

  • v Boolean

    网元被选择时是否让其可见

twaver.canvas.Network.setMovableFunction

(
  • v
)

设置网元可移动过滤器，用于判断网元是否可以移动，如果网元是Link，则不可移动；如果movableFunction返回false，则也不可移动；如果网元所在的层不可移动，则也不可移动；否则可以移动

Parameters:

  • v Function

    网元可移动过滤器

Example:

network.setMovableFunction(function (element) { return element.getName() === 'From'; });

twaver.canvas.Network.setMovingElement

(
  • v
)

设置是否正在移动网元

Parameters:

  • v Boolean

    是否正在移动网元

twaver.canvas.Network.setMSTouchInteractions

()

设置交互模式为微软触摸交互模式

twaver.canvas.Network.setNoAgentLinkVisible

(
  • v
)

设置不是代理的连线是否可见

Parameters:

  • v Boolean

    不是代理的连线是否可见

twaver.canvas.Network.setPaddingBottom

(
  • v
)

设置下方内边距

Parameters:

  • v Number

    下方内边距

twaver.canvas.Network.setPaddingRight

(
  • v
)

设置右边内边距

Parameters:

  • v Number

    右边内边距

twaver.canvas.Network.setPanInteractions

()

设置交互模式为手抓图交互模式，包含手抓图交互处理器PanInteraction（处理垂直或水平滚动滚动条）和默认交互处理器DefaultInteraction（处理展开或合并组、进入或返回子网、合并或展开连线捆绑、删除或全选网元等）

twaver.canvas.Network.setRectSelectEnabled

(
  • v
)

设置是否允许框选网元

Parameters:

  • v Boolean

    是否允许框选网元

twaver.canvas.Network.setRectSelectFilter

(
  • v
)

设置框选网元过滤器

Parameters:

  • v Function

    框选网元过滤器

twaver.canvas.Network.setResizeAnimate

(
  • v
)

设置改变网元大小时是否有动画效果

Parameters:

  • v Boolean

    改变网元大小时是否有动画效果

twaver.canvas.Network.setResizeLineColor

(
  • v
)

设置延迟改变网元大小时网元边框的颜色

Parameters:

  • v String

    延迟改变网元大小时网元边框的颜色

twaver.canvas.Network.setResizeLineWidth

(
  • v
)

设置延迟改变网元大小时网元边框的宽度

Parameters:

  • v Number

    延迟改变网元大小时网元边框的宽度

twaver.canvas.Network.setResizePointFillColor

(
  • v
)

设置改变网元大小时控制点的填充色

Parameters:

  • v String

    改变网元大小时控制点的填充色

twaver.canvas.Network.setResizePointOutlineColor

(
  • v
)

设置改变网元大小时控制点的边框颜色

Parameters:

  • v String

    改变网元大小时控制点的边框颜色

twaver.canvas.Network.setResizePointOutlineWidth

(
  • v
)

设置改变网元大小时控制点的边框宽度

Parameters:

  • v Number

    改变网元大小时控制点的边框宽度

twaver.canvas.Network.setResizePointSize

(
  • v
)

设置更改网元大小的控制点的大小

Parameters:

  • v Number

    更改网元大小的控制点的大小

twaver.canvas.Network.setRotatableFunction

(
  • value
)

设置网元是否可旋转过滤器

Parameters:

  • value Function

    网元是否可旋转过滤器

twaver.canvas.Network.setRotatePointFillColor

(
  • v
)

设置旋转控制点的填充色

Parameters:

  • v String

    旋转控制点的填充色

twaver.canvas.Network.setRotatePointOffset

(
  • v
)

设置旋转控制点的偏移量

Parameters:

  • v Number

    旋转控制点的偏移量

twaver.canvas.Network.setRotatePointOutlineColor

(
  • v
)

设置旋转控制点的边框颜色

Parameters:

  • v String

    旋转控制点的边框颜色

twaver.canvas.Network.setRotatePointOutlineWidth

(
  • v
)

设置旋转控制点的边框宽度

Parameters:

  • v Number

    旋转控制点的边框宽度

twaver.canvas.Network.setRotatePointSize

(
  • v
)

设置旋转控制点的大小

Parameters:

  • v Number

    旋转控制点的大小

twaver.canvas.Network.setRotateScaleFillColor

(
  • v
)

设置旋转刻度填充色

Parameters:

  • v String

    旋转刻度填充色

twaver.canvas.Network.setRotateScaleFontColor

(
  • v
)

设置旋转刻度文字字体颜色

Parameters:

  • v String

    旋转刻度文字字体颜色

twaver.canvas.Network.setRotateScaleHeight

(
  • v
)

设置旋转刻度高度

Parameters:

  • v Number

    旋转刻度高度

twaver.canvas.Network.setRotateScaleWidth

(
  • v
)

设置旋转刻度宽度

Parameters:

  • v Number

    旋转刻度宽度

twaver.canvas.Network.setRotatingElement

(
  • v
)

设置正在旋转的节点

Parameters:

twaver.canvas.Network.setScrollBarVisible

(
  • v
)

设置滚动条是否可见

Parameters:

  • v Number

    滚动条是否可见

twaver.canvas.Network.setScrollBarWidth

(
  • v
)

设置滚动条宽度

Parameters:

  • v Number

    滚动条宽度

twaver.canvas.Network.setSelectFillColor

(
  • v
)

设置框选时矩形框的填充色

Parameters:

  • v String

    框选时矩形框的填充色

twaver.canvas.Network.setSelectingElement

(
  • v
)

设置是否正在框选网元

Parameters:

  • v Boolean

    是否正在框选网元

twaver.canvas.Network.setSelectionTolerance

(
  • v
)

设置选择公差大小

Parameters:

  • v String

    选择公差大小

twaver.canvas.Network.setSelectMode

(
  • v
)

设置选择模式（当框选网元时，哪些网元会被选中），默认值为twaver.Defaults.NETWORK_SELECT_MODE（mix） 可选值为： mix 混合模式（从左上角往右下角框选时为contain模式，从右下角往左上角框选时为intersect模式） intersect 相交模式（只要和选择区域相交的网元都会被选中） contain 包含模式（只有完全被选择区域包含的网元会被选中）

Parameters:

  • v String

    选择模式

twaver.canvas.Network.setSelectOutlineColor

(
  • v
)

设置框选时矩形框的边框颜色

Parameters:

  • v String

    框选时矩形框的边框颜色

twaver.canvas.Network.setSelectOutlineWidth

(
  • v
)

设置框选时矩形框的边框宽度

Parameters:

  • v String

    框选时矩形框的边框宽度

twaver.canvas.Network.setSendToTopOnSelected

(
  • v
)

设置网元被选中后是否置顶

Parameters:

  • v Boolean

    网元被选中后是否置顶

twaver.canvas.Network.setShowRotateScale

(
  • v
)

设置是否显示旋转网元时的刻度

Parameters:

  • v Boolean

    是否显示旋转网元时的刻度

twaver.canvas.Network.setShowShadowInEdit

(
  • v
)

Parameters:

  • v Boolean

twaver.canvas.Network.setSubNetworkAnimate

(
  • v
)

设置进入下一层子网或返回上一层子网时是否有动画效果

Parameters:

  • v Boolean

    进入下一层子网或返回上一层子网时是否有动画效果

twaver.canvas.Network.setToolTipEnabled

(
  • value
)

设置是否让提示信息生效

Parameters:

  • value Boolean

    是否让提示信息生效

twaver.canvas.Network.setTouchInteractions

()

设置当前交互模式为触摸模式，只响应触摸事件，包含触摸交互处理器TouchInteraction（处理触摸事件）

twaver.canvas.Network.setTransparentSelectionEnable

(
  • v
)

设置网元透明部分是否可选，如不可选，则只有点击网元可视部分才能选中网元

Parameters:

  • v String

    网元透明部分是否可选

twaver.canvas.Network.setViewOffSet

(
  • xoff
  • yoff
)

设置视图偏移量

Parameters:

  • xoff Number

    x坐标

  • yoff Number

    y坐标

twaver.canvas.Network.setViewRect

(
  • x
  • y
  • w
  • h
)

设置视图区域

Parameters:

  • x Number

    x坐标

  • y Number

    y坐标

  • w Number

    宽度

  • h Number

    高度

twaver.canvas.Network.setVisibleFunction

(
  • value
)

设置网元可见过滤器，用于判断指定的网元是否可见，如果可见过滤器visibleFunction返回false，则不可见；如果网元所在的层不可见，则网元不可见；否则网元可见

Parameters:

  • value Function

    网元可见过滤器

Example:

network.setVisibleFunction(function (element) { return !(element instanceof twaver.Link); });

twaver.canvas.Network.setVScrollBarVisible

(
  • v
)

设置垂直滚动条是否可见

Parameters:

  • v Boolean

    垂直滚动条是否可见

twaver.canvas.Network.toCanvas

(
  • w
  • h
  • [c]
)
HTMLCanvasElement

从Network生成指定大小的Canvas元素，用于生成缩略图

Parameters:

  • w Number

    要生成的Canvas元素的宽度

  • h Number

    要生成的Canvas元素的高度

  • [c] HTMLCanvasElement optional

    目标Canvas元素，可选，默认为null，如果为null，则创建新的Canvas元素，否则使用此Canvas元素

Returns:

HTMLCanvasElement:

返回Canvas元素

twaver.canvas.Network.toCanvasByRegion

(
  • rect
  • scale
  • [c]
)
HTMLCanvasElement

从Network的指定区域生成指定比例的Canvas元素，用于生成缩略图

Parameters:

  • rect Object

    包含x、y、width和height属性的Object对象

  • scale Number

    缩放比例

  • [c] HTMLCanvasElement optional

    目标Canvas元素，可选，默认为null，如果为null，则创建新的Canvas元素，否则使用此Canvas元素

Returns:

HTMLCanvasElement:

返回Canvas元素

twaver.canvas.Network.upSubNetwork

(
  • [animate]
  • [finishFunction]
)

返回上一层子网，可以设置是否使用动画效果，还可以指定返回结束后执行的动作

Parameters:

  • [animate] Boolean optional

    是否使用动画效果，可选，默认为false

  • [finishFunction] Function optional

    返回上一层子网结束后执行的回调函数，可选，默认为null

twaver.canvas.Network.validateCanvasSize

()

计算画布大小

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