Navigator (Vaadin Platform (vaadin-platform-javadoc) 18.0.7 API)

java.lang.Object
- com.vaadin.flow.component.charts.model.AbstractConfigurationObject
- - com.vaadin.flow.component.charts.model.Navigator

All Implemented Interfaces:: Serializable

@Generated(value="This class is generated and shouldn\'t be modified",
           comments="Incorrect and missing API should be reported to https://github.com/vaadin/vaadin-charts-flow/issues/new")
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)

Constructors
Constructor and Description
`Navigator()`
`Navigator(Boolean enabled)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`getAdaptToUpdatedData()`
`Boolean`	`getEnabled()`
`Handles`	`getHandles()`
`Number`	`getHeight()`
`Number`	`getMargin()`
`Color`	`getMaskFill()`
`Boolean`	`getMaskInside()`
`Boolean`	`getOpposite()`
`Color`	`getOutlineColor()`
`Number`	`getOutlineWidth()`
`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`	`setHandles(Handles handles)` Options for the handles for dragging the zoomed area.
`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`	`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`	`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
  - getHandles
```
public Handles getHandles()
```
    See Also:
    
    setHandles(Handles)
  - setHandles
```
public void setHandles(Handles handles)
```
    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
```
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
  - getMaskFill
```
public Color getMaskFill()
```
    See Also:
    
    setMaskFill(Color)
  - setMaskFill
```
public 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. 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
```
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
  - getOutlineColor
```
public Color getOutlineColor()
```
    See Also:
    
    setOutlineColor(Color)
  - setOutlineColor
```
public void setOutlineColor(Color outlineColor)
```
    The color of the line marking the currently zoomed area in the navigator.
    Defaults to: #cccccc
  - getOutlineWidth
```
public Number getOutlineWidth()
```
    See Also:
    
    setOutlineWidth(Number)
  - setOutlineWidth
```
public void setOutlineWidth(Number outlineWidth)
```
    The width of the line marking the currently zoomed area in the navigator.
    Defaults to: 2
  - 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
        }
 
```

Class Navigator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Navigator

Navigator

Method Detail

getAdaptToUpdatedData

setAdaptToUpdatedData

getEnabled

setEnabled

getHandles

setHandles

getHeight

setHeight

getMargin

setMargin

getMaskFill

setMaskFill

getMaskInside

setMaskInside

getOpposite

setOpposite

getOutlineColor

setOutlineColor

getOutlineWidth

setOutlineWidth

getSeries

setSeries

getXAxis

setXAxis

getYAxis

setYAxis