Class Navigator
java.lang.Object
com.vaadin.flow.component.charts.model.AbstractConfigurationObject
com.vaadin.flow.component.charts.model.Navigator
- All Implemented Interfaces:
Serializable
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.
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiongetXAxis()
getYAxis()
void
setAdaptToUpdatedData
(Boolean adaptToUpdatedData) Whether the navigator and scrollbar should adapt to updated data in the base X axis.void
setEnabled
(Boolean enabled) Enable or disable the navigator.void
setHandles
(Handles handles) Options for the handles for dragging the zoomed area.void
The height of the navigator.void
The distance from the nearest element, the X axis or X axis labels.void
setMaskFill
(Color maskFill) The color of the mask covering the areas of the navigator series that are currently not visible in the main series.void
setMaskInside
(Boolean maskInside) Whether the mask should be inside the range marking the zoomed range, or outside.void
setOpposite
(Boolean opposite) When the chart is inverted, whether to draw the navigator on the opposite side.void
setOutlineColor
(Color outlineColor) The color of the line marking the currently zoomed area in the navigator.void
setOutlineWidth
(Number outlineWidth) The width of the line marking the currently zoomed area in the navigator.void
setSeries
(PlotOptionsSeries series) Options for the navigator series.void
Options for the navigator X axis.void
Options for the navigator Y axis.
-
Constructor Details
-
Navigator
public Navigator() -
Navigator
-
-
Method Details
-
getAdaptToUpdatedData
- See Also:
-
setAdaptToUpdatedData
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 befalse
. 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.Defaults to: true
-
getEnabled
- See Also:
-
setEnabled
Enable or disable the navigator.Defaults to: true
-
getHandles
- See Also:
-
setHandles
Options for the handles for dragging the zoomed area.
In styled mode, the navigator handles are styled with the
.highcharts-navigator-handle
,.highcharts-navigator-handle-left
and.highcharts-navigator-handle-right
classes. -
getHeight
- See Also:
-
setHeight
The height of the navigator.Defaults to: 40
-
getMargin
- See Also:
-
setMargin
The distance from the nearest element, the X axis or X axis labels.Defaults to: 25
-
getMaskFill
- See Also:
-
setMaskFill
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.Defaults to: rgba(102,133,194,0.3)
-
getMaskInside
- See Also:
-
setMaskInside
Whether the mask should be inside the range marking the zoomed range, or outside. In Highstock 1.x it was alwaysfalse
.Defaults to: true
-
getOpposite
- See Also:
-
setOpposite
When the chart is inverted, whether to draw the navigator on the opposite side.Defaults to: false
-
getOutlineColor
- See Also:
-
setOutlineColor
The color of the line marking the currently zoomed area in the navigator.Defaults to: #cccccc
-
getOutlineWidth
- See Also:
-
setOutlineWidth
The width of the line marking the currently zoomed area in the navigator.Defaults to: 2
-
getSeries
- See Also:
-
setSeries
Options for the navigator series. Available options are the same as any series, documented at plotOptions and series.
Unless data is explicitly defined on navigator.series, the data is borrowed from the first series in the chart.
Default series options for the navigator series are:
series: { type: 'areaspline', color: '#4572A7', fillOpacity: 0.05, dataGrouping: { smoothed: true }, lineWidth: 1, marker: { enabled: false } }
-
getXAxis
- See Also:
-
setXAxis
Options for the navigator X axis. Available options are the same as any X axis, documented at xAxis. Default series options for the navigator xAxis are:xAxis: { tickWidth: 0, lineWidth: 0, gridLineWidth: 1, tickPixelInterval: 200, labels: { align: 'left', style: { color: '#888' }, x: 3, y: -4 } }
-
getYAxis
- See Also:
-
setYAxis
Options for the navigator Y axis. Available options are the same as any y axis, documented at yAxis. Default series options for the navigator yAxis are:yAxis: { gridLineWidth: 0, startOnTick: false, endOnTick: false, minPadding: 0.1, maxPadding: 0.1, labels: { enabled: false }, title: { text: null }, tickWidth: 0 }
-