API Docs for: TWaver HTML5 5.7.5
Show:

twaver.Util Class

这是一个工具类，提供了TWaver中常用的方法

Constructor

twaver.Util

()

Item Index

Methods

Properties

Methods

twaver.Util.addEventListener

(
  • type
  • handler
  • view
  • [scope]
)
static

给HTML元素添加事件监听器

Parameters:

  • type String

    事件类型

  • handler Function

    回调函数

  • view HTMLElement

    HTML元素

  • [scope] Object optional

    可选，回调函数的作用域，默认为null，即全局

twaver.Util.calculatePointAngleAlongLine

(
  • points
  • segments
  • isSource
  • xOffset
  • yOffset
)
Object static

计算线条上指定偏移量的点的坐标和角度

Parameters:

  • points twaver.List

    点的集合

  • segments twaver.List

    点与点之间连线类型的集合, 可选值为lineto,

  • isSource Boolean

    是否在连线的起始端, 为true则为连线的起始端, 否则为连线的结束端

  • xOffset Number

    x轴偏移量

  • yOffset Number

    y轴偏移量

Returns:

Object:

返回包含point(包含x和y属性的Object对象)和angle属性的Object对象

twaver.Util.containsPoint

(
  • rect
  • x
  • [y]
)
Object static

判断传入的X，Y坐标是否在rect的范围之内。

Parameters:

  • rect Object

    一个包含左上角的坐标点以及宽高的矩形对象。比如{x:10,y:10,width:100,height:100}

  • x Object

    x坐标。x可以为Number，也可以为Object。当x为Number时，y值必填。当x为object时，需要传入的一个{x:10,y:10}带x，y变量的对象

  • [y] Number optional

    y坐标。可选，当x为object时，y不需要赋值；当x为Number时，y必须要赋值

Returns:

Object:

如果rect包含x，y坐标，返回true，否则返回false

twaver.Util.createCanvas

() Object static

创建一个画布对象

Returns:

Object:

画布对象

twaver.Util.createDiv

() Object static

创建一个DIV对象

Returns:

Object:

DIV对象

twaver.Util.drawArrow

(
  • g
  • arrowWidth
  • arrowHeight
  • linePaths
  • isSrouce
  • arrowStyle
  • drawBody
  • arrowColor
  • arrowXOffset
  • arrowYOffset
  • lineWidth
  • arrowOutlineColor
)
static

用指定样式画连线的箭头, 连线样式可以为: arrow.standard 标准样式 arrow.delta 三角形 arrow.diamond 菱形 arrow.short 短小形 arrow.slant 斜角

Parameters:

  • g CanvasRenderingContext2D

    画布

  • arrowWidth Number

    箭头宽度

  • arrowHeight Number

    箭头高度

  • linePaths twaver.List

    构成连线的点的集合

  • isSrouce Boolean

    箭头是否在连线的起始端, 为true则为连线的起始端, 否则为连线的结束点

  • arrowStyle String

    箭头样式

  • drawBody Boolean

    箭头是否填充, 为true则填充, 否则不填充

  • arrowColor String

    箭头填充颜色

  • arrowXOffset Number

    箭头X坐标偏移量

  • arrowYOffset Number

    箭头Y坐标偏移量

  • lineWidth Number

    箭头边框宽度

  • arrowOutlineColor String

    箭头边框颜色

twaver.Util.drawVector

(
  • g
  • shape
  • x
  • [y]
  • [w]
  • [h]
)
static

在给定的矩形范围中绘制指定的图形。指定图形形状的可选值为： 'rectangle'：矩形， 'oval'：椭圆形, 'roundrect'：圆角矩形, 'star'：星形, 'triangle'：三角形, 'circle'：圆形, 'hexagon'：六边形, 'pentagon'：五角形, 'diamond'：菱形

Parameters:

  • g Object

    CanvasRenderingContext2D对象，用于在canvas上绘图

  • shape String

    指定的图形形状。

  • x Object

    x坐标。x可以为Number，也可以为Object。当x为Number时，y值必填。当x为object时，需要传入的一个带x，y，width，height变量的对象，例如{x:10,y:10,width:100,height:100}

  • [y] Number optional

    y坐标。可选，当x为object时，y不需要赋值；当x为Number时，y必须要赋值

  • [w] Number optional

    矩形的宽度。可选，当x为object时w不需要赋值；当x为Number时，w必须要赋值

  • [h] Number optional

    矩形的高度。可选，当x为object时，h不需要赋值；当x为Number时，h必须要赋值

twaver.Util.ext

(
  • subClass
  • superClass
  • o
)
static

指定的子类继承于父类

Parameters:

  • subClass Object

    子类

  • superClass Object

    父类

  • o Object

    子类中重写或扩展的属性和方法

twaver.Util.fill

(
  • g
  • fillColor
  • [gradient]
  • [gradientColor]
  • x
  • [y]
  • [w]
  • [h]
)
static

给指定的矩形填充颜色，填充的颜色可以为渐变色，并可以指定渐变的类型。渐变类型的可选值为： 'linear.southwest'：线性.南西 'linear.southeast'：线性.南东 'linear.northwest'：线性.北西 'linear.northeast'：线性.北东 'linear.north'：线性.北 'linear.south'：线性.南 'linear.west'：线性.西 'linear.east'：线性.东 'radial.center'：放射.中 'radial.southwest'：放射.南西 'radial.southeast'：放射.南东 'radial.northwest'：放射.北西 'radial.northeast'：放射.北东 'radial.north'：放射.北 'radial.south'：放射.南 'radial.west'：放射.西 'radial.east'：放射.东 'spread.horizontal':扩展.水平 'spread.vertical':扩展.垂直 'spread.diagonal':扩展.对角线 'spread.antidiagonal':扩展.反对角线 'spread.north':扩展.北 'spread.south':扩展.南 'spread.west':扩展.西 'spread.east':扩展.东

Parameters:

  • g Object

    CanvasRenderingContext2D对象，用于在canvas上绘图

  • fillColor String

    填充的颜色值

  • [gradient] String optional

    渐变类型

  • [gradientColor] String optional

    渐变颜色值

  • x Object

    x坐标。x可以为Number，也可以为Object。当x为Number时，y值必填。当x为object时，需要传入的一个带x，y，width，height变量的对象，例如{x:10,y:10,width:100,height:100}

  • [y] Number optional

    y坐标。可选，当x为object时，y不需要赋值；当x为Number时，y必须要赋值

  • [w] Number optional

    矩形的宽度。可选，当x为object时w不需要赋值；当x为Number时，w必须要赋值

  • [h] Number optional

    矩形的高度。可选，当x为object时，h不需要赋值；当x为Number时，h必须要赋值

twaver.Util.getAllClassNames

() Array static

获取所有类名

Returns:

Array:

返回所有类名

twaver.Util.getClass

(
  • className
)
Object static

通过类名来获取类对象

Parameters:

  • className String

    类名

Returns:

Object:

类的对象

twaver.Util.getClassName

() String

获取类的名称

Returns:

String:

类名

twaver.Util.getCSSStyle

(
  • domObject
  • styleName
)
String static

获取指定HTML元素的指定样式的值

Parameters:

  • domObject HTMLElement

    HTML对象

  • styleName String

    样式名称

Returns:

String:

返回指定样式值

twaver.Util.getElementsBounds

(
  • elements
  • network
)
Object static

获取网元所占的区域

Parameters:

Returns:

Object:

返回指定网元所占的区域

twaver.Util.getFilterColor

(
  • sourceColor
  • filterColor
)
Object static

获取渲染后的颜色

Parameters:

  • sourceColor String

    原始颜色

  • filterColor String

    渲染色

Returns:

Object:

返回染色后的颜色，包含r,g,b,a的对象

twaver.Util.getHSVColor

(
  • h
  • s
  • v
)
String static

获取HSV颜色

Parameters:

  • h String
  • s String
  • v String

Returns:

String:

twaver.Util.getImageAsset

(
  • name
)
twaver.ImageAsset static

通过图片的名称来获取图片对象

Parameters:

  • name String

    图片的名称

Returns:

twaver.ImageAsset:

图片对象

twaver.Util.getLicense

() String static

获取TWaver的License

Returns:

String:

twaver.Util.getPointIndex

(
  • points
  • point
  • tolerance
)
Number static

获取指定点所在的边

Parameters:

  • points twaver.List

    包含点的集合

  • point Object

    点

  • tolerance Number

    误差值

Returns:

Number:

返回指定点所在的边

twaver.Util.getRadiansBetweenLines

(
  • from
  • to
)
Number static

获取两点之间的角度

Parameters:

  • from Object

    起始点

  • to Object

    结束点

Returns:

Number:

返回两点之间的角度，单位为弧度

twaver.Util.getRect

(
  • points
)
Object static

返回包含指定点的矩形

Parameters:

  • points Array

    "点"的数组

Returns:

Object:

返回包含指定点的矩形

twaver.Util.getRegisteredImageNames

() Array static

获取所有注册名图片名称

Returns:

Array:

返回所有注册的图片名称

twaver.Util.getSubNetwork

(
  • element
)
twaver.SubNetwork static

获取网元所在的子网

Parameters:

Returns:

twaver.SubNetwork:

返回网元所在的子网

twaver.Util.getToolTipDiv

() String static

返回ToolTip所在的DIV

Returns:

String:

返回ToolTip所在的DIV

twaver.Util.getValue

(
  • instance
  • property
  • type
)
String static

返回网元的某个属性值

Parameters:

  • instance String

    网元实例

  • property String

    属性名

  • type String

    属性类型

Returns:

String:

返回属性值

twaver.Util.getVersion

() String static

获取TWaver的版本号

Returns:

String:

TWaver的版本号

twaver.Util.grow

(
  • rect
  • width
  • height
)
static

将指定的矩形扩大一定的宽高值。这种扩大是矩形的中心点保持不变，像四周扩大指定值的宽度、高度。 比如指定的矩形为{x:20,y:20,width:100;height:100},如果扩大的width为10，height为10，那么扩大后的矩形变为{x:10,y:10,width:120,height:120}

Parameters:

  • rect Object

    指定扩大的矩形

  • width Number

    扩大的宽度值

  • height Number

    扩大的高度值

twaver.Util.hideToolTip

() static

隐藏Tooltip

twaver.Util.intersects

(
  • srcRect
  • dstRect
)
Boolean static

判断指定的矩形区域是否相交

Parameters:

  • srcRect Object

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

  • dstRect Object

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

Returns:

Boolean:

如果指定的区域相交, 则返回true, 否则返回false

twaver.Util.isDeserializing

() Boolean static

是否正在进行反序列化操作，默认为false

Returns:

Boolean:

如果正在进行反序列化，返回true；否则返回false

twaver.Util.isPermissionGIS

() String static

Returns:

String:

twaver.Util.isTypeOf

(
  • type
  • base
)
Boolean static

判断是否是某个类的子类

Parameters:

  • type Object

    父类

  • base Object

    基类

Returns:

Boolean:

如果是子类则返回true，否则为false

twaver.Util.makeHighRes

(
  • c
)
static

高清屏

Parameters:

  • c CanvasRenderingContext2D

    Canvas

twaver.Util.moveElements

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

偏移指定的一批网元

Parameters:

  • elements twaver.List

    需要偏移的网元集合

  • xoffset Number

    偏移的X坐标值

  • yoffset Number

    偏移的Y坐标值

  • animate Boolean

    是否需要动画

  • [finishFunction] Function optional

    偏移完成时回调的函数

twaver.Util.newFunction

() String static

Returns:

String:

twaver.Util.newInstance

(
  • className
)
Object static

通过类名来实例化一个对象

Parameters:

  • className String

    类名

Returns:

Object:

实例化的对象

twaver.Util.parseVectorData

(
  • data
)
String static

Parameters:

  • data String

Returns:

String:

twaver.Util.pauseAllAnimates

() static

暂停所有动画

twaver.Util.pauseAnimate

(
  • animate
)
static

暂停动画

Parameters:

twaver.Util.playAnimate

(
  • animate
)
twaver.Animate static

播放动画

Parameters:

Returns:

twaver.Animate:

返回动画

twaver.Util.random

() Number static

生成随机数

Returns:

Number:

随机数

twaver.Util.randomColor

() String static

生成16进制随机颜色值

Returns:

String:

返回随机颜色

twaver.Util.registerDraw

(
  • name
  • draw
)
static

注册自定义矢量绘制函数

Parameters:

  • name String

    自定义矢量绘制函数名称

  • draw Function

    绘制函数：function (vector, g, data, view)

twaver.Util.registerGifImage

(
  • name
  • url
)
static

注册Gif动态图片

Parameters:

  • name String

    名称

  • url String

    图片地址

twaver.Util.registerImage

(
  • name
  • source
  • width
  • height
  • svg
)
static

注册图片。当给网元设置图片时，需要先进行注册后才能使用

Parameters:

  • name String

    注册图片的名称

  • source Object

    注册的图片对象

  • width Number

    图片的宽度

  • height Number

    图片的高度

  • svg Boolean

    是否为SVG图片

twaver.Util.registerImageByUrl

(
  • url
  • name
  • network
  • callback
)
static

根据URL注册图片资源

Parameters:

  • url String

    图片地址

  • name String

    图片名称

  • network String

    画布

  • callback String

    回调函数

twaver.Util.registerShape

(
  • name
  • shapeFunc
)
static

注册自定义矢量图形

Parameters:

  • name String

    矢量图形名称

  • shapeFunc Function

    绘制函数：function (g, shapeData, data, view)

twaver.Util.registerVectorShape

(
  • name
  • func
)
static

注册样式'vector.shape'的可选值

Parameters:

  • name String

    矢量图形名称

  • func Function

    绘制函数：function (g, x, y, w, h)

twaver.Util.removeCSSStyle

(
  • domObject
  • styleName
)
static

移除HTML样式

Parameters:

  • domObject HTMLElement

    HTML对象

  • styleName String

    样式名称

twaver.Util.removeEventListener

(
  • type
  • view
  • [scope]
)
static

删除HTML元素的事件监听器

Parameters:

  • type String

    事件类型

  • view HTMLElement

    HTML元素

  • [scope] Object optional

    可选，回调函数的作用域，默认为null，即全局

twaver.Util.resetToolTip

() static

重置Tooltip

twaver.Util.resumeAllAnimates

() static

恢复所有暂停

twaver.Util.resumeAnimate

(
  • animate
)
static

恢复动画

Parameters:

twaver.Util.rotateCanvas

(
  • g
  • rect
  • angle
)
static

将画布以制定的区域的中心为原点，旋转指定的角度

Parameters:

  • g CanvasRenderingContext2D

    画布渲染上下文对象

  • rect Object

    矩形区域

  • angle Number

    旋转角度，单位为度

twaver.Util.setCanvas

(
  • c
  • x
  • y
  • w
  • h
)
CanvasRenderingContext2D static

设置指定Canvas的位置和宽高

Parameters:

  • c HTMLCanvasElement

    指定的Canvas对象

  • x Number

    画布的左边距像素值

  • y Number

    画布的上边距像素值

  • w Number

    画布的宽度

  • h Number

    画布的高度

Returns:

CanvasRenderingContext2D:

返回一个CanvasRenderingContext2D对象用于在canvas上绘图

twaver.Util.setCSSStyle

(
  • domObject
  • styleName
  • styleValue
)
static

设置指定HTML对象的样式

Parameters:

  • domObject HTMLElement

    HTML对象

  • styleName String

    样式名称

  • styleValue String

    样式值

twaver.Util.setFocus

(
  • e
)
static

将焦点设置到指定的对象上

Parameters:

  • e HTMLElement

    设置焦点的对象

twaver.Util.setValue

(
  • instance
  • property
  • value
)
static

设置数据对象指定属性的值

Parameters:

  • instance twaver.Data

    数据对象实例

  • property String

    属性名

  • value Object

    属性值

twaver.Util.showToolTip

(
  • eorp
  • innerHTML
)
static

显示Tooltip

Parameters:

  • eorp Object

    坐标或事件对象

  • innerHTML String

    tooltip内容

twaver.Util.stopAllAnimates

(
  • end
)
static

停止所有动画

Parameters:

  • end String

twaver.Util.stopAnimate

(
  • animate
  • end
)
static

停止动画

Parameters:

twaver.Util.toDegrees

(
  • radian
)
Number static

转换度为弧度

Parameters:

  • radian Number

    单位为弧度的角度

Returns:

Number:

返回单位为度的角度

twaver.Util.toHex

(
  • value
)
String static

Parameters:

  • value String

Returns:

String:

twaver.Util.toRadians

(
  • degree
)
Number static

将角度转换为弧度

Parameters:

  • degree Number

    单位为度的角度

Returns:

Number:

返回单位为弧度的角度

twaver.Util.transformPoint

(
  • point
  • angle
  • xOffset
  • yOffset
)
Object static

以指定的偏移量，旋转角度，转换给定的坐标

Parameters:

  • point Object

    要转换的坐标，为包含x和y属性的对象

  • angle Number

    旋转角度，单位为弧度

  • xOffset Number

    水平偏移量

  • yOffset Number

    垂直偏移量

Returns:

Object:

转换后的坐标

twaver.Util.unionRect

(
  • srcRect
  • dstRect
)
Object static

获取包含指定的两个矩形区域的矩形

Parameters:

  • srcRect Object

    源矩形

  • dstRect Object

    目标矩形

Returns:

Object:

返回包含指定的两个矩形区域的矩形

twaver.Util.unregisterImage

(
  • name
)
static

卸载注册的图片

Parameters:

  • name String

    图片的名称

twaver.Util.validateLicense

(
  • license
)
static

验证license信息

Parameters:

  • license String

    license的信息

Properties

isAndroid

Boolean static

是否为Android，true为是Android，否则为false

isChrome

Boolean static

是否是Chrome浏览器，true为是Chrome浏览器，否则为false

isFirefox

Boolean static

是否是Firefox浏览器，true为是Firefox浏览器，否则为false

isIE

Boolean static

是否是IE浏览器，true为是IE浏览器，否则为false

isIPad

Boolean static

是否为IPad，true为是IPad,否则为false

isIPhone

Boolean static

是否为IPhone，true为是IPhone,否则为false

isIPod

Boolean static

是否为IPod，true为是IPod,否则为false

isOpera

Boolean static

是否是Opera浏览器，true为是Opera浏览器，否则为false

isSafari

Boolean static

是否是Safari浏览器，true为是Safari浏览器，否则为false

isTouchable

Boolean static

是否是可触摸的，true为是可触摸的，否则为false

isWebOS

Boolean static

是否是WebOS，true为是WebOS，否则为false