Package com.vaadin.componentfactory.maps.model

Class MapNavigation

java.lang.Object
com.vaadin.componentfactory.maps.model.AbstractConfigurationObject
com.vaadin.componentfactory.maps.model.MapNavigation
All Implemented Interfaces:
Serializable
@Generated(value="This class was generated", comments="Incorrect and missing API should be reported") public class MapNavigation extends AbstractConfigurationObject

A collection of options for zooming and panning in a map.

Version:
$Id: $Id
Author:
Vaadin
See Also:

  • Constructor Details

    • MapNavigation

      public MapNavigation()

      Constructor for MapNavigation.

    • MapNavigation

      public MapNavigation(Boolean enabled)

      Constructor for MapNavigation.

      Parameters:
      enabled - a Boolean object.

  • Method Details

    • getButtonOptions

      public ButtonOptions getButtonOptions()

      Getter for the field buttonOptions.

      Returns:
      a ButtonOptions object.
      See Also:

    • setButtonOptions

      public void setButtonOptions(ButtonOptions buttonOptions)
      General options for the map navigation buttons. Individual options can be given from the mapNavigation.buttons option set.
      Parameters:
      buttonOptions - a ButtonOptions object.

    • getButtons

      public MapNavigationButtons getButtons()

      Getter for the field buttons.

      Returns:
      a MapNavigationButtons object.
      See Also:

    • setButtons

      public void setButtons(MapNavigationButtons buttons)
      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.
      Parameters:
      buttons - a MapNavigationButtons object.

    • getEnableButtons

      public Boolean getEnableButtons()

      Getter for the field enableButtons.

      Returns:
      a Boolean object.
      See Also:

    • setEnableButtons

      public void setEnableButtons(Boolean enableButtons)
      Whether to enable navigation buttons. By default it inherits the enabled setting.
      Parameters:
      enableButtons - a Boolean object.

    • getEnableDoubleClickZoom

      public Boolean getEnableDoubleClickZoom()

      Getter for the field enableDoubleClickZoom.

      Returns:
      a Boolean object.
      See Also:

    • setEnableDoubleClickZoom

      public void setEnableDoubleClickZoom(Boolean enableDoubleClickZoom)
      Enables zooming in on an area on double clicking in the map. By default it inherits the enabled setting.
      Parameters:
      enableDoubleClickZoom - a Boolean object.

    • getEnableDoubleClickZoomTo

      public Boolean getEnableDoubleClickZoomTo()

      Getter for the field enableDoubleClickZoomTo.

      Returns:
      a Boolean object.
      See Also:

    • setEnableDoubleClickZoomTo

      public void setEnableDoubleClickZoomTo(Boolean enableDoubleClickZoomTo)
      Whether to zoom in on an area when that area is double clicked.

      Defaults to: false

      Parameters:
      enableDoubleClickZoomTo - a Boolean object.

    • getEnableMouseWheelZoom

      public Boolean getEnableMouseWheelZoom()

      Getter for the field enableMouseWheelZoom.

      Returns:
      a Boolean object.
      See Also:

    • setEnableMouseWheelZoom

      public void setEnableMouseWheelZoom(Boolean enableMouseWheelZoom)
      Enables zooming by mouse wheel. By default it inherits the enabled setting.
      Parameters:
      enableMouseWheelZoom - a Boolean object.

    • getEnableTouchZoom

      public Boolean getEnableTouchZoom()

      Getter for the field enableTouchZoom.

      Returns:
      a Boolean object.
      See Also:

    • setEnableTouchZoom

      public void setEnableTouchZoom(Boolean enableTouchZoom)
      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.
      Parameters:
      enableTouchZoom - a Boolean object.

    • getEnabled

      public Boolean getEnabled()

      Getter for the field enabled.

      Returns:
      a Boolean object.
      See Also:

    • setEnabled

      public void setEnabled(Boolean enabled)

      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.

      Defaults to: false

      Parameters:
      enabled - a Boolean object.

    • getMouseWheelSensitivity

      public Number getMouseWheelSensitivity()

      Getter for the field mouseWheelSensitivity.

      Returns:
      a Number object.
      See Also:

    • setMouseWheelSensitivity

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

      Defaults to: 1.1

      Parameters:
      mouseWheelSensitivity - a Number object.