com.github.fluorumlabs.disconnect.highcharts

Interface MapNavigationOptions

All Superinterfaces:

Any, org.teavm.jso.JSObject

public interface MapNavigationOptions
extends Any

Method Summary

Modifier and Type	Method and Description
MapNavigationButtonOptions	getButtonOptions() (Highmaps) General options for the map navigation buttons.
MapNavigationButtonsOptions	getButtons() (Highmaps) The individual buttons for the map navigation.
boolean	getEnableButtons() (Highmaps) Whether to enable navigation buttons.
boolean	getEnabled() (Highmaps) Whether to enable map navigation.
boolean	getEnableDoubleClickZoom() (Highmaps) Enables zooming in on an area on double clicking in the map.
boolean	getEnableDoubleClickZoomTo() (Highmaps) Whether to zoom in on an area when that area is double clicked.
boolean	getEnableMouseWheelZoom() (Highmaps) Enables zooming by mouse wheel.
boolean	getEnableTouchZoom() (Highmaps) Whether to enable multitouch zooming.
double	getMouseWheelSensitivity() (Highmaps) Sensitivity of mouse wheel or trackpad scrolling.
void	setButtonOptions(MapNavigationButtonOptions value) (Highmaps) General options for the map navigation buttons.
void	setButtons(MapNavigationButtonsOptions value) (Highmaps) The individual buttons for the map navigation.
void	setEnableButtons(boolean value) (Highmaps) Whether to enable navigation buttons.
void	setEnabled(boolean value) (Highmaps) Whether to enable map navigation.
void	setEnableDoubleClickZoom(boolean value) (Highmaps) Enables zooming in on an area on double clicking in the map.
void	setEnableDoubleClickZoomTo(boolean value) (Highmaps) Whether to zoom in on an area when that area is double clicked.
void	setEnableMouseWheelZoom(boolean value) (Highmaps) Enables zooming by mouse wheel.
void	setEnableTouchZoom(boolean value) (Highmaps) Whether to enable multitouch zooming.
void	setMouseWheelSensitivity(double value) (Highmaps) Sensitivity of mouse wheel or trackpad scrolling.

Methods inherited from interface js.lang.Any

empty

Methods inherited from interface org.teavm.jso.JSObject

cast

Method Detail

getButtonOptions

@Nullable
MapNavigationButtonOptions getButtonOptions()

(Highmaps) General options for the map navigation buttons. Individual options can be given from the mapNavigation.buttons option set.

See Also:

https://api.highcharts.com/highmaps/mapNavigation.buttonOptions

setButtonOptions

void setButtonOptions(MapNavigationButtonOptions value)

(Highmaps) General options for the map navigation buttons. Individual options can be given from the mapNavigation.buttons option set.

See Also:

https://api.highcharts.com/highmaps/mapNavigation.buttonOptions

getButtons

@Nullable
MapNavigationButtonsOptions getButtons()

(Highmaps) The individual buttons for the map navigation. This usually includes the zoom in and zoom out buttons. Properties for each button is inherited from mapNavigation.buttonOptions, while individual options can be overridden. But default, the onclick, text and y options are individual.

See Also:

https://api.highcharts.com/highmaps/mapNavigation.buttons

setButtons

void setButtons(MapNavigationButtonsOptions value)

(Highmaps) The individual buttons for the map navigation. This usually includes the zoom in and zoom out buttons. Properties for each button is inherited from mapNavigation.buttonOptions, while individual options can be overridden. But default, the onclick, text and y options are individual.

See Also:

https://api.highcharts.com/highmaps/mapNavigation.buttons

getEnableButtons

boolean getEnableButtons()

(Highmaps) Whether to enable navigation buttons. By default it inherits the enabled setting.

See Also:

https://api.highcharts.com/highmaps/mapNavigation.enableButtons

setEnableButtons

void setEnableButtons(boolean value)

(Highmaps) Whether to enable navigation buttons. By default it inherits the enabled setting.

See Also:

https://api.highcharts.com/highmaps/mapNavigation.enableButtons

getEnabled

boolean getEnabled()

(Highmaps) Whether to enable map navigation. The default is not to enable navigation, as many choropleth maps are simple and don't need it. Additionally, when touch zoom and mousewheel zoom is enabled, it breaks the default behaviour of these interactions in the website, and the implementer should be aware of this. Individual interactions can be enabled separately, namely buttons, multitouch zoom, double click zoom, double click zoom to element and mousewheel zoom.

See Also:

https://api.highcharts.com/highmaps/mapNavigation.enabled

setEnabled

void setEnabled(boolean value)

(Highmaps) Whether to enable map navigation. The default is not to enable navigation, as many choropleth maps are simple and don't need it. Additionally, when touch zoom and mousewheel zoom is enabled, it breaks the default behaviour of these interactions in the website, and the implementer should be aware of this. Individual interactions can be enabled separately, namely buttons, multitouch zoom, double click zoom, double click zoom to element and mousewheel zoom.

See Also:

https://api.highcharts.com/highmaps/mapNavigation.enabled

getEnableDoubleClickZoom

boolean getEnableDoubleClickZoom()

(Highmaps) Enables zooming in on an area on double clicking in the map. By default it inherits the enabled setting.

See Also:

https://api.highcharts.com/highmaps/mapNavigation.enableDoubleClickZoom

setEnableDoubleClickZoom

void setEnableDoubleClickZoom(boolean value)

(Highmaps) Enables zooming in on an area on double clicking in the map. By default it inherits the enabled setting.

See Also:

https://api.highcharts.com/highmaps/mapNavigation.enableDoubleClickZoom

getEnableDoubleClickZoomTo

boolean getEnableDoubleClickZoomTo()

(Highmaps) Whether to zoom in on an area when that area is double clicked.

See Also:

https://api.highcharts.com/highmaps/mapNavigation.enableDoubleClickZoomTo

setEnableDoubleClickZoomTo

void setEnableDoubleClickZoomTo(boolean value)

(Highmaps) Whether to zoom in on an area when that area is double clicked.

See Also:

https://api.highcharts.com/highmaps/mapNavigation.enableDoubleClickZoomTo

getEnableMouseWheelZoom

boolean getEnableMouseWheelZoom()

(Highmaps) Enables zooming by mouse wheel. By default it inherits the enabled setting.

See Also:

https://api.highcharts.com/highmaps/mapNavigation.enableMouseWheelZoom

setEnableMouseWheelZoom

void setEnableMouseWheelZoom(boolean value)

(Highmaps) Enables zooming by mouse wheel. By default it inherits the enabled setting.

See Also:

https://api.highcharts.com/highmaps/mapNavigation.enableMouseWheelZoom

getEnableTouchZoom

boolean getEnableTouchZoom()

(Highmaps) Whether to enable multitouch zooming. Note that if the chart covers the viewport, this prevents the user from using multitouch and touchdrag on the web page, so you should make sure the user is not trapped inside the chart. By default it inherits the enabled setting.

See Also:

https://api.highcharts.com/highmaps/mapNavigation.enableTouchZoom

setEnableTouchZoom

void setEnableTouchZoom(boolean value)

(Highmaps) Whether to enable multitouch zooming. Note that if the chart covers the viewport, this prevents the user from using multitouch and touchdrag on the web page, so you should make sure the user is not trapped inside the chart. By default it inherits the enabled setting.

See Also:

https://api.highcharts.com/highmaps/mapNavigation.enableTouchZoom

getMouseWheelSensitivity

double getMouseWheelSensitivity()

(Highmaps) Sensitivity of mouse wheel or trackpad scrolling. 1 is no sensitivity, while with 2, one mousewheel delta will zoom in 50%.

See Also:

https://api.highcharts.com/highmaps/mapNavigation.mouseWheelSensitivity

setMouseWheelSensitivity

void setMouseWheelSensitivity(double value)

(Highmaps) Sensitivity of mouse wheel or trackpad scrolling. 1 is no sensitivity, while with 2, one mousewheel delta will zoom in 50%.

See Also:

https://api.highcharts.com/highmaps/mapNavigation.mouseWheelSensitivity