Component Events

The annotate, measure, and range brush interaction modes fire component events that allow the implementation of custom functionality when a user interacts with the chart or chart element.

Annotation Events

Name	Description
onAnnotationAdd	Fires when a user adds an annotation by clicking on the chart.
onAnnotationRemove	Fires when an annotation is removed from the chart byby: ~~right-~~ Right-clicking on an annotation's dot or info ~~box~~box. ~~or clicking~~ Clicking the clear annotations menu button.
onAnnotationSelect	Fires when an annotation is selected by double-clicking on its info box.
onAnnotationUpdate	Fires when an annotation is updated by moving the dot or info box.
onAnnotationVisible	Fires when an annotation's info box is hidden or shown by double-clicking on its dot.

Annotation Event Properties

Name	Description	Property Type
annotation	Object containing uuid, axis, pen, dot, and infoBox properties of the annotation instance the event refers to.	Annotation Instance

Measurement Events

Name	Description
onMeasurementAdd	Fires when a user adds a measurement by clicking twice in separate locations on the chart.
onMeasurementRemove	Fires when a measurement is removed from the chart by: Right-clicking on a measurement line or info box. Adding a measurement when there are already the maximum number of measurements allowed. Clicking the clear measurements menu button.
onMeasurementSelect	Fires when a measurement is selected by double-clicking on its info box.
onMeasurementUpdate	Fires when a measurement is updated by changing the line coordinates or moving the info box.
onMeasurementVisible	Fires when a measurement's info box is hidden or shown by double-clicking on its line.

Measurement Event Properties

Name	Description	Property Type
measurement	Object containing axis, line, and infoBox properties of the measurement instance the event refers to.	Measurement Instance

Range Brush Events

Name	Description
onRangeBrushAdd	Fires when a user adds a range brush by clicking twice in separate locations on the chart.
onRangeBrushRemove	Fires when a range brush is removed from the chart by: Right-clicking on a range brush. Adding a range brush when there are already the maximum number of range brushes allowed. Clicking the clear range brushes menu button.
onRangeBrushSelect	Fires when a range brush is selected by double-clicking on its info box.
onRangeBrushUpdate	Fires when a range brush is updated by changing the range coordinates.

Range Brush Event Properties

Name	Description	Property Type
range	Array of objects containing xAxis, start, and end properties of the range brush instance the event refers to for each x-axis configured on the chart.	Range ~~Instance~~Instance[]

Back to top