Annotations
Annotations let you create your own custom objects within charts. One can create various shapes like polygons, rectangles, circles, arcs, etc., render annotation text at required positions, load external images and much more.
Events
annotationClick
Fired when an annotation is clicked
Parameters
x-coordinate of the pointer relative to the chart.
y-coordinate of the pointer relative to the chart.
x-coordinate of the pointer relative to the page.
y-coordinate of the pointer relative to the page.
Specifies the Id of the annotation (if provided during annotation creation).
contains all the options that are set on the annotations.
Specifies the Id of the annotation group (if provided during annotation creation) within which the annotation exists.
contains all the options that are set on the annotation group.
annotationRollOver
Fired when the pointer moves over an annotation
Parameters
x-coordinate of the pointer relative to the chart.
y-coordinate of the pointer relative to the chart.
x-coordinate of the pointer relative to the page.
y-coordinate of the pointer relative to the page.
Specifies the Id of the annotation (if provided during annotation creation).
contains all the options that are set on the annotations.
Specifies the Id of the annotation group (if provided during annotation creation) within which the annotation exists.
contains all the options that are set on the annotation group.
annotationRollOut
Fired when the pointer moves out of an annotation
Parameters
x-coordinate of the pointer relative to the chart.
y-coordinate of the pointer relative to the chart.
x-coordinate of the pointer relative to the page.
y-coordinate of the pointer relative to the page.
Specifies the Id of the annotation (if provided during annotation creation).
contains all the options that are set on the annotations.
Specifies the Id of the annotation group (if provided during annotation creation) within which the annotation exists.
contains all the options that are set on the annotation group.
Methods
addGroup
Adds a group in the annotations that acts as a container for the shapes that have to be drawn within the group. The shapes drawn within a group generally share some properties or characteristics.
Parameters
The options that pertain to the new group element to be added.
addItem
Adds an item to either a specific group or creates a new group and adds the item to it.
Parameters
If the item has to be added to a particular group then, the id of that group is required.
The options that have to used to create the item.
Specifies if the annotation item created has to be drawn immediately or not. Default value is false and does not draw the item immediately.
clear
Clears all groups and the contained shapes that belong to the annotation object.
hide
Hides the item (group or shape) with the given id.
Parameters
id: string
show
Shows the item (group or shape) with the given id.
Parameters
id: string
update
Method to dynamically update a shape or group with an id.
Parameters
destroy
Destros a particular item (group or shape) with the given id.
Parameters
id: string
Properties
this.groupsstatic member
The list of all the groups that have been rendered using the given instance of the annotations class.