HighchartsAnnotationsOptions class

A basic type of an annotation. It allows to add custom labels or shapes. The items can be tied to points, axis coordinates or chart pixel coordinates.

API Docs: https://api.highcharts.com/highcharts/annotations

Inheritance

Constructors

HighchartsAnnotationsOptions.new({HighchartsAnnotationsAnimationOptions? animation, HighchartsAnnotationsControlPointOptions? controlPointOptions, HighchartsAnnotationsCrookedLineOptions? crookedLine, bool? crop, String? draggable, HighchartsAnnotationsElliottWaveOptions? elliottWave, HighchartsAnnotationsEventsOptions? events, HighchartsAnnotationsFibonacciOptions? fibonacci, HighchartsAnnotationsFibonacciTimeZonesOptions? fibonacciTimeZones, dynamic id, HighchartsAnnotationsInfinityLineOptions? infinityLine, HighchartsAnnotationsLabelOptions? labelOptions, List<HighchartsAnnotationsLabelsOptions>? labels, HighchartsAnnotationsMeasureOptions? measure, HighchartsAnnotationsPitchforkOptions? pitchfork, HighchartsAnnotationsShapeOptions? shapeOptions, List<HighchartsAnnotationsShapesOptions>? shapes, HighchartsAnnotationsTimeCyclesOptions? timeCycles, HighchartsAnnotationsTunnelOptions? tunnel, HighchartsAnnotationsVerticalLineOptions? verticalLine, bool? visible, double? zIndex})
A basic type of an annotation. It allows to add custom labels or shapes. The items can be tied to points, axis coordinates or chart pixel coordinates.

Properties

animation ↔ HighchartsAnnotationsAnimationOptions?
Enable or disable the initial animation when a series is displayed for the annotation. The animation can also be set as a configuration object. Please note that this option only applies to the initial animation. For other animations, see chart.animation and the animation parameter under the API methods. The following properties are supported:
getter/setter pair
controlPointOptions ↔ HighchartsAnnotationsControlPointOptions?
Options for annotation's control points. Each control point inherits options from controlPointOptions object. Options from the controlPointOptions can be overwritten by options in a specific control point.
getter/setter pair
crookedLine ↔ HighchartsAnnotationsCrookedLineOptions?
A crooked line annotation.
getter/setter pair
crop ↔ bool?
Whether to hide the part of the annotation that is outside the plot area.
getter/setter pair
draggable ↔ String?
Allow an annotation to be draggable by a user. Possible values are 'x', 'xy', 'y' and '' (disabled).
getter/setter pair
elliottWave ↔ HighchartsAnnotationsElliottWaveOptions?
An elliott wave annotation.
getter/setter pair
events ↔ HighchartsAnnotationsEventsOptions?
Events available in annotations.
getter/setter pair
fibonacci ↔ HighchartsAnnotationsFibonacciOptions?
A fibonacci annotation.
getter/setter pair
fibonacciTimeZones ↔ HighchartsAnnotationsFibonacciTimeZonesOptions?
The Fibonacci Time Zones annotation.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
id ↔ dynamic
Sets an ID for an annotation. Can be user later when removing an annotation in Chart#removeAnnotation(id) method.
getter/setter pair
infinityLine ↔ HighchartsAnnotationsInfinityLineOptions?
An infinity line annotation.
getter/setter pair
labelOptions ↔ HighchartsAnnotationsLabelOptions?
Options for annotation's labels. Each label inherits options from the labelOptions object. An option from the labelOptions can be overwritten by config for a specific label.
getter/setter pair
labels ↔ List<HighchartsAnnotationsLabelsOptions>?
An array of labels for the annotation. For options that apply to multiple labels, they can be added to the labelOptions.
getter/setter pair
measure ↔ HighchartsAnnotationsMeasureOptions?
A measure annotation.
getter/setter pair
pitchfork ↔ HighchartsAnnotationsPitchforkOptions?
A pitchfork annotation.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shapeOptions ↔ HighchartsAnnotationsShapeOptions?
Options for annotation's shapes. Each shape inherits options from the shapeOptions object. An option from the shapeOptions can be overwritten by config for a specific shape.
getter/setter pair
shapes ↔ List<HighchartsAnnotationsShapesOptions>?
An array of shapes for the annotation. For options that apply to multiple shapes, then can be added to the shapeOptions.
getter/setter pair
timeCycles ↔ HighchartsAnnotationsTimeCyclesOptions?
The TimeCycles Annotation
getter/setter pair
tunnel ↔ HighchartsAnnotationsTunnelOptions?
A tunnel annotation.
getter/setter pair
verticalLine ↔ HighchartsAnnotationsVerticalLineOptions?
A vertical line annotation.
getter/setter pair
visible ↔ bool?
Whether the annotation is visible.
getter/setter pair
zIndex ↔ double?
The Z index of the annotation.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJSON() → String
Serializes the settings to a JSON string.
inherited
toOptionsJSON(StringBuffer buffer) → void
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited