dojox/charting/plot2d/_PlotEvents (version 1.10)

Usage

var foo = new _PlotEvents();
dojox/charting/plot2d/_PlotEvents

Method Summary

  • _connectEvents(o)
  • _connectSingleEvent(o,eventName)
  • _reconnectEvents(seriesName)
  • connect(object,method) Helper function to connect any object's method to our plotEvent.
  • destroy() Destroy any internal elements and event handlers.
  • events() Find out if any event handlers have been connected to our plotEvent.
  • fireEvent(seriesName,eventName,index,eventObject) Emulates firing an event for a given data value (specified by an index) of a given series.
  • plotEvent(o) Stub function for use by specific plots.
  • raiseEvent(o) Raises events in predefined order
  • resetEvents() Reset all events attached to our plotEvent (i.e. disconnect).

Methods

_connectEvents(o)
Parameter Type Description
o undefined
_connectSingleEvent(o,eventName)
Parameter Type Description
o undefined
eventName undefined
_reconnectEvents(seriesName)
Parameter Type Description
seriesName undefined
connect(object,method)

Helper function to connect any object's method to our plotEvent.

Parameter Type Description
object Object

The object to connect to.

method String | Function

The method to fire when our plotEvent is fired.

Returns:Array | undefined

The handle as returned from dojo.connect (see dojo.connect).

destroy()

Destroy any internal elements and event handlers.

events()

Find out if any event handlers have been connected to our plotEvent.

Returns:Boolean | boolean

A flag indicating that there are handlers attached.

fireEvent(seriesName,eventName,index,eventObject)

Emulates firing an event for a given data value (specified by an index) of a given series.

Parameter Type Description
seriesName String

Series name.

eventName String

Event name to emulate.

index Number

Valid data value index used to raise an event.

eventObject Object
Optional

Optional event object. Especially useful for synthetic events. Default: null.

plotEvent(o)

Stub function for use by specific plots.

Parameter Type Description
o Object

An object intended to represent event parameters.

raiseEvent(o)

Raises events in predefined order

Parameter Type Description
o Object

An object intended to represent event parameters.

resetEvents()

Reset all events attached to our plotEvent (i.e. disconnect).

Error in the documentation? Can’t find what you are looking for? Let us know!