HighchartsAnnotationsShapesOptions class

An array of shapes for the annotation. For options that apply to multiple shapes, then can be added to the shapeOptions.

API Docs: https://api.highcharts.com/highcharts/navigation.annotationsOptions.shapes

Inheritance

Constructors

HighchartsAnnotationsShapesOptions.new({String? markerEnd, String? markerStart, HighchartsAnnotationsShapesPointOptions? point, HighchartsAnnotationsShapesPointsOptions? points, String? src, String? dashStyle, Map<String, dynamic>? fill, double? height, double? r, double? ry, double? snap, String? stroke, double? strokeWidth, String? type, double? width, double? xAxis, double? yAxis})
An array of shapes for the annotation. For options that apply to multiple shapes, then can be added to the shapeOptions.

Properties

dashStyle ↔ String?
Name of the dash style to use for the shape's stroke.
getter/setter pair
fill ↔ Map<String, dynamic>?
The color of the shape's fill.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
height ↔ double?
The height of the shape.
getter/setter pair
markerEnd ↔ String?
Id of the marker which will be drawn at the final vertex of the path. Custom markers can be defined in defs property.
getter/setter pair
markerStart ↔ String?
Id of the marker which will be drawn at the first vertex of the path. Custom markers can be defined in defs property.
getter/setter pair
point ↔ HighchartsAnnotationsShapesPointOptions?
This option defines the point to which the shape will be connected. It can be either the point which exists in the series - it is referenced by the point's id - or a new point with defined x, y properties and optionally axes.
getter/setter pair
points ↔ HighchartsAnnotationsShapesPointsOptions?
An array of points for the shape or a callback function that returns that shape point.
getter/setter pair
r ↔ double?
The radius of the shape.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
ry ↔ double?
The radius of the shape in y direction. Used for the ellipse.
getter/setter pair
snap ↔ double?
Defines additional snapping area around an annotation making this annotation to focus. Defined in pixels.
getter/setter pair
src ↔ String?
The URL for an image to use as the annotation shape. Note, type has to be set to 'image'.
getter/setter pair
stroke ↔ String?
The color of the shape's stroke.
getter/setter pair
strokeWidth ↔ double?
The pixel stroke width of the shape.
getter/setter pair
type ↔ String?
The type of the shape. Available options are circle, rect and ellipse.
getter/setter pair
width ↔ double?
The width of the shape.
getter/setter pair
xAxis ↔ double?
The xAxis index to which the points should be attached. Used for the ellipse.
getter/setter pair
yAxis ↔ double?
The yAxis index to which the points should be attached. Used for the ellipse.
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