API Docs for: TWaver HTML5 5.7.5
Show:

twaver.charts.BarChart Class

Extends twaver.charts.ScaleChart

棒图对象

是TWaver图表中的一种，它是以条形柱状的形式展示数据。它支持多种类型的呈现方式，通过setType方法设置。 棒图是和DataBox绑定的，它呈现的是DataBox中Data的chart.values的值。

Constructor

twaver.charts.BarChart

(
  • [dataBox]
)
twaver.charts.BarChart

Parameters:

Returns:

twaver.charts.BarChart:

Item Index

Methods

Methods

twaver.charts.BarChart.defaultValidateModel

()

刷新棒图为默认类型时的数据模型

twaver.charts.BarChart.drawContent

(
  • g
  • rect
  • validHeight
  • skyline
)

绘制棒图显示的形状，用户不需要调用此方法，但可以重写此方法来实现自己定制的图形

Parameters:

  • g CanvasRenderingContext2D

    绘制图表的画笔

  • rect Object

    绘制棒图内容的区域

  • validHeight Number

    棒图上显示柱子的有效高度

  • skyline Number

    Y轴刻度的最小值

twaver.charts.BarChart.drawDefaultContent

(
  • g
  • rect
  • validHeight
  • skyline
)

绘制棒图为默认类型时的形状，用户不需要调用此方法，但可以重写此方法来实现自己定制的图形

Parameters:

  • g CanvasRenderingContext2D

    绘制图表的画笔

  • rect Object

    绘制棒图内容的区域

  • validHeight Number

    棒图上显示柱子的有效高度

  • skyline Number

    Y轴刻度的最小值

twaver.charts.BarChart.drawGroupContent

(
  • g
  • rect
  • validHeight
  • skyline
)

绘制棒图为组类型时的形状，用户不需要调用此方法，但可以重写此方法来实现自己定制的图形

Parameters:

  • g CanvasRenderingContext2D

    绘制图表的画笔

  • rect Object

    绘制棒图内容的区域

  • validHeight Number

    棒图上显示柱子的有效高度

  • skyline Number

    Y轴刻度的最小值

twaver.charts.BarChart.drawLayerContent

(
  • g
  • rect
  • validHeight
  • skyline
)

绘制棒图为层次类型时的形状，用户不需要调用此方法，但可以重写此方法来实现自己定制的图形

Parameters:

  • g CanvasRenderingContext2D

    绘制图表的画笔

  • rect Object

    绘制棒图内容的区域

  • validHeight Number

    棒图上显示柱子的有效高度

  • skyline Number

    Y轴刻度的最小值

twaver.charts.BarChart.drawPercentContent

(
  • g
  • rect
  • validHeight
  • skyline
)

绘制棒图为百分比类型时的形状，用户不需要调用此方法，但可以重写此方法来实现自己定制的图形

Parameters:

  • g CanvasRenderingContext2D

    绘制图表的画笔

  • rect Object

    绘制棒图内容的区域

  • validHeight Number

    棒图上显示柱子的有效高度

  • skyline Number

    Y轴刻度的最小值

twaver.charts.BarChart.drawRect

(
  • g
  • color
  • selected
  • x
  • y
  • w
  • h
)

绘制一个矩形区域

Parameters:

  • g CanvasRenderingContext2D

    绘制图表的画笔

  • color String

    图表绘制的颜色

  • selected Boolean

    是否选中当前的矩形区域

  • x Number

    矩形区域的X坐标

  • y Number

    矩形区域的Y坐标

  • w Number

    矩形区域的宽度

  • h Number

    矩形区域的高度

twaver.charts.BarChart.drawStackContent

(
  • g
  • rect
  • validHeight
  • skyline
)

绘制棒图为叠加类型时的形状，用户不需要调用此方法，但可以重写此方法来实现自己定制的图形

Parameters:

  • g CanvasRenderingContext2D

    绘制图表的画笔

  • rect Object

    绘制棒图内容的区域

  • validHeight Number

    棒图上显示柱子的有效高度

  • skyline Number

    Y轴刻度的最小值

twaver.charts.BarChart.getType

() String

获取棒图的显示类型，默认为twaver.Defaults.BARCHART_TYPE 支持的类型有： 'default','group','stack','layer','percent'

Returns:

String:

棒图的显示类型

twaver.charts.BarChart.groupValidateModel

()

刷新棒图为组类型时的数据模型

twaver.charts.BarChart.layerValidateModel

()

刷新棒图为层次类型时的数据模型

twaver.charts.BarChart.percentValidateModel

()

刷新棒图为百分比类型时的数据模型

twaver.charts.BarChart.setType

(
  • v
)

设置棒图的显示类型，默认为twaver.Defaults.BARCHART_TYPE 支持的类型有： 'default','group','stack','layer','percent'

Parameters:

  • v String

    棒图的显示类型

twaver.charts.BarChart.stackValidateModel

()

刷新棒图为叠加类型时的数据模型

twaver.charts.ChartBase.addToolTipInfo

(
  • x
  • y
  • w
  • h
  • value
  • data
  • index
)

Inherited from twaver.charts.ChartBase:

添加Chart图中悬浮信息框的内容，TWaver内部调用，重写此方法可以更改Chart图上提示信息的显示内容

Parameters:

  • x Number

    提示信息显示的X轴上的坐标

  • y Number

    提示信息显示的Y轴上的坐标

  • w Number

    提示信息显示的宽度

  • h Number

    提示信息显示的高度

  • value String

    提示信息显示的内容

  • data twaver.Data

    提示信息所对应的数据对象

  • index Number

    数据所对应的索引值

twaver.charts.ChartBase.createPublishedDatas

() twaver.List

Inherited from twaver.charts.ChartBase:

创建显示在Chart图上的数据，TWaver内部调用

Returns:

twaver.List:

所有发布的数据集合

twaver.charts.ChartBase.drawBackground

(
  • g
  • rect
)

Inherited from twaver.charts.ChartBase:

绘制图表的背景。当显示图表时，TWaver内部会调用此方法。

Parameters:

  • g Object

    绘制图表背景的画笔

  • rect String

    图表背景的显示矩形区域。rect是一个包含x,y,width,height的对象。

twaver.charts.ChartBase.drawLine

(
  • g
  • color
  • width
  • x1
  • y1
  • x2
  • y2
)

Inherited from twaver.charts.ChartBase:

绘制一条直线，TWaver绘制图表时调用此方法

Parameters:

  • g Object

    绘制图表的画笔

  • color String

    绘制的直线颜色

  • width String

    绘制的直线宽度

  • x1 Number

    直线的起始点X坐标值

  • y1 Number

    直线的起始点Y坐标值

  • x2 Number

    直线的终点X坐标值

  • y2 Number

    直线的终点Y坐标值

twaver.charts.ChartBase.drawValueTexts

(
  • g
)

Inherited from twaver.charts.ChartBase:

绘制值，TWaver绘制图表时调用此方法

Parameters:

  • g Object

    绘制图表的画笔

twaver.charts.ChartBase.drawVerticalText

(
  • g
  • text
  • cx
  • font
  • color
)

Inherited from twaver.charts.ChartBase:

绘制垂直显示的文本内容，TWaver绘制图表时调用此方法

Parameters:

  • g Object

    绘制图表的画笔

  • text String

    绘制的文本内容

  • cx Object

    文本显示为值的起始坐标点，它是一个包含x，y坐标值的对象

  • font Object

    文本的字体

  • color String

    文本的颜色

twaver.charts.ChartBase.formatValueText

(
  • value
  • data
)
String

Inherited from twaver.charts.ChartBase:

格式化文本的值，当显示图表时调用此方法，用户可以重写这个方法来对显示的文本进行格式化

Parameters:

  • value String

    需要格式的值

  • data twaver.Data

    格式化的数据对象

Returns:

String:

格式化后的字符值

twaver.charts.ChartBase.getBackgroundFill

() Boolean

Inherited from twaver.charts.ChartBase:

获取图表的背景是否填充，默认为twaver.Defaults.CHART_BACKGROUND_FILL

Returns:

Boolean:

true为填充背景，否则为false

twaver.charts.ChartBase.getBackgroundFillColor

() String

Inherited from twaver.charts.ChartBase:

获取图表背景的填充色，默认为twaver.Defaults.CHART_BACKGROUND_FILL_COLOR

Returns:

String:

背景的填充色

twaver.charts.ChartBase.getBackgroundGradient

() String

Inherited from twaver.charts.ChartBase:

获取背景的渐变类型，默认为twaver.Defaults.CHART_BACKGROUND_GRADIENT。 渐变类型的可选值为： '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':扩展.东

Returns:

String:

渐变类型

twaver.charts.ChartBase.getBackgroundGradientColor

() String

Inherited from twaver.charts.ChartBase:

获取背景的渐变颜色，默认为twaver.Defaults.CHART_BACKGROUND_GRADIENT_COLOR

Returns:

String:

渐变颜色

twaver.charts.ChartBase.getBackgroundOutlineColor

() String

Inherited from twaver.charts.ChartBase:

获取背景的外边框颜色，默认为twaver.Defaults.CHART_BACKGROUND_OUTLINE_COLOR

Returns:

String:

外边框颜色

twaver.charts.ChartBase.getBackgroundOutlineWidth

() Number

Inherited from twaver.charts.ChartBase:

获取背景的外边框宽度，默认为 twaver.Defaults.CHART_BACKGROUND_OUTLINE_WIDTH

Returns:

Number:

外边框的宽度

twaver.charts.ChartBase.getBackgroundRect

() Object

Inherited from twaver.charts.ChartBase:

获取背景的显示区域

Returns:

Object:

背景的显示矩形范围

twaver.charts.ChartBase.getCanvas

() Object

Inherited from twaver.charts.ChartBase:

获取图表上的画板

Returns:

Object:

图表的画板

twaver.charts.ChartBase.getCanvasHeight

() Number

Inherited from twaver.charts.ChartBase:

获取画板的高度

Returns:

Number:

画板的高度

twaver.charts.ChartBase.getCanvasWidth

() Number

Inherited from twaver.charts.ChartBase:

获取画板的宽度

Returns:

Number:

画板的宽度

twaver.charts.ChartBase.getColor

(
  • data
)
String

Inherited from twaver.charts.ChartBase:

绘制图表上指定数据的颜色，它取的是data中的chart.color值

Parameters:

Returns:

String:

颜色值

twaver.charts.ChartBase.getDataAt

() twaver.Data

Inherited from twaver.charts.ChartBase:

获取指定坐标点上的数据对象。参数可以为1个或2个。当参数为一个时，可以是包含x，y坐标值的对象，也可以是鼠标事件对象；当参数为两个时，必须是x，y坐标

Returns:

twaver.Data:

数据对象

twaver.charts.ChartBase.getDataBox

() twaver.DataBox

Inherited from twaver.charts.ChartBase:

获取和这个图表绑定的数据容器

Returns:

twaver.DataBox:

twaver.charts.ChartBase.getLogicalPoint

(
  • e
)
Object

Inherited from twaver.charts.ChartBase:

通过鼠标事件获取当前鼠标点的逻辑坐标

Parameters:

  • e MouseEvent

    鼠标事件对象

Returns:

Object:

包含x，y的坐标点的对象

twaver.charts.ChartBase.getMaxZoom

() Number

Inherited from twaver.charts.ChartBase:

获取最大的缩放比例值，默认为twaver.Defaults.ZOOM_MAX

Returns:

Number:

缩放比例值

twaver.charts.ChartBase.getMinZoom

() Number

Inherited from twaver.charts.ChartBase:

获取最小的缩放比例值，默认为twaver.Defaults.ZOOM_MIN

Returns:

Number:

缩放比例值

twaver.charts.ChartBase.getName

(
  • data
)
String

Inherited from twaver.charts.ChartBase:

获取指定数据的名称

Parameters:

Returns:

String:

数据的名称

twaver.charts.ChartBase.getOuterZoom

() Number

Inherited from twaver.charts.ChartBase:

获取外部缩放级别

Returns:

Number:

返回外部缩放级别

twaver.charts.ChartBase.getPublishedDatas

() twaver.List

Inherited from twaver.charts.ChartBase:

获取显示在图表上的数据

Returns:

twaver.List:

所有发布的数据

twaver.charts.ChartBase.getSelectTolerance

() Number

Inherited from twaver.charts.ChartBase:

获取Chart上选择网元时的公差。默认值为twaver.Defaults.CHART_SELECT_TOLERANCE。当设置了这个值后，点击图表上的网元在这个偏差的范围值之内都能选中这个网元

Returns:

Number:

选择网元时的公差

twaver.charts.ChartBase.getSortFunction

() Function

Inherited from twaver.charts.ChartBase:

获取图表上排序的函数，默认为空

Returns:

Function:

排序的函数

twaver.charts.ChartBase.getTextSize

(
  • font
  • text
)
Number

Inherited from twaver.charts.ChartBase:

获取图表上显示文本的大小

Parameters:

  • font Object

    显示的字体

  • text String

    文本值

Returns:

Number:

显示文本的大小，是一个包含width，height的对象

twaver.charts.ChartBase.getToolTipByData

(
  • data
  • info
)
String

Inherited from twaver.charts.ChartBase:

获取指定数据显示的提示信息

Parameters:

  • data twaver.Data

    指定的数据

  • info Object

    关联信息

Returns:

String:

返回提示信息

twaver.charts.ChartBase.getUnfilteredDatas

() twaver.List

Inherited from twaver.charts.ChartBase:

获取图表上所有显示的数据

Returns:

twaver.List:

显示的数据的集合

twaver.charts.ChartBase.getUniqueColor

(
  • color
  • [data]
)
String

Inherited from twaver.charts.ChartBase:

通过指定的对象和颜色值获取唯一的对象颜色值，用于区分不同的网元设置相同的颜色。如果对象设置了相同的颜色值，调用此方法可以对其中的一个颜色值做一些偏移

Parameters:

  • color String
  • [data] twaver.Data optional

    指定的数据对象

Returns:

String:

颜色值对象

twaver.charts.ChartBase.getValue

(
  • data
)
Object

Inherited from twaver.charts.ChartBase:

获取指定的数据在图表上的值，默认取的是Style上的'chart.value'的值

Parameters:

Returns:

Object:

指定的数据在图表上的值

twaver.charts.ChartBase.getValueColor

(
  • data
)
String

Inherited from twaver.charts.ChartBase:

获取指定的数据在图表上值的颜色，默认取的是Style上的'chart.value.color'的值

Parameters:

Returns:

String:

指定的数据在图表上值的颜色

twaver.charts.ChartBase.getValueFont

(
  • data
)
String

Inherited from twaver.charts.ChartBase:

获取指定的数据在图表上值的字体，默认取的是Style上的'chart.value.font'的值

Parameters:

Returns:

String:

指定的数据在图表上值的字体

twaver.charts.ChartBase.getVisibleFunction

() Function

Inherited from twaver.charts.ChartBase:

获取图表上是否可见的函数，这个函数可以过滤哪些网元显示，哪些不显示

Returns:

Function:

是否可见的过滤器函数

twaver.charts.ChartBase.getXGap

() Number

Inherited from twaver.charts.ChartBase:

获取水平方向的间距，默认为 twaver.Defaults.CHART_XGAP

Returns:

Number:

水平方向的间距

twaver.charts.ChartBase.getXTranslate

() Number

Inherited from twaver.charts.ChartBase:

获取图表上X轴方向的偏移值，默认为0

Returns:

Number:

X轴方向的偏移值

twaver.charts.ChartBase.getXZoom

() Number

Inherited from twaver.charts.ChartBase:

获取图表的X轴方向的缩放值，默认为1

Returns:

Number:

图表上X轴方向的缩放值

twaver.charts.ChartBase.getYGap

() Number

Inherited from twaver.charts.ChartBase:

获取垂直方向的间距，默认为 twaver.Defaults.CHART_YGAP

Returns:

Number:

垂直方向的间距

twaver.charts.ChartBase.getYTranslate

() Number

Inherited from twaver.charts.ChartBase:

获取图表上Y轴方向的偏移值，默认为0

Returns:

Number:

Y轴方向的偏移值

twaver.charts.ChartBase.getYZoom

() Number

Inherited from twaver.charts.ChartBase:

获取图表的Y轴方向的缩放值，默认为1

Returns:

Number:

Y轴方向的缩放值

twaver.charts.ChartBase.handleDataBoxChange

(
  • e
)

Inherited from twaver.charts.ChartBase:

当数据容器中数据发生变化时，TWaver内部会调用此方法，同步图表的显示。

Parameters:

  • e Object

    数据容器更改的事件

twaver.charts.ChartBase.handleHierarchyChange

(
  • e
)

Inherited from twaver.charts.ChartBase:

当数据的层次关系发生变化时，TWaver内部会调用此方法来更新图表的显示

Parameters:

  • e Object

    层次关系变化的事件

twaver.charts.ChartBase.handlePropertyChange

(
  • e
)

Inherited from twaver.charts.ChartBase:

当数据容器中的数据发生变化时，TWaver内部会调用此方法来更新图表的显示

Parameters:

  • e Object

    数据更改事件

twaver.charts.ChartBase.handleSelectionChange

(
  • e
)

Inherited from twaver.charts.ChartBase:

当选择容器中的数据发生变化时，TWaver内部会调用此方法来更新图表的显示

Parameters:

  • e Object

    选择数据变化的事件

twaver.charts.ChartBase.invalidateModel

()

Inherited from twaver.charts.ChartBase:

刷新和图表绑定的数据容器，当数据容器发生变化时，TWaver内部会调用此方法。用户不需要直接调用此方法，可以重载这个方法做自己的处理

twaver.charts.ChartBase.isBackgroundVisible

() Boolean

Inherited from twaver.charts.ChartBase:

判断图表的背景是否可见，默认为twaver.Defaults.CHART_BACKGROUND_VISIBLE

Returns:

Boolean:

true为可见，false不可见

twaver.charts.ChartBase.isDoubleClickToReset

() Boolean

Inherited from twaver.charts.ChartBase:

判断双击是否还原成默认的初始状态，默认为 twaver.Defaults.CHART_DOUBLE_CLICK_TO_RESET

Returns:

Boolean:

是否还原

twaver.charts.ChartBase.isToolTipEnabled

() Boolean

Inherited from twaver.charts.ChartBase:

判断悬浮信息框是否生效

Returns:

Boolean:

true为生效，否则为false

twaver.charts.ChartBase.isValueVisible

() Boolean

Inherited from twaver.charts.ChartBase:

判断图表上网元的值是否可见，默认为twaver.Defaults.CHART_VALUE_VISIBLE

Returns:

Boolean:

true为可见，否则为false

twaver.charts.ChartBase.isVisible

(
  • data
)
Boolean

Inherited from twaver.charts.ChartBase:

判断图表上指定的数据是否可见

Parameters:

Returns:

Boolean:

true为可见，否则为false

twaver.charts.ChartBase.isXTranslateEnabled

() Boolean

Inherited from twaver.charts.ChartBase:

是否允许X轴进行偏移，默认为twaver.Defaults.CHART_XTRANSLATE_ENABLED

Returns:

Boolean:

是否允许X轴进行偏移

twaver.charts.ChartBase.isXZoomEnabled

() Boolean

Inherited from twaver.charts.ChartBase:

判断X轴方向是否允许缩放，默认为 twaver.Defaults.CHART_XZOOM_ENABLED

Returns:

Boolean:

是否允许X轴方向缩放

twaver.charts.ChartBase.isYTranslateEnabled

() Boolean

Inherited from twaver.charts.ChartBase:

是否允许Y轴进行偏移，默认为twaver.Defaults.CHART_YTRANSLATE_ENABLED

Returns:

Boolean:

是否允许Y轴方向偏移

twaver.charts.ChartBase.isYZoomEnabled

() Boolean

Inherited from twaver.charts.ChartBase:

判断Y轴方向是否允许缩放，默认为 twaver.Defaults.CHART_YZOOM_ENABLED

Returns:

Boolean:

是否允许Y轴方向缩放

twaver.charts.ChartBase.onXZoomChanged

(
  • oldZoom
  • newZoom
)

Inherited from twaver.charts.ChartBase:

当X轴的缩放比例变化时，回调此方法。默认实现为空，用户可以重写这个方法进行自己的处理

Parameters:

  • oldZoom Number

    X轴缩放的原值

  • newZoom Number

    X轴缩放的新值

twaver.charts.ChartBase.onYZoomChanged

(
  • oldZoom
  • newZoom
)

Inherited from twaver.charts.ChartBase:

当Y轴的缩放比例变化时，回调此方法。默认实现为空，用户可以重写这个方法进行自己的处理

Parameters:

  • oldZoom Number

    Y轴缩放的原值

  • newZoom Number

    Y轴缩放的新值

twaver.charts.ChartBase.setBackgroundFill

(
  • v
)

Inherited from twaver.charts.ChartBase:

设置图表的背景是否填充，默认为twaver.Defaults.CHART_BACKGROUND_FILL

Parameters:

  • v Boolean

    true为填充背景，否则为false

twaver.charts.ChartBase.setBackgroundFillColor

(
  • v
)

Inherited from twaver.charts.ChartBase:

设置图表背景的填充色，默认为twaver.Defaults.CHART_BACKGROUND_FILL_COLOR

Parameters:

  • v String

    背景的填充色

twaver.charts.ChartBase.setBackgroundGradient

(
  • v
)

Inherited from twaver.charts.ChartBase:

设置背景的渐变类型，默认为twaver.Defaults.CHART_BACKGROUND_GRADIENT。 渐变类型的可选值为： '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:

  • v String

    渐变类型

twaver.charts.ChartBase.setBackgroundGradientColor

(
  • v
)

Inherited from twaver.charts.ChartBase:

设置背景的渐变颜色，默认为twaver.Defaults.CHART_BACKGROUND_GRADIENT_COLOR

Parameters:

  • v String

    渐变颜色

twaver.charts.ChartBase.setBackgroundOutlineColor

(
  • v
)

Inherited from twaver.charts.ChartBase:

设置背景的外边框颜色，默认为twaver.Defaults.CHART_BACKGROUND_OUTLINE_COLOR

Parameters:

  • v String

    外边框颜色

twaver.charts.ChartBase.setBackgroundOutlineWidth

(
  • v
)

Inherited from twaver.charts.ChartBase:

设置背景的外边框宽度，默认为 twaver.Defaults.CHART_BACKGROUND_OUTLINE_WIDTH

Parameters:

  • v Number

    外边框的宽度

twaver.charts.ChartBase.setBackgroundVisible

(
  • v
)

Inherited from twaver.charts.ChartBase:

设置图表的背景是否可见，默认为twaver.Defaults.CHART_BACKGROUND_VISIBLE

Parameters:

  • v Boolean

    true为可见，false不可见

twaver.charts.ChartBase.setDataBox

(
  • dataBox
)

Inherited from twaver.charts.ChartBase:

设置和这个图表绑定的数据容器

Parameters:

twaver.charts.ChartBase.setDoubleClickToReset

(
  • v
)

Inherited from twaver.charts.ChartBase:

设置双击是否还原为默认的初始状态，默认为 twaver.Defaults.CHART_DOUBLE_CLICK_TO_RESET

Parameters:

  • v Boolean

twaver.charts.ChartBase.setMaxZoom

(
  • value
)

Inherited from twaver.charts.ChartBase:

设置最大的缩放比例值，默认为twaver.Defaults.ZOOM_MAX

Parameters:

  • value Number

    缩放比例值

twaver.charts.ChartBase.setMinZoom

(
  • value
)

Inherited from twaver.charts.ChartBase:

设置最小的缩放比例值，默认为twaver.Defaults.ZOOM_MIN

Parameters:

  • value Number

    缩放比例值

twaver.charts.ChartBase.setOuterZoom

(
  • v
)

Inherited from twaver.charts.ChartBase:

设置外部缩放级别

Parameters:

  • v Number

    外部缩放级别

twaver.charts.ChartBase.setSelectTolerance

(
  • v
)

Inherited from twaver.charts.ChartBase:

设置Chart上选择网元时的公差。默认值为twaver.Defaults.CHART_SELECT_TOLERANCE。当设置了这个值后，点击图表上的网元在这个偏差的范围值之内都能选中这个网元

Parameters:

  • v Number

    选择网元时的公差

twaver.charts.ChartBase.setSortFunction

(
  • v
)

Inherited from twaver.charts.ChartBase:

设置图表上排序的函数，默认为空

Parameters:

  • v Function

    排序的函数

twaver.charts.ChartBase.setToolTipEnabled

(
  • value
)

Inherited from twaver.charts.ChartBase:

设置悬浮信息框是否生效

Parameters:

  • value Boolean

    true为生效，否则为false

twaver.charts.ChartBase.setValueFont

(
  • value
)

Inherited from twaver.charts.ChartBase:

设置指定的数据在图表上显示值的字体

Parameters:

  • value String

    指定的数据在图表上值的字体

twaver.charts.ChartBase.setValueVisible

(
  • v
)

Inherited from twaver.charts.ChartBase:

设置图表上网元的值是否可见，默认为twaver.Defaults.CHART_VALUE_VISIBLE

Parameters:

  • v Boolean

    true为可见，否则为false

twaver.charts.ChartBase.setVisibleFunction

(
  • v
)

Inherited from twaver.charts.ChartBase:

设置图表上是否可见的函数，这个函数可以过滤哪些网元显示，哪些不显示

Parameters:

  • v Function

    是否可见的过滤器函数

twaver.charts.ChartBase.setXGap

(
  • v
)

Inherited from twaver.charts.ChartBase:

设置水平方向的间距，默认为twaver.Defaults.CHART_XGAP

Parameters:

  • v Number

    水平方向的间距

twaver.charts.ChartBase.setXTranslate

(
  • v
)

Inherited from twaver.charts.ChartBase:

设置图表上X轴方向的偏移值，默认为0

Parameters:

  • v Number

    X轴方向的偏移值

twaver.charts.ChartBase.setXTranslateEnabled

(
  • v
)

Inherited from twaver.charts.ChartBase:

设置是否允许X轴进行偏移，默认为twaver.Defaults.CHART_XTRANSLATE_ENABLED

Parameters:

  • v Boolean

twaver.charts.ChartBase.setXZoom

(
  • value
  • animate
)

Inherited from twaver.charts.ChartBase:

设置图表的X轴方向的缩放值，默认为1

Parameters:

  • value Number

    X轴方向的缩放值

  • animate Boolean

    true为需要动画，false不需要动画

twaver.charts.ChartBase.setXZoomEnabled

(
  • v
)

Inherited from twaver.charts.ChartBase:

设置X轴方向是否允许缩放，默认为 twaver.Defaults.CHART_XZOOM_ENABLED

Parameters:

  • v Boolean

twaver.charts.ChartBase.setYGap

(
  • v
)

Inherited from twaver.charts.ChartBase:

设置垂直方向的间距，默认为twaver.Defaults.CHART_YGAP

Parameters:

  • v Number

    垂直方向的间距

twaver.charts.ChartBase.setYTranslate

(
  • v
)

Inherited from twaver.charts.ChartBase:

设置图表上Y轴方向的偏移值，默认为0

Parameters:

  • v Number

    Y轴方向的偏移值

twaver.charts.ChartBase.setYTranslateEnabled

(
  • v
)

Inherited from twaver.charts.ChartBase:

设置是否允许Y轴进行偏移，默认为twaver.Defaults.CHART_YTRANSLATE_ENABLED

Parameters:

  • v Boolean

twaver.charts.ChartBase.setYZoom

(
  • value
  • [animate]
)

Inherited from twaver.charts.ChartBase:

设置图表的Y轴方向的缩放值，默认为1

Parameters:

  • value Number

    Y轴方向的缩放值

  • [animate] Boolean optional

    true为需要动画，false不需要动画，默认值为TWave.Defaults.ZOOM_ANIMATE

twaver.charts.ChartBase.setYZoomEnabled

(
  • v
)

Inherited from twaver.charts.ChartBase:

设置Y轴方向是否允许缩放，默认为 twaver.Defaults.CHART_YZOOM_ENABLED

Parameters:

  • v Boolean

    true为允许缩放，否则为false

twaver.charts.ChartBase.tryGetDataAt

(
  • point
  • [tolerance]
)
twaver.Data

Inherited from twaver.charts.ChartBase:

通过指定的鼠标点和公差来获取当前鼠标下的数据，如果当前鼠标点下没有网元，但是在公差的范围值下有网元存在，也会将这个网元返回

Parameters:

  • point Object

    鼠标点对象，是一个包含target,x,y的对象

  • [tolerance] Number optional

    公差的范围值

Returns:

twaver.Data:

twaver.charts.ChartBase.validateDisplay

(
  • g
  • width
  • height
)

Inherited from twaver.charts.ChartBase:

刷新图表的显示界面，当图表发生变化时或数据模型更改时，TWaver会自动调用此方法，用户不需要直接调用此方法，可以重载这个方法做自己的处理

Parameters:

  • g Object

    绘制图表的画笔

  • width Number

    刷新显示区域的宽度

  • height String

    刷新显示区域的高度

twaver.charts.ChartBase.validateModel

()

Inherited from twaver.charts.ChartBase:

重画视图组件，当视图组件中绑定的数据发生变化时，须调用此方法，让组件重画

twaver.charts.ChartBase.xZoomIn

(
  • animate
)

Inherited from twaver.charts.ChartBase:

对图表的X轴方向进行放大

Parameters:

  • animate Boolean

    是否需要动画效果

twaver.charts.ChartBase.xZoomOut

(
  • animate
)

Inherited from twaver.charts.ChartBase:

对图表的X轴方向进行缩小

Parameters:

  • animate Boolean

    是否需要动画效果

twaver.charts.ChartBase.xZoomReset

(
  • animate
)

Inherited from twaver.charts.ChartBase:

对图表的X轴方向还原至默认的缩放状态

Parameters:

  • animate Boolean

    是否需要动画效果

twaver.charts.ChartBase.yZoomIn

(
  • animate
)

Inherited from twaver.charts.ChartBase:

对图表的Y轴方向进行放大

Parameters:

  • animate Boolean

    是否需要动画效果

twaver.charts.ChartBase.yZoomOut

(
  • animate
)

Inherited from twaver.charts.ChartBase:

对图表的Y轴方向进行缩小

Parameters:

  • animate Boolean

    是否需要动画效果

twaver.charts.ChartBase.yZoomReset

(
  • animate
)

Inherited from twaver.charts.ChartBase:

对图表的Y轴方向还原至默认的缩放状态

Parameters:

  • animate Boolean

    是否需要动画效果

twaver.charts.ChartBase.zoomIn

(
  • animate
)

Inherited from twaver.charts.ChartBase:

对图表进行整体放大

Parameters:

  • animate Boolean

    是否需要动画效果

twaver.charts.ChartBase.zoomOut

(
  • animate
)

Inherited from twaver.charts.ChartBase:

对图表进行整体缩小

Parameters:

  • animate Boolean

    是否需要动画效果

twaver.charts.ChartBase.zoomReset

(
  • animate
)

Inherited from twaver.charts.ChartBase:

将图表的整体还原至默认的缩放状态

Parameters:

  • animate Boolean

    是否需要动画效果

twaver.charts.ScaleChart.formatYScaleText

(
  • value
)
Number

Inherited from twaver.charts.ScaleChart:

格式化Y轴上的刻度尺的文字，默认保留两位小数。用户可以重写这个方法来对文字进行格式化

Parameters:

  • value Number

    指定的数据值

Returns:

Number:

格式化后的数据

twaver.charts.ScaleChart.getColumnCount

() Number

Inherited from twaver.charts.ScaleChart:

获取显示的列数，TWaver内部会调用此方法。

Returns:

Number:

显示的列数

twaver.charts.ScaleChart.getColumnWidth

() Number

Inherited from twaver.charts.ScaleChart:

获取显示的列的宽度，TWaver内部会调用此方法。

Returns:

Number:

列的宽度

twaver.charts.ScaleChart.getLowerLimit

() Number

Inherited from twaver.charts.ScaleChart:

获取图表上限制的最小值

Returns:

Number:

限制最小值

twaver.charts.ScaleChart.getMax

() Number

Inherited from twaver.charts.ScaleChart:

获取图表上网元的最大值

Returns:

Number:

最大值

twaver.charts.ScaleChart.getMin

() Number

Inherited from twaver.charts.ScaleChart:

获取图表上网元的最小值

Returns:

Number:

最小值

twaver.charts.ScaleChart.getRange

() String

Inherited from twaver.charts.ScaleChart:

最大、最小值之间的差值，取的是Max-Min

Returns:

String:

最大、最小值之间的差值

twaver.charts.ScaleChart.getUpperLimit

() String

Inherited from twaver.charts.ScaleChart:

获取图表上限制显示的最大值

Returns:

String:

twaver.charts.ScaleChart.getValues

(
  • data
)
twaver.List

Inherited from twaver.charts.ScaleChart:

获取指定数据值的集合，取的是data中的chart.values的样式值

Parameters:

Returns:

twaver.List:

数据对象图表上值的集合

twaver.charts.ScaleChart.getValueSpanCount

() Number

Inherited from twaver.charts.ScaleChart:

获取最大Span数量

Returns:

Number:

最大Span数量

twaver.charts.ScaleChart.getXAxisLineColor

() String

Inherited from twaver.charts.ScaleChart:

获取图表上X轴线的颜色

Returns:

String:

X轴线的颜色

twaver.charts.ScaleChart.getXAxisLineWidth

() Number

Inherited from twaver.charts.ScaleChart:

获取图表上X轴线的宽度

Returns:

Number:

X轴线的宽度

twaver.charts.ScaleChart.getXAxisText

() String

Inherited from twaver.charts.ScaleChart:

获取图表上X轴的显示文字

Returns:

String:

X轴的显示文字

twaver.charts.ScaleChart.getXAxisTextColor

() String

Inherited from twaver.charts.ScaleChart:

获取图表上X轴的显示文字的颜色

Returns:

String:

X轴显示文字的颜色

twaver.charts.ScaleChart.getXAxisTextFont

() String

Inherited from twaver.charts.ScaleChart:

获取图表上X轴的显示文字的字体

Returns:

String:

X轴的显示文字的字体

twaver.charts.ScaleChart.getXScaleTextColor

() String

Inherited from twaver.charts.ScaleChart:

获取图表上X轴刻度尺上的文字显示的颜色

Returns:

String:

X轴刻度尺上文字显示颜色

twaver.charts.ScaleChart.getXScaleTextFont

() String

Inherited from twaver.charts.ScaleChart:

获取图表上X轴刻度尺上的文字显示的字体

Returns:

String:

X轴刻度尺上的文字的字体

twaver.charts.ScaleChart.getXScaleTextOrientation

() String

Inherited from twaver.charts.ScaleChart:

获取图表上X轴刻度尺上的文字显示的方向，可选值为 'horizontal'：水平 'vertical'：垂直

Returns:

String:

X轴刻度尺上的文字显示的方向

twaver.charts.ScaleChart.getXScaleTexts

() twaver.List

Inherited from twaver.charts.ScaleChart:

获取X轴上刻度尺的文字显示的内容

Returns:

twaver.List:

刻度尺的文字显示的内容集合

twaver.charts.ScaleChart.getYAxisLineColor

() String

Inherited from twaver.charts.ScaleChart:

获取图表上Y轴线的颜色

Returns:

String:

Y轴线的颜色

twaver.charts.ScaleChart.getYAxisLineWidth

() Number

Inherited from twaver.charts.ScaleChart:

获取图表上Y轴线的宽度

Returns:

Number:

Y轴线的宽度

twaver.charts.ScaleChart.getYAxisText

() String

Inherited from twaver.charts.ScaleChart:

获取图表上Y轴的显示文字

Returns:

String:

Y轴的显示文字

twaver.charts.ScaleChart.getYAxisTextColor

() String

Inherited from twaver.charts.ScaleChart:

获取图表上Y轴的文字显示的颜色

Returns:

String:

Y轴的文字显示的颜色

twaver.charts.ScaleChart.getYAxisTextFont

() String

Inherited from twaver.charts.ScaleChart:

获取图表上Y轴的文字显示的字体

Returns:

String:

Y轴的文字显示的字体

twaver.charts.ScaleChart.getYScaleLineColor

() String

Inherited from twaver.charts.ScaleChart:

获取图表上Y轴刻度线的颜色

Returns:

String:

Y轴刻度线的颜色

twaver.charts.ScaleChart.getYScaleLineWidth

() Number

Inherited from twaver.charts.ScaleChart:

获取图表上Y轴刻度线的宽度

Returns:

Number:

Y轴刻度线的宽度

twaver.charts.ScaleChart.getYScalePixelGap

() Number

Inherited from twaver.charts.ScaleChart:

获取图表上Y轴刻度之间的间隙像素值，当没有设置Y轴刻度值之间的间距时，这个参数生效

Returns:

Number:

Y轴刻度之间的间隙像素值

twaver.charts.ScaleChart.getYScaleTextColor

() String

Inherited from twaver.charts.ScaleChart:

获取图表上Y轴刻度尺上的文字显示的颜色

Returns:

String:

Y轴刻度尺上的文字显示的颜色

twaver.charts.ScaleChart.getYScaleTextFont

() String

Inherited from twaver.charts.ScaleChart:

获取图表上Y轴刻度尺上的文字显示的字体

Returns:

String:

Y轴刻度尺上的文字显示的字体

twaver.charts.ScaleChart.getYScaleValueGap

() Number

Inherited from twaver.charts.ScaleChart:

获取图表上Y轴刻度值之间的间距

Returns:

Number:

Y轴刻度值之间的间距

twaver.charts.ScaleChart.isYScaleMinTextVisible

() Boolean

Inherited from twaver.charts.ScaleChart:

判断图表上Y轴上最小刻度值是否可见

Returns:

Boolean:

true为可见，否则为false

twaver.charts.ScaleChart.isYScaleTextVisible

() Boolean

Inherited from twaver.charts.ScaleChart:

判断图表上Y轴上的刻度值是否可见

Returns:

Boolean:

true为可见，否则为false

twaver.charts.ScaleChart.setLowerLimit

(
  • v
)

Inherited from twaver.charts.ScaleChart:

设置图表上限制显示的最小值

Parameters:

  • v Number

    限制显示的最小值

twaver.charts.ScaleChart.setUpperLimit

(
  • v
)

Inherited from twaver.charts.ScaleChart:

设置图表上限制显示的最大值

Parameters:

  • v Number

    限制显示的最大值

twaver.charts.ScaleChart.setValueSpanCount

(
  • v
)

Inherited from twaver.charts.ScaleChart:

设置最大Span数量

Parameters:

  • v String

    最大Span数量

twaver.charts.ScaleChart.setXAxisLineColor

(
  • v
)

Inherited from twaver.charts.ScaleChart:

设置图表上X轴线的颜色

Parameters:

  • v String

    X轴线的颜色

twaver.charts.ScaleChart.setXAxisLineWidth

(
  • v
)

Inherited from twaver.charts.ScaleChart:

设置图表上X轴线的宽度

Parameters:

  • v Number

    X轴线的宽度

twaver.charts.ScaleChart.setXAxisText

(
  • v
)

Inherited from twaver.charts.ScaleChart:

设置图表上X轴的显示文字

Parameters:

  • v String

    X轴的显示文字

twaver.charts.ScaleChart.setXAxisTextColor

(
  • v
)

Inherited from twaver.charts.ScaleChart:

设置图表上X轴的显示文字的颜色

Parameters:

  • v String

    X轴显示文字的颜色

twaver.charts.ScaleChart.setXAxisTextFont

(
  • v
)

Inherited from twaver.charts.ScaleChart:

设置图表上X轴的显示文字的字体

Parameters:

  • v String

    X轴的显示文字的字体

twaver.charts.ScaleChart.setXScaleTextColor

(
  • v
)

Inherited from twaver.charts.ScaleChart:

设置图表上X轴刻度尺上的文字显示的颜色

Parameters:

  • v String

    X轴刻度尺上文字显示颜色

twaver.charts.ScaleChart.setXScaleTextFont

(
  • v
)

Inherited from twaver.charts.ScaleChart:

设置图表上X轴刻度尺上的文字显示的字体

Parameters:

  • v String

    X轴刻度尺上的文字的字体

twaver.charts.ScaleChart.setXScaleTextOrientation

(
  • v
)

Inherited from twaver.charts.ScaleChart:

设置图表上X轴刻度尺上的文字显示的方向，可选值为 'horizontal'：水平 'vertical'：垂直

Parameters:

  • v String

    X轴刻度尺上的文字显示的方向

twaver.charts.ScaleChart.setXScaleTexts

(
  • v
)

Inherited from twaver.charts.ScaleChart:

设置X轴上刻度尺的文字显示的内容

Parameters:

  • v twaver.List

    刻度尺的文字显示的内容集合

twaver.charts.ScaleChart.setYAxisLineColor

(
  • v
)

Inherited from twaver.charts.ScaleChart:

设置图表上Y轴线的颜色

Parameters:

  • v String

    Y轴线的颜色

twaver.charts.ScaleChart.setYAxisLineWidth

(
  • v
)

Inherited from twaver.charts.ScaleChart:

设置图表上Y轴线的宽度

Parameters:

  • v Number

    Y轴线的宽度

twaver.charts.ScaleChart.setYAxisText

(
  • v
)

Inherited from twaver.charts.ScaleChart:

设置图表上Y轴的显示文字

Parameters:

  • v String

    Y轴的显示文字

twaver.charts.ScaleChart.setYAxisTextColor

(
  • v
)

Inherited from twaver.charts.ScaleChart:

设置图表上Y轴的文字显示的颜色

Parameters:

  • v String

    Y轴的文字显示的颜色

twaver.charts.ScaleChart.setYAxisTextFont

(
  • v
)

Inherited from twaver.charts.ScaleChart:

设置图表上Y轴的文字显示的字体

Parameters:

  • v String

    Y轴的文字显示的字体

twaver.charts.ScaleChart.setYScaleLineColor

(
  • v
)

Inherited from twaver.charts.ScaleChart:

设置图表上Y轴刻度线的颜色

Parameters:

  • v String

    Y轴刻度线的颜色

twaver.charts.ScaleChart.setYScaleLineWidth

(
  • v
)

Inherited from twaver.charts.ScaleChart:

设置图表上Y轴刻度线的宽度

Parameters:

  • v Number

    Y轴刻度线的宽度

twaver.charts.ScaleChart.setYScaleMinTextVisible

(
  • v
)

Inherited from twaver.charts.ScaleChart:

设置图表上Y轴上最小刻度值是否可见

Parameters:

  • v Boolean

    true为可见，否则为false

twaver.charts.ScaleChart.setYScalePixelGap

(
  • v
)

Inherited from twaver.charts.ScaleChart:

设置图表上Y轴刻度之间的间隙像素值，当没有设置Y轴刻度值之间的间距时，这个参数生效

Parameters:

  • v Number

    Y轴刻度之间的间隙像素值

twaver.charts.ScaleChart.setYScaleTextColor

(
  • v
)

Inherited from twaver.charts.ScaleChart:

设置图表上Y轴刻度尺上的文字显示的颜色

Parameters:

  • v String

    Y轴刻度尺上的文字显示的颜色

twaver.charts.ScaleChart.setYScaleTextFont

(
  • v
)

Inherited from twaver.charts.ScaleChart:

设置图表上Y轴刻度尺上的文字显示的字体

Parameters:

  • v String

    Y轴刻度尺上的文字显示的字体

twaver.charts.ScaleChart.setYScaleTextVisible

(
  • v
)

Inherited from twaver.charts.ScaleChart:

设置图表上Y轴上的刻度值是否可见

Parameters:

  • v Boolean

    true为可见，否则为false

twaver.charts.ScaleChart.setYScaleValueGap

(
  • v
)

Inherited from twaver.charts.ScaleChart:

设置图表上Y轴刻度值之间的间距

Parameters:

  • v Number

    Y轴刻度值之间的间距

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