HighchartsAnnotationsLabelsOptions class

An array of labels for the annotation. For options that apply to multiple labels, they can be added to the labelOptions.

API Docs: https://api.highcharts.com/highcharts/navigation.bindings.verticalLine.annotationsOptions.labels

Inheritance

Constructors

HighchartsAnnotationsLabelsOptions({HighchartsAnnotationsLabelsControlPointsOptions? controlPoints, dynamic point, HighchartsAnnotationsLabelAccessibilityOptions? accessibility, String? align, bool? allowOverlap, String? backgroundColor, String? borderColor, double? borderRadius, double? borderWidth, String? className, bool? crop, double? distance, String? format, String? formatter, bool? includeInDataExport, String? overflow, double? padding, Map<String, dynamic>? shadow, String? shape, Map<String, String>? style, String? text, bool? useHTML, String? verticalAlign, double? x, double? y})
An array of labels for the annotation. For options that apply to multiple labels, they can be added to the labelOptions.

Properties

accessibility ↔ HighchartsAnnotationsLabelAccessibilityOptions?
Accessibility options for an annotation label.
getter/setter pair
align ↔ String?
The alignment of the annotation's label. If right, the right side of the label should be touching the point.
getter/setter pair
allowOverlap ↔ bool?
Whether to allow the annotation's labels to overlap. To make the labels less sensitive for overlapping, the can be set to 0.
getter/setter pair
backgroundColor ↔ String?
The background color or gradient for the annotation's label.
getter/setter pair
borderColor ↔ String?
The border color for the annotation's label.
getter/setter pair
borderRadius ↔ double?
The border radius in pixels for the annotation's label.
getter/setter pair
borderWidth ↔ double?
The border width in pixels for the annotation's label.
getter/setter pair
className ↔ String?
A class name for styling by CSS.
getter/setter pair
controlPoints ↔ HighchartsAnnotationsLabelsControlPointsOptions?
The array of control points.
getter/setter pair
crop ↔ bool?
Whether to hide the annotation's label that is outside the plot area.
getter/setter pair
distance ↔ double?
The label's pixel distance from the point.
getter/setter pair
format ↔ String?
A format string for the data label.
getter/setter pair
formatter ↔ String?
Callback JavaScript function to format the annotation's label. Note that if a format or text are defined, the format or text take precedence and the formatter is ignored. This refers to a point object. The callback also receives an argument ctx so that arrow-functions can access the same context (the point in this case) as normal functions can using this. Since v12.6.0, the callback receives ctx.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
includeInDataExport ↔ bool?
Whether all the labels for an annotation are visible in the exported data table.
getter/setter pair
overflow ↔ String?
How to handle the annotation's label that flow outside the plot area. The justify option aligns the label inside the plot area.
getter/setter pair
padding ↔ double?
When either the borderWidth or the backgroundColor is set, this is the padding within the box.
getter/setter pair
point ↔ dynamic
This option defines the point to which the label 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
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shadow ↔ Map<String, dynamic>?
The shadow of the box. The shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.
getter/setter pair
shape ↔ String?
The name of a symbol to use for the border around the label. Symbols are predefined functions on the Renderer object.
getter/setter pair
style ↔ Map<String, String>?
Styles for the annotation's label.
getter/setter pair
text ↔ String?
Alias for the format option.
getter/setter pair
useHTML ↔ bool?
Whether to use HTML to render the annotation's label.
getter/setter pair
verticalAlign ↔ String?
The vertical alignment of the annotation's label.
getter/setter pair
x ↔ double?
The x position offset of the label relative to the point. Note that if a distance is defined, the distance takes precedence over x and y options.
getter/setter pair
y ↔ double?
The y position offset of the label relative to the point. Note that if a distance is defined, the distance takes precedence over x and y options.
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