Class: StandaloneNavigator

Highcharts. StandaloneNavigator

new StandaloneNavigator( [renderTo], userOptions)

The StandaloneNavigator class. The StandaloneNavigator class allows for creating a standalone navigator component that synchronizes the extremes across multiple bound charts.

Parameters:
Name Type Argument Description
renderTo string | Highcharts.HTMLDOMElement <optional>

The DOM element to render to, or its id.
userOptions StandaloneNavigatorOptions

The standalone navigator options.

Methods

bind(axisOrChart [, twoWay])

Binds an axis to the standalone navigator, allowing the navigator to control the axis' range.

Parameters:
Name Type Argument Default Description
axisOrChart Highcharts.Axis | Chart

The Axis or Chart to bind to the navigator.
twoWay boolean <optional>
 true

Enables two-way binding between the navigator and the axis/chart. When true, changes in the navigator's range will update the axis and vice versa. When false, changes in the navigator's range will be reflected in the axis, but changes in the axis ranges won't be reflected on the navigator.
Try it

destroy()

Destroys allocated standalone navigator elements.

getRange()

Get the current range of the standalone navigator.

Returns:
Highcharts.ExtremesObject .

The current range of the standalone navigator.

Try it

redraw()

Redraws the standalone navigator.

setRange(min, max)

Set the range of the standalone navigator.

Parameters:
Name Type Description
min number | undefined

The new minimum value.
max number | undefined

The new maximum value.
Fires:
  • Highcharts.StandaloneNavigator#event:setRange
Try it

unbind(axisOrChart)

Unbinds a single axis or all bound axes from the standalone navigator.

Parameters:
Name Type Description
axisOrChart Highcharts.Chart | Axis | undefined

Passing a Chart object unbinds the first X axis of the chart, an Axis object unbinds that specific axis, and undefined unbinds all axes bound to the navigator.
Try it

update(newOptions, redraw)

Updates the standalone navigator's options with a new set of user options.

Parameters:
Name Type Description
newOptions StandaloneNavigatorOptions

Updates the standalone navigator's options with new user options.
redraw boolean | undefined

Whether to redraw the standalone navigator. By default, if not specified, the standalone navigator will be redrawn.
Try it