dojox/charting/action2d/MouseIndicator (version 1.10)

dojox/charting/action2d/ChartAction

Summary

Create a mouse indicator action. You can drag mouse over the chart to display a data indicator.

Usage

var foo = new MouseIndicator(chart,plot,kwArgs);
dojox/charting/action2d/MouseIndicator
Parameter Type Description
chart dojox/charting/Chart

The chart this action applies to.

plot undefined
kwArgs Object
Optional

Optional arguments for the chart action.

Property Summary

Method Summary

Event Summary

Properties

defaultParams
optionalParams

Methods

_disconnectHandles()
connect()

Connect this action to the chart. This adds a indicator plot to the chart that's why Chart.render() must be called after connect.

destroy()

Do any cleanup needed when destroying parent elements.

disconnect()

Disconnect this action from the chart.

emit(type,event)
Defined by dojo/Evented
Parameter Type Description
type undefined
event undefined
Returns:undefined
on(type,listener)
Defined by dojo/Evented
Parameter Type Description
type undefined
listener undefined
Returns:undefined

Events

_onMouseSingle(event)
Parameter Type Description
event undefined
onChange(event)

Called when the indicator value changed.

Parameter Type Description
event undefined

An event with a start property containing the {x, y} data points of the mouse indicator. It also contains a label property containing the displayed text.

onMouseDown(event)

Called when mouse is down on the chart.

Parameter Type Description
event undefined
onMouseMove(event)

Called when the mouse is moved on the chart.

Parameter Type Description
event undefined
onMouseUp(event)

Called when mouse is up on the chart.

Parameter Type Description
event undefined
Error in the documentation? Can’t find what you are looking for? Let us know!