HighchartsNavigatorOptions class

The navigator is a small series below the main series, displaying a view of the entire data set. It provides tools to zoom in and out on parts of the data as well as panning across the dataset.

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

Inheritance

Constructors

HighchartsNavigatorOptions.new({HighchartsNavigatorAccessibilityOptions? accessibility, bool? adaptToUpdatedData, dynamic baseSeries, bool? enabled, HighchartsNavigatorHandlesOptions? handles, double? height, double? margin, Map<String, dynamic>? maskFill, bool? maskInside, bool? opposite, String? outlineColor, double? outlineWidth, List<HighchartsNavigatorSeriesOptions>? series, bool? stickToMax, HighchartsNavigatorXAxisOptions? xAxis, HighchartsNavigatorYAxisOptions? yAxis})
The navigator is a small series below the main series, displaying a view of the entire data set. It provides tools to zoom in and out on parts of the data as well as panning across the dataset.

Properties

accessibility ↔ HighchartsNavigatorAccessibilityOptions?
Accessibility options for the navigator. Requires the Accessibility module.
getter/setter pair
adaptToUpdatedData ↔ bool?
Whether the navigator and scrollbar should adapt to updated data in the base X axis. When loading data async, as in the demo below, this should be false. Otherwise new data will trigger navigator redraw, which will cause unwanted looping. In the demo below, the data in the navigator is set only once. On navigating, only the main chart content is updated.
getter/setter pair
baseSeries ↔ dynamic
An integer identifying the index to use for the base series, or a string representing the id of the series.
getter/setter pair
enabled ↔ bool?
Enable or disable the navigator.
getter/setter pair
handles ↔ HighchartsNavigatorHandlesOptions?
Options for the handles for dragging the zoomed area.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
height ↔ double?
The height of the navigator.
getter/setter pair
margin ↔ double?
The distance from the nearest element, the X axis or X axis labels.
getter/setter pair
maskFill ↔ Map<String, dynamic>?
The color of the mask covering the areas of the navigator series that are currently not visible in the main series. The default color is bluish with an opacity of 0.3 to see the series below.
getter/setter pair
maskInside ↔ bool?
Whether the mask should be inside the range marking the zoomed range, or outside. In Highcharts Stock 1.x it was always false.
getter/setter pair
opposite ↔ bool?
When the chart is inverted, whether to draw the navigator on the opposite side.
getter/setter pair
outlineColor ↔ String?
The color of the line marking the currently zoomed area in the navigator.
getter/setter pair
outlineWidth ↔ double?
The width of the line marking the currently zoomed area in the navigator.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
series ↔ List<HighchartsNavigatorSeriesOptions>?
Options for the navigator series. Available options are the same as any series, documented at plotOptions and series.
getter/setter pair
stickToMax ↔ bool?
Enable or disable navigator sticking to right, while adding new points. If undefined, the navigator sticks to the axis maximum only if it was already at the maximum prior to adding points.
getter/setter pair
xAxis ↔ HighchartsNavigatorXAxisOptions?
Options for the navigator X axis. Default series options for the navigator xAxis are:
getter/setter pair
yAxis ↔ HighchartsNavigatorYAxisOptions?
Options for the navigator Y axis. Default series options for the navigator yAxis are:
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