com.vaadin.flow.component.charts.model

Class Navigator

java.lang.Object

com.vaadin.flow.component.charts.model.AbstractConfigurationObject

com.vaadin.flow.component.charts.model.Navigator

All Implemented Interfaces:

Serializable

public class Navigator
extends AbstractConfigurationObject

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:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Navigator()
Navigator(Boolean enabled)

Method Summary

Modifier and Type	Method and Description
Boolean	getAdaptToUpdatedData()
Boolean	getEnabled()
Number	getHeight()
Number	getMargin()
Boolean	getMaskInside()
Boolean	getOpposite()
PlotOptionsSeries	getSeries()
XAxis	getXAxis()
YAxis	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	setHeight(Number height) The height of the navigator.
void	setMargin(Number margin) The distance from the nearest element, the X axis or X axis labels.
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	setSeries(PlotOptionsSeries series) Options for the navigator series.
void	setXAxis(XAxis xAxis) Options for the navigator X axis.
void	setYAxis(YAxis yAxis) Options for the navigator Y axis.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Navigator

public Navigator()

Navigator

public Navigator(Boolean enabled)

Method Detail

getAdaptToUpdatedData

public Boolean getAdaptToUpdatedData()

See Also:

setAdaptToUpdatedData(Boolean)

setAdaptToUpdatedData

public void setAdaptToUpdatedData(Boolean adaptToUpdatedData)

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.

Defaults to: true

getEnabled

public Boolean getEnabled()

See Also:

setEnabled(Boolean)

setEnabled

public void setEnabled(Boolean enabled)

Enable or disable the navigator.

Defaults to: true

getHeight

public Number getHeight()

See Also:

setHeight(Number)

setHeight

public void setHeight(Number height)

The height of the navigator.

Defaults to: 40

getMargin

public Number getMargin()

See Also:

setMargin(Number)

setMargin

public void setMargin(Number margin)

The distance from the nearest element, the X axis or X axis labels.

Defaults to: 25

getMaskInside

public Boolean getMaskInside()

See Also:

setMaskInside(Boolean)

setMaskInside

public void setMaskInside(Boolean maskInside)

Whether the mask should be inside the range marking the zoomed range, or outside. In Highstock 1.x it was always false.

Defaults to: true

getOpposite

public Boolean getOpposite()

See Also:

setOpposite(Boolean)

setOpposite

public void setOpposite(Boolean opposite)

When the chart is inverted, whether to draw the navigator on the opposite side.

Defaults to: false

getSeries

public PlotOptionsSeries getSeries()

See Also:

setSeries(PlotOptionsSeries)

setSeries

public void setSeries(PlotOptionsSeries series)

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

public XAxis getXAxis()

See Also:

setXAxis(XAxis)

setXAxis

public void setXAxis(XAxis xAxis)

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

public YAxis getYAxis()

See Also:

setYAxis(YAxis)

setYAxis

public void setYAxis(YAxis yAxis)

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
        }