com.github.fluorumlabs.disconnect.highcharts.MapNavigationOptions Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of disconnect-highcharts Show documentation
Show all versions of disconnect-highcharts Show documentation
Highcharts API bindings for Disconnect Zero
package com.github.fluorumlabs.disconnect.highcharts;
import javax.annotation.Nullable;
import js.lang.Any;
import org.teavm.jso.JSProperty;
public interface MapNavigationOptions extends Any {
/**
* (Highmaps) General options for the map navigation buttons. Individual
* options can be given from the mapNavigation.buttons option set.
*
* @see https://api.highcharts.com/highmaps/mapNavigation.buttonOptions
*
* @implspec buttonOptions?: MapNavigationButtonOptions;
*
*/
@JSProperty("buttonOptions")
@Nullable
MapNavigationButtonOptions getButtonOptions();
/**
* (Highmaps) General options for the map navigation buttons. Individual
* options can be given from the mapNavigation.buttons option set.
*
* @see https://api.highcharts.com/highmaps/mapNavigation.buttonOptions
*
* @implspec buttonOptions?: MapNavigationButtonOptions;
*
*/
@JSProperty("buttonOptions")
void setButtonOptions(MapNavigationButtonOptions 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 https://api.highcharts.com/highmaps/mapNavigation.buttons
*
* @implspec buttons?: MapNavigationButtonsOptions;
*
*/
@JSProperty("buttons")
@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 https://api.highcharts.com/highmaps/mapNavigation.buttons
*
* @implspec buttons?: MapNavigationButtonsOptions;
*
*/
@JSProperty("buttons")
void setButtons(MapNavigationButtonsOptions value);
/**
* (Highmaps) Whether to enable navigation buttons. By default it inherits
* the enabled setting.
*
* @see https://api.highcharts.com/highmaps/mapNavigation.enableButtons
*
* @implspec enableButtons?: boolean;
*
*/
@JSProperty("enableButtons")
boolean getEnableButtons();
/**
* (Highmaps) Whether to enable navigation buttons. By default it inherits
* the enabled setting.
*
* @see https://api.highcharts.com/highmaps/mapNavigation.enableButtons
*
* @implspec enableButtons?: boolean;
*
*/
@JSProperty("enableButtons")
void setEnableButtons(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 https://api.highcharts.com/highmaps/mapNavigation.enabled
*
* @implspec enabled?: boolean;
*
*/
@JSProperty("enabled")
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 https://api.highcharts.com/highmaps/mapNavigation.enabled
*
* @implspec enabled?: boolean;
*
*/
@JSProperty("enabled")
void setEnabled(boolean value);
/**
* (Highmaps) Enables zooming in on an area on double clicking in the map.
* By default it inherits the enabled setting.
*
* @see https://api.highcharts.com/highmaps/mapNavigation.enableDoubleClickZoom
*
* @implspec enableDoubleClickZoom?: boolean;
*
*/
@JSProperty("enableDoubleClickZoom")
boolean getEnableDoubleClickZoom();
/**
* (Highmaps) Enables zooming in on an area on double clicking in the map.
* By default it inherits the enabled setting.
*
* @see https://api.highcharts.com/highmaps/mapNavigation.enableDoubleClickZoom
*
* @implspec enableDoubleClickZoom?: boolean;
*
*/
@JSProperty("enableDoubleClickZoom")
void setEnableDoubleClickZoom(boolean value);
/**
* (Highmaps) Whether to zoom in on an area when that area is double
* clicked.
*
* @see https://api.highcharts.com/highmaps/mapNavigation.enableDoubleClickZoomTo
*
* @implspec enableDoubleClickZoomTo?: boolean;
*
*/
@JSProperty("enableDoubleClickZoomTo")
boolean getEnableDoubleClickZoomTo();
/**
* (Highmaps) Whether to zoom in on an area when that area is double
* clicked.
*
* @see https://api.highcharts.com/highmaps/mapNavigation.enableDoubleClickZoomTo
*
* @implspec enableDoubleClickZoomTo?: boolean;
*
*/
@JSProperty("enableDoubleClickZoomTo")
void setEnableDoubleClickZoomTo(boolean value);
/**
* (Highmaps) Enables zooming by mouse wheel. By default it inherits the
* enabled setting.
*
* @see https://api.highcharts.com/highmaps/mapNavigation.enableMouseWheelZoom
*
* @implspec enableMouseWheelZoom?: boolean;
*
*/
@JSProperty("enableMouseWheelZoom")
boolean getEnableMouseWheelZoom();
/**
* (Highmaps) Enables zooming by mouse wheel. By default it inherits the
* enabled setting.
*
* @see https://api.highcharts.com/highmaps/mapNavigation.enableMouseWheelZoom
*
* @implspec enableMouseWheelZoom?: boolean;
*
*/
@JSProperty("enableMouseWheelZoom")
void setEnableMouseWheelZoom(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 https://api.highcharts.com/highmaps/mapNavigation.enableTouchZoom
*
* @implspec enableTouchZoom?: boolean;
*
*/
@JSProperty("enableTouchZoom")
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 https://api.highcharts.com/highmaps/mapNavigation.enableTouchZoom
*
* @implspec enableTouchZoom?: boolean;
*
*/
@JSProperty("enableTouchZoom")
void setEnableTouchZoom(boolean value);
/**
* (Highmaps) Sensitivity of mouse wheel or trackpad scrolling. 1 is no
* sensitivity, while with 2, one mousewheel delta will zoom in 50%.
*
* @see https://api.highcharts.com/highmaps/mapNavigation.mouseWheelSensitivity
*
* @implspec mouseWheelSensitivity?: number;
*
*/
@JSProperty("mouseWheelSensitivity")
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 https://api.highcharts.com/highmaps/mapNavigation.mouseWheelSensitivity
*
* @implspec mouseWheelSensitivity?: number;
*
*/
@JSProperty("mouseWheelSensitivity")
void setMouseWheelSensitivity(double value);
}