new Annotation(chart, userOptions)
An annotation class which serves as a container for items like labels or shapes. Created items are positioned on the chart either by linking them to existing points or created mock points.
Parameters:
| Name | Type | Description |
|---|---|---|
chart |
Highcharts.Chart | A chart instance |
userOptions |
Highcharts.AnnotationsOptions | The annotation options |
Requires:
- module:modules/annotations
Requires
- module:modules/annotations
Members
-
chart :Highcharts.Chart
-
The chart that the annotation belongs to.
Type:
-
group :Highcharts.SVGElement
-
The group svg element.
Type:
-
labelsGroup :Highcharts.SVGElement
-
The group svg element of the annotation's labels.
Type:
-
options :Highcharts.AnnotationsOptions
-
The options for the annotations.
Type:
- Highcharts.AnnotationsOptions
-
points :Array.<Highcharts.Point>
-
The array of points which defines the annotation.
Type:
- Array.<Highcharts.Point>
-
shapesGroup :Highcharts.SVGElement
-
The group svg element of the annotation's shapes.
Type:
-
userOptions :Highcharts.AnnotationsOptions
-
The user options for the annotations.
Type:
- Highcharts.AnnotationsOptions
Methods
-
update(userOptions [, redraw])
-
Updates an annotation.
Parameters:
Name Type Argument Description userOptionsHighcharts.AnnotationsOptions New user options for the annotation.
redrawboolean <optional>
Whether to redraw the chart's annotations.