HighchartsRangeSelectorOptions class

The range selector is a tool for selecting ranges to display within the chart. It provides buttons to select preconfigured ranges in the chart, like 1 day, 1 week, 1 month etc. It also provides input boxes where min and max dates can be manually input.

API Docs: https://api.highcharts.com/highstock/rangeSelector

Inheritance

Constructors

HighchartsRangeSelectorOptions.new({bool? allButtonsEnabled, HighchartsRangeSelectorButtonPositionOptions? buttonPosition, double? buttonSpacing, dynamic buttonTheme, List<HighchartsRangeSelectorButtonsOptions>? buttons, String? dropdown, bool? enabled, bool? floating, double? height, String? inputBoxBorderColor, double? inputBoxHeight, double? inputBoxWidth, String? inputDateFormat, dynamic inputDateParser, String? inputEditDateFormat, bool? inputEnabled, HighchartsRangeSelectorInputPositionOptions? inputPosition, double? inputSpacing, Map<String, String>? inputStyle, Map<String, String>? labelStyle, double? selected, String? verticalAlign, double? x, double? y})
The range selector is a tool for selecting ranges to display within the chart. It provides buttons to select preconfigured ranges in the chart, like 1 day, 1 week, 1 month etc. It also provides input boxes where min and max dates can be manually input.

Properties

allButtonsEnabled ↔ bool?
Whether to enable all buttons from the start. By default buttons are only enabled if the corresponding time range exists on the X axis, but enabling all buttons allows for dynamically loading different time ranges.
getter/setter pair
buttonPosition ↔ HighchartsRangeSelectorButtonPositionOptions?
Positioning for the button row.
getter/setter pair
buttons ↔ List<HighchartsRangeSelectorButtonsOptions>?
An array of configuration objects for the buttons.
getter/setter pair
buttonSpacing ↔ double?
The space in pixels between the buttons in the range selector.
getter/setter pair
buttonTheme ↔ dynamic
A collection of attributes for the buttons. The object takes SVG attributes like fill, stroke, stroke-width, as well as style, a collection of CSS properties for the text.
getter/setter pair
Whether to collapse the range selector buttons into a dropdown when there is not enough room to show everything in a single row, instead of dividing the range selector into multiple rows. Can be one of the following:
getter/setter pair
enabled ↔ bool?
Enable or disable the range selector. Default to true for stock charts, using the stockChart factory.
getter/setter pair
floating ↔ bool?
When the rangeselector is floating, the plot area does not reserve space for it. This opens for positioning anywhere on the chart.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
height ↔ double?
Deprecated. The height of the range selector. Currently it is calculated dynamically.
getter/setter pair
inputBoxBorderColor ↔ String?
The border color of the date input boxes.
getter/setter pair
inputBoxHeight ↔ double?
The pixel height of the date input boxes.
getter/setter pair
inputBoxWidth ↔ double?
The pixel width of the date input boxes. When undefined, the width is fitted to the rendered content.
getter/setter pair
inputDateFormat ↔ String?
The date format in the input boxes when not selected for editing. Defaults to %e %b %Y.
getter/setter pair
inputDateParser ↔ dynamic
A custom callback function to parse values entered in the input boxes and return a valid JavaScript time as milliseconds since 1970. The first argument passed is the value to parse, second is a boolean indicating use of UTC time. The third is a reference to the time object. Time zone can be read from time.timezone.
getter/setter pair
inputEditDateFormat ↔ String?
The date format in the input boxes when they are selected for editing. This must be a format that is recognized by JavaScript Date.parse.
getter/setter pair
inputEnabled ↔ bool?
Enable or disable the date input boxes.
getter/setter pair
inputPosition ↔ HighchartsRangeSelectorInputPositionOptions?
Positioning for the input boxes. Allowed properties are align, x and y.
getter/setter pair
inputSpacing ↔ double?
The space in pixels between the labels and the date input boxes in the range selector.
getter/setter pair
inputStyle ↔ Map<String, String>?
CSS for the HTML inputs in the range selector.
getter/setter pair
labelStyle ↔ Map<String, String>?
CSS styles for the labels - the Zoom, From and To texts.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selected ↔ double?
The index of the button to appear pre-selected. If the selected range exceeds the total data range and the 'all' option is available, the 'all' option, showing the full range, is automatically selected.
getter/setter pair
verticalAlign ↔ String?
The vertical alignment of the rangeselector box. Allowed properties are top, middle, bottom.
getter/setter pair
x ↔ double?
The x offset of the range selector relative to its horizontal alignment within chart.spacingLeft and chart.spacingRight.
getter/setter pair
y ↔ double?
The y offset of the range selector relative to its horizontal alignment within chart.spacingLeft and chart.spacingRight.
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