HCNavigatorOptions class

(Highstock, Gantt) 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.

Implemented types

Constructors

HCNavigatorOptions({HCNavigatorAccessibilityOptions? accessibility, bool? adaptToUpdatedData, dynamic baseSeries, bool? enabled, HCNavigatorHandlesOptions? handles, num? height, num? margin, dynamic maskFill, bool? maskInside, bool? opposite, dynamic outlineColor, num? outlineWidth, dynamic series, bool? stickToMax, dynamic xAxis, dynamic yAxis})
const

Properties

accessibility → HCNavigatorAccessibilityOptions?
(Highstock, Gantt) Accessibility options for the navigator. Requires the Accessibility module.
final
adaptToUpdatedData → bool?
(Highstock, Gantt) 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 navig
final
baseSeries → dynamic
(Highstock, Gantt) An integer identifying the index to use for the base series, or a string representing the id of the series.
final
enabled → bool?
(Highstock, Gantt) Enable or disable the navigator.
final
handles → HCNavigatorHandlesOptions?
(Highstock, Gantt) Options for the handles for dragging the zoomed area.
final
hashCode → int
The hash code for this object.
no setterinherited
height → num?
(Highstock, Gantt) The height of the navigator.
final
margin → num?
(Highstock, Gantt) The distance from the nearest element, the X axis or X axis labels.
final
maskFill → dynamic
(Highstock, Gantt) 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.
final
maskInside → bool?
(Highstock, Gantt) Whether the mask should be inside the range marking the zoomed range, or outside. In Highcharts Stock 1.x it was always false.
final
opposite → bool?
(Highstock, Gantt) When the chart is inverted, whether to draw the navigator on the opposite side.
final
outlineColor → dynamic
(Highstock, Gantt) The color of the line marking the currently zoomed area in the navigator.
final
outlineWidth → num?
(Highstock, Gantt) The width of the line marking the currently zoomed area in the navigator.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
series → dynamic
(Highstock, Gantt) Options for the navigator series. Available options are the same as any series, documented at plotOptions and series.
final
stickToMax → bool?
(Highstock, Gantt) 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.
final
xAxis → dynamic
(Highstock, Gantt) Options for the navigator X axis. Default series options for the navigator xAxis are: (see online documentation for example)
final
yAxis → dynamic
(Highstock, Gantt) Options for the navigator Y axis. Default series options for the navigator yAxis are: (see online documentation for example)
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited