HighchartsXAxisScrollbarOptions class
An optional scrollbar to display on the X axis in response to limiting the minimum and maximum of the axis values.
In styled mode, all the presentational options for the scrollbar are
replaced by the classes .highcharts-scrollbar-thumb
,
.highcharts-scrollbar-arrow
, .highcharts-scrollbar-button
,
.highcharts-scrollbar-rifles
and .highcharts-scrollbar-track
.
API Docs: https://api.highcharts.com/highstock/xAxis.scrollbar
- Inheritance
-
- Object
- HighchartsOptionsBase
- HighchartsXAxisScrollbarOptions
Constructors
- HighchartsXAxisScrollbarOptions.new({String? barBackgroundColor, String? barBorderColor, double? barBorderRadius, double? barBorderWidth, String? buttonArrowColor, String? buttonBackgroundColor, String? buttonBorderColor, double? buttonBorderRadius, double? buttonBorderWidth, bool? buttonsEnabled, bool? enabled, double? height, bool? liveRedraw, double? margin, double? minWidth, bool? opposite, String? rifleColor, bool? showFull, String? trackBackgroundColor, String? trackBorderColor, double? trackBorderRadius, double? trackBorderWidth, double? zIndex})
- An optional scrollbar to display on the X axis in response to limiting the minimum and maximum of the axis values.
Properties
- barBackgroundColor ↔ String?
-
The background color of the scrollbar itself.
getter/setter pair
- barBorderColor ↔ String?
-
The color of the scrollbar's border.
getter/setter pair
- barBorderRadius ↔ double?
-
The border rounding radius of the bar.
getter/setter pair
- barBorderWidth ↔ double?
-
The width of the bar's border.
getter/setter pair
-
The color of the small arrow inside the scrollbar buttons.
getter/setter pair
-
The color of scrollbar buttons.
getter/setter pair
-
The color of the border of the scrollbar buttons.
getter/setter pair
-
The corner radius of the scrollbar buttons.
getter/setter pair
-
The border width of the scrollbar buttons.
getter/setter pair
-
Enable or disable the buttons at the end of the scrollbar.
getter/setter pair
- enabled ↔ bool?
-
Enable or disable the scrollbar.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- height ↔ double?
-
The height of the scrollbar. If
buttonsEnabled
is true , the height also applies to the width of the scroll arrows so that they are always squares.getter/setter pair - liveRedraw ↔ bool?
-
Whether to redraw the main chart as the scrollbar or the navigator
zoomed window is moved. Defaults to
true
for modern browsers andfalse
for legacy IE browsers as well as mobile devices.getter/setter pair - margin ↔ double?
-
The margin between the scrollbar and its axis when the scrollbar is
applied directly to an axis, or the navigator in case that is enabled.
Defaults to 10 for axis, 3 for navigator.
getter/setter pair
- minWidth ↔ double?
-
The minimum width of the scrollbar.
getter/setter pair
- opposite ↔ bool?
-
Defines the position of the scrollbar. By default, it is positioned
on the opposite of the main axis (right side of the chart).
However, in the case of RTL languages could be set to
false
which positions the scrollbar on the left.getter/setter pair - rifleColor ↔ String?
-
The color of the small rifles in the middle of the scrollbar.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showFull ↔ bool?
-
Whether to show or hide the scrollbar when the scrolled content is
zoomed out to it full extent.
getter/setter pair
- trackBackgroundColor ↔ String?
-
The color of the track background.
getter/setter pair
- trackBorderColor ↔ String?
-
The color of the border of the scrollbar track.
getter/setter pair
- trackBorderRadius ↔ double?
-
The corner radius of the border of the scrollbar track.
getter/setter pair
- trackBorderWidth ↔ double?
-
The width of the border of the scrollbar track.
getter/setter pair
- zIndex ↔ double?
-
The z index of the scrollbar group.
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