HighchartsXAxisPlotLinesLabelOptions class

Text labels for the plot lines

API Docs: https://api.highcharts.com/highcharts/xAxis.plotLines.label

Inheritance

Constructors

HighchartsXAxisPlotLinesLabelOptions({String? align, HighchartsCallback? formatter, double? rotation, Map<String, String>? style, String? text, String? textAlign, bool? useHTML, String? verticalAlign, double? x, double? y})
Text labels for the plot lines

Properties

align ↔ String?
Horizontal alignment of the label. Can be one of "left", "center" or "right".
getter/setter pair
formatter ↔ HighchartsCallback?
Callback JavaScript function to format the label. Useful properties like the value of plot line or the range of plot band (from & to properties) can be found in this.options object. Since v12.6.0, the callback also receives ctx as the first argument, so that arrow functions can access the same context as regular functions using this.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
rotation ↔ double?
Rotation of the text label in degrees. Defaults to 0 for horizontal plot lines and 90 for vertical lines.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
style ↔ Map<String, String>?
CSS styles for the text label.
getter/setter pair
text ↔ String?
The text itself. A subset of HTML is supported.
getter/setter pair
textAlign ↔ String?
The text alignment for the label. While align determines where the texts anchor point is placed within the plot band, textAlign determines how the text is aligned against its anchor point. Possible values are "left", "center" and "right". Defaults to the same as the align option.
getter/setter pair
useHTML ↔ bool?
Whether to use HTML to render the labels.
getter/setter pair
verticalAlign ↔ String?
Vertical alignment of the label relative to the plot line. Can be one of "top", "middle" or "bottom".
getter/setter pair
x ↔ double?
Horizontal position relative the alignment. Default varies by orientation.
getter/setter pair
y ↔ double?
Vertical position of the text baseline relative to the alignment. Default varies by orientation.
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