API Docs for: TWaver HTML5 5.7.5
Show:

twaver.network.HTMLLabelAttachment Class

HTML标签附件

用于显示网元名称,与LabelAttachment相同,区别是可以显示HTML元素

Constructor

twaver.network.HTMLLabelAttachment

(
  • elementUI
  • [showInAttachmentDiv]
)
twaver.network.HTMLLabelAttachment

Parameters:

  • elementUI twaver.network.ElementUI

    网元视图

  • [showInAttachmentDiv] Boolean optional

    是否显示在附件层,可选,默认为false

Item Index

Methods

Methods

twaver.network.Attachment.dispose

()

Inherited from twaver.network.Attachment:

销毁附件

twaver.network.Attachment.getAlpha

() Number

Inherited from twaver.network.Attachment:

获取附件透明度,默认值为1

Returns:

Number:

返回附件透明度,默认值为1

twaver.network.Attachment.getClassName

() String

Inherited from twaver.network.Attachment:

获取字符串类名

Returns:

String:

返回类名

twaver.network.Attachment.getElement

() twaver.Element

Inherited from twaver.network.Attachment:

获取和附件关联的网元

Returns:

twaver.Element:

返回和附件关联的网元

twaver.network.Attachment.getElementUI

() twaver.network.ElementUI

Inherited from twaver.network.Attachment:

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

Returns:

twaver.network.ElementUI:

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

twaver.network.Attachment.getFont

(
  • styleProp
)
String

Inherited from twaver.network.Attachment:

获取附件的字体

Parameters:

  • styleProp String

    样式名称

Returns:

String:

返回附件的字体

twaver.network.Attachment.getNetwork

() twaver.network.Network

Inherited from twaver.network.Attachment:

获取和附件关联的拓扑

Returns:

twaver.network.Network:

返回和附件关联的拓扑

twaver.network.Attachment.getStyle

(
  • styleProp
)
Object

Inherited from twaver.network.Attachment:

获取指定样式的值,封装了Element#getStyle方法

Parameters:

  • styleProp String

    样式名称

Returns:

Object:

返回指定样式的值

twaver.network.Attachment.getView

() HTMLDivElement

Inherited from twaver.network.Attachment:

获取附件的视图div元素

Returns:

HTMLDivElement:

返回附件的视图div元素

twaver.network.Attachment.getViewRect

() Object

Inherited from twaver.network.Attachment:

获取附件视图的位置及大小,值为包含x、y、width和height属性的Object对象

Returns:

Object:

返回附件视图的位置及大小,值为包含x、y、width和height属性的Object对象

twaver.network.Attachment.hit

(
  • x
  • y
)
Boolean

Inherited from twaver.network.Attachment:

命中测试,判断点击指定坐标点是否能选中附件

Parameters:

  • x Number

    x坐标

  • y Number

    y坐标

Returns:

Boolean:

如果点击指定坐标能选中附件,则返回true,否者返回false

twaver.network.Attachment.intersects

(
  • rect
)
Boolean

Inherited from twaver.network.Attachment:

判断附件视图区域是否包含指定区域

Parameters:

  • rect Object

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

Returns:

Boolean:

如果附件视图区域包含指定区域,则返回true,否者返回false

twaver.network.Attachment.isShowInAttachmentDiv

() Boolean

Inherited from twaver.network.Attachment:

获取附件视图是否显示在附件层中

Returns:

Boolean:

返回附件视图是否显示在附件层中

twaver.network.Attachment.updateMeasure

()

Inherited from twaver.network.Attachment:

更新附件视图,一般子类会重载此方法,以更新附件视图

twaver.network.BasicAttachment.calculateMeasure

()

调用updateMeasure时,会调用此方法,用于重新计算contentRect和roundRect

twaver.network.BasicAttachment.getCap

() String

获取附件画线时, 线条两端的样式, 默认值为twaver.Defaults.ATTACHMENT_CAP(butt), 可选值为butt(无端点),round(圆头端点)或 square(方头端点)

Returns:

String:

返回画线时线条两端的样式

twaver.network.BasicAttachment.getContent

() HTMLElement

获取附件内容

Returns:

HTMLElement:

返回附件内容

twaver.network.BasicAttachment.getContentHeight

() Number

获取附件内容高度,默认值为twaver.Defaults.ATTACHMENT_CONTENT_HEIGHT(20)

Returns:

Number:

返回附件内容高度

twaver.network.BasicAttachment.getContentRect

() Object

获取附件内容区域

Returns:

Object:

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

twaver.network.BasicAttachment.getContentWidth

() Number

获取附件内容宽度,默认值为twaver.Defaults.ATTACHMENT_CONTENT_HEIGHT(30)

Returns:

Number:

返回附件内容宽度

twaver.network.BasicAttachment.getCornerRadius

() Number

获取附件圆角半径,默认值为twaver.Defaults.ATTACHMENT_CORNER_RADIUS(5)

Returns:

Number:

返回附件圆角半径

twaver.network.BasicAttachment.getDirection

() String

获取附件箭头的显示方位,一般用于告警冒泡,默认值为twaver.Defaults.ATTACHMENT_DIRECTION(right),可选值为: aboveleft 附件箭头在上左角 aboveright 附件箭头在上右角 belowleft 附件箭头在下左角 belowright 附件箭头在下右角 leftabove 附件箭头在左上角 leftbelow 附件箭头在左下角 rightabove 附件箭头右右上角 rightbelow 附件箭头在右下角 above 附件箭头在上边 below 附件箭头在下边 left 附件箭头在左边 right 附件箭头在右边

Returns:

String:

返回附件箭头的显示方位

twaver.network.BasicAttachment.getFillColor

() String

获取附件填充颜色,默认值为twaver.Defaults.ATTACHMENT_FILL_COLOR(#000000)

Returns:

String:

返回附件填充颜色

twaver.network.BasicAttachment.getGradient

() String

获取附件渐进色填充样式,默认值为twaver.Defaults.ATTACHMENT_GRADIENT(null),null表示不使用填充渐进色,可选值为: linear.east, linear.north, linear.northeast, linear.northwest, linear.south, linear.southeast, linear.southwest, linear.west, none, radial.center, radial.east, radial.north, radial.northeast, radial.northwest, radial.south, radial.southeast, radial.southwest, radial.west, spread.antidiagonal, spread.diagonal, spread.east, spread.horizontal, spread.north, spread.south, spread.vertical, spread.west

Returns:

String:

返回附件渐进色填充样式

twaver.network.BasicAttachment.getGradientColor

() String

获取附件填充渐进色,默认值为twaver.Defaults.ATTACHMENT_GRADIENT_COLOR(#FFFFFF)

Returns:

String:

返回附件填充渐进色

twaver.network.BasicAttachment.getJoin

() String

获取附件画线时,线条连接点样式,默认值为twaver.Defaults.ATTACHMENT_JOIN(miter),可选值为bevel(斜角连接)round(圆角连接)和miter(尖角连接)

Returns:

String:

返回附件画线时,线条连接点样式

twaver.network.BasicAttachment.getOutlineColor

() String

获取附件边框颜色,默认值为twaver.Defaults.ATTACHMENT_OUTLINE_COLOR(#000000)

Returns:

String:

返回附件边框颜色

twaver.network.BasicAttachment.getOutlineWidth

() Number

获取附件边框宽度,默认值为twaver.Defaults.ATTACHMENT_OUTLINE_WIDTH(-1),-1代表无边框

Returns:

Number:

返回附件边框宽度

twaver.network.BasicAttachment.getPadding

() Number

获取附件内容和边界之间的间距,默认值为twaver.Defaults.ATTACHMENT_PADDING(0)

Returns:

Number:

返回附件内容和边界之间的间距

twaver.network.BasicAttachment.getPaddingBottom

() Number

获取附件内容和下边界之间的间距,默认值为twaver.Defaults.ATTACHMENT_PADDING_BOTTOM(0)

Returns:

Number:

返回附件内容和下边界之间的间距

twaver.network.BasicAttachment.getPaddingLeft

() Number

获取附件内容和左边界之间的间距,默认值为twaver.Defaults.ATTACHMENT_PADDING_LEFT(0)

Returns:

Number:

返回附件内容和左边界之间的间距

twaver.network.BasicAttachment.getPaddingRight

() Number

获取附件内容和右边界之间的间距,默认值为twaver.Defaults.ATTACHMENT_PADDING_RIGHT(0)

Returns:

Number:

附件内容和右边界之间的间距

twaver.network.BasicAttachment.getPaddingTop

() Number

获取附件内容和上边界之间的间距,默认值为twaver.Defaults.ATTACHMENT_PADDING_TOP(0)

Returns:

Number:

返回附件内容和上边界之间的间距

twaver.network.BasicAttachment.getPointerLength

() Number

获取附件箭头长度,默认值为twaver.Defaults.ATTACHMENT_POINTER_LENGTH(10)

Returns:

Number:

返回附件箭头长度

twaver.network.BasicAttachment.getPointerWidth

() Number

获取附件箭头宽度,默认值为ATTACHMENT_POINTER_WIDTH(8)

Returns:

Number:

返回附件箭头宽度

twaver.network.BasicAttachment.getPosition

() String

获取附件位置,默认值为twaver.Defaults.ATTACHMENT_POSITION(topright.topright) 可选值为 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

Returns:

String:

返回附件位置

twaver.network.BasicAttachment.getRoundRect

() Object

获取附件圆角区域

Returns:

Object:

返回附件圆角区域,值为包含x、y、width和height属性的Object对象

twaver.network.BasicAttachment.getXOffset

() Number

获取附件x轴偏移量,默认值为twaver.Defaults.ATTACHMENT_XOFFSET(0)

Returns:

Number:

返回附件x轴偏移量

twaver.network.BasicAttachment.getYOffset

() Number

获取附件y轴偏移量,默认值为twaver.Defaults.ATTACHMENT_YOFFSET(0)

Returns:

Number:

返回附件y轴偏移量

twaver.network.BasicAttachment.isFill

() Number

获取附件是否填充背景,默认值为twaver.Defaults.ATTACHMENT_FILL(false)

Returns:

Number:

返回附件是否填充背景

twaver.network.BasicAttachment.isShadowable

() Boolean

获取附件选中时是否有阴影效果,默认值为twaver.Defaults.ATTACHMENT_SHADOWABLE(false)

Returns:

Boolean:

返回附件选中时是否有阴影效果

twaver.network.BasicAttachment.setContent

(
  • value
)

设置附件内容

Parameters:

  • value HTMLElement

    附件内容

twaver.network.LabelAttachment.getLabel

() String

获取标签文本

Returns:

String:

返回标签文本

twaver.network.LabelAttachment.getMaxLength

() Number

获取标签最大长度,以像素为单位,内容超过此长度则将自动换行

Returns:

Number:

标签最大长度