Component Events
The annotate, measure, and range brush interaction modes fire component events that allow athe userimplementation to provideof 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 by right-clicking on an annotation's dot or info box or 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 | |
| onMeasurementRemove | |
| onMeasurementSelect | |
| onMeasurementUpdate | |
| onMeasurementVisible |
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 | |
| onRangeBrushRemove | |
| onRangeBrushSelect | |
| onRangeBrushUpdate |
Range Brush Event Properties
| Name | Description | Property Type |
| range | Range Instance |