HighchartsXAxisCrosshairOptions class
Configure a crosshair that follows either the mouse pointer or the hovered point.
In styled mode, the crosshairs are styled in the
.highcharts-crosshair
, .highcharts-crosshair-thin
or
.highcharts-xaxis-category
classes.
API Docs: https://api.highcharts.com/highcharts/yAxis.crosshair
- Inheritance
-
- Object
- HighchartsOptionsBase
- HighchartsXAxisCrosshairOptions
Constructors
- HighchartsXAxisCrosshairOptions.new({String? className, String? color, String? dashStyle, HighchartsXAxisCrosshairLabelOptions? label, bool? snap, double? width, double? zIndex})
- Configure a crosshair that follows either the mouse pointer or the hovered point.
Properties
- className ↔ String?
-
A class name for the crosshair, especially as a hook for styling.
getter/setter pair
- color ↔ String?
-
The color of the crosshair. Defaults to
#cccccc
for numeric and datetime axes, andrgba(204,214,235,0.25)
for category axes, where the crosshair by default highlights the whole category.getter/setter pair - dashStyle ↔ String?
-
The dash style for the crosshair. See
plotOptions.series.dashStyle
for possible values.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- label ↔ HighchartsXAxisCrosshairLabelOptions?
-
A label on the axis next to the crosshair.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- snap ↔ bool?
-
Whether the crosshair should snap to the point or follow the pointer
independent of points.
getter/setter pair
- width ↔ double?
-
The pixel width of the crosshair. Defaults to 1 for numeric or
datetime axes, and for one category width for category axes.
getter/setter pair
- zIndex ↔ double?
-
The Z index of the crosshair. Higher Z indices allow drawing the
crosshair on top of the series or behind the grid lines.
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