HighchartsXAxisPlotBandsOptions class

An array of colored bands stretching across the plot area marking an interval on the axis.

In styled mode, the plot bands are styled by the .highcharts-plot-band class in addition to the className option.

API Docs: https://api.highcharts.com/highcharts/zAxis.plotBands

Inheritance

Constructors

HighchartsXAxisPlotBandsOptions.new({String? borderColor, dynamic borderRadius, double? borderWidth, String? className, String? color, HighchartsXAxisPlotBandsEventsOptions? events, dynamic from, String? id, HighchartsXAxisPlotBandsLabelOptions? label, dynamic to, double? zIndex})
An array of colored bands stretching across the plot area marking an interval on the axis.

Properties

borderColor ↔ String?
Border color for the plot band. Also requires borderWidth to be set.
getter/setter pair
borderRadius ↔ dynamic
Border radius for the plot band. Applies only to gauges. Can be a pixel value or a percentage, for example 50%.
getter/setter pair
borderWidth ↔ double?
Border width for the plot band. Also requires borderColor to be set.
getter/setter pair
className ↔ String?
A custom class name, in addition to the default highcharts-plot-band, to apply to each individual band.
getter/setter pair
color ↔ String?
The color of the plot band.
getter/setter pair
events ↔ HighchartsXAxisPlotBandsEventsOptions?
An object defining mouse events for the plot band. Supported properties are click, mouseover, mouseout, mousemove.
getter/setter pair
from ↔ dynamic
The start position of the plot band in axis units.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
id ↔ String?
An id used for identifying the plot band in Axis.removePlotBand.
getter/setter pair
label ↔ HighchartsXAxisPlotBandsLabelOptions?
Text labels for the plot bands
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
to ↔ dynamic
The end position of the plot band in axis units.
getter/setter pair
zIndex ↔ double?
The z index of the plot band within the chart, relative to other elements. Using the same z index as another element may give unpredictable results, as the last rendered element will be on top. Values from 0 to 20 make sense.
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