HighchartsXAxisCrosshairLabelOptions class
A label on the axis next to the crosshair.
In styled mode, the label is styled with the
.highcharts-crosshair-label
class.
API Docs: https://api.highcharts.com/highstock/yAxis.crosshair.label
- Inheritance
-
- Object
- HighchartsOptionsBase
- HighchartsXAxisCrosshairLabelOptions
Constructors
-
HighchartsXAxisCrosshairLabelOptions.new({String? align, String? backgroundColor, String? borderColor, double? borderRadius, double? borderWidth, bool? enabled, String? format, HighchartsCallback? formatter, double? padding, String? shape, Map<
String, String> ? style}) - A label on the axis next to the crosshair.
Properties
- align ↔ String?
-
Alignment of the label compared to the axis. Defaults to
"left"
for right-side axes,"right"
for left-side axes and"center"
for horizontal axes.getter/setter pair - backgroundColor ↔ String?
-
The background color for the label. Defaults to the related series
color, or
#666666
if that is not available.getter/setter pair - borderColor ↔ String?
-
The border color for the crosshair label
getter/setter pair
- borderRadius ↔ double?
-
The border corner radius of the crosshair label.
getter/setter pair
- borderWidth ↔ double?
-
The border width for the crosshair label.
getter/setter pair
- enabled ↔ bool?
-
Flag to enable crosshair's label.
getter/setter pair
- format ↔ String?
-
A format string for the crosshair label. Defaults to
{value}
for numeric axes and{value:%b %d, %Y}
for datetime axes.getter/setter pair - formatter ↔ HighchartsCallback?
-
Formatter function for the label text.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- padding ↔ double?
-
Padding inside the crosshair label.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- shape ↔ String?
-
The shape to use for the label box.
getter/setter pair
-
style
↔ Map<
String, String> ? -
Text styles for the crosshair label.
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