API Docs for: TWaver HTML5 5.7.5
Show:

twaver.charts.LegendPane Class

Extends twaver.controls.ControlBase

图例面板

是用于辅助Chart来显示的，它默认是显示在Chart的下方，显示Chart上所有的网元信息

Constructor

twaver.charts.LegendPane

(
  • chart
)
twaver.charts.LegendPane

Parameters:

Returns:

twaver.charts.LegendPane:

图例面板本身

Item Index

Methods

Methods

twaver.charts.LegendPane.getChart

() twaver.charts.ChartBase

获取和这个图例面板绑定的Chart

Returns:

twaver.charts.ChartBase:

绑定的Chart

twaver.charts.LegendPane.getHiddenColor

() String

获取图例面板上被隐藏的网元颜色

Returns:

String:

被隐藏的网元颜色

twaver.charts.LegendPane.getIconHeight

() Number

获取图例上网元图标的高度

Returns:

Number:

图例上网元图标的高度

twaver.charts.LegendPane.getIconRadius

() Number

设置图例面板上图标的圆角弧度，默认为0

Returns:

Number:

图标的圆角弧度

twaver.charts.LegendPane.getIconWidth

() Number

获取图例上网元图标的宽度

Returns:

Number:

图例上网元图标的宽度

twaver.charts.LegendPane.getOrientation

() String

获取图例面板显示实现的方向，默认为水平显示。方向的可选值为： 'horizontal'：水平 'vertical'：垂直

Returns:

String:

图例面板显示实现的方向

twaver.charts.LegendPane.getRowHeight

() Number

获取图例面板的行高

Returns:

Number:

图例面板的行高

twaver.charts.LegendPane.getSelectBackgroundColor

() String

获取选中网元时图例对于元素的背景色

Returns:

String:

选中网元时图例对于元素的背景色

twaver.charts.LegendPane.getSelectForegroundColor

() String

获取选中网元时图例对于元素的前景色

Returns:

String:

选中网元时图例对于元素的前景色

twaver.charts.LegendPane.handleViewChange

(
  • e
)

当图例面板上绑定的Chart更改时，会调用此方法，这个方法用于刷新图例面板

Parameters:

  • e Object

    Chart视图的变化事件

twaver.charts.LegendPane.isHidden

(
  • data
)
Boolean

获取图例面板上指定的网元是否隐藏

Parameters:

Returns:

Boolean:

true为隐藏，false不隐藏

twaver.charts.LegendPane.onLegendRendered

(
  • div
  • data
)

当绘制图例面板时会调用此方法，此方法的默认实现为空。用户不需要调用此方法，但可以重载此方法执行自定义逻辑

Parameters:

  • div Object

    包含图例上网元元素的面板

  • data twaver.Data

    指定的图例上的网元元素

twaver.charts.LegendPane.renderLegend

(
  • div
  • data
)

在指定的div层上绘制指定数据的图例

Parameters:

twaver.charts.LegendPane.setHiddenColor

(
  • v
)

设置图例面板上被隐藏的网元颜色

Parameters:

  • v String

    被隐藏的网元颜色

twaver.charts.LegendPane.setIconHeight

(
  • v
)

设置图例上网元图标的高度

Parameters:

  • v Number

    图例上网元图标的高度

twaver.charts.LegendPane.setIconRadius

(
  • v
)

获取图例面板上图标的圆角弧度，默认为0

Parameters:

  • v Number

    图标的圆角弧度

twaver.charts.LegendPane.setIconWidth

(
  • v
)

设置图例上网元图标的宽度

Parameters:

  • v Number

    图例上网元图标的宽度

twaver.charts.LegendPane.setOrientation

(
  • v
)

设置图例面板显示的方向，默认为水平显示。方向的可选值为： 'horizontal'：水平 'vertical'：垂直

Parameters:

  • v String

    图例面板显示的方向

twaver.charts.LegendPane.setRowHeight

(
  • v
)

设置图例面板的行高

Parameters:

  • v Number

    图例面板的行高

twaver.charts.LegendPane.setSelectBackgroundColor

(
  • v
)

设置选中网元时图例对于元素的背景色

Parameters:

  • v String

    选中网元时图例对于元素的背景色

twaver.charts.LegendPane.setSelectForegroundColor

(
  • v
)

设置选中网元时图例对于元素的前景色

Parameters:

  • v String

    选中网元时图例对于元素的前景色

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