MapOptions

java.lang.Object
- com.gwidgets.api.leaflet.options.MapOptions

@JsType(isNative=true,
        namespace="<global>",
        name="Object")
public class MapOptions
extends java.lang.Object

The map options used when creating a Map

Author:: Zakaria Amine

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MapOptions.Builder
The Class Builder.

Nested Classes
Modifier and Type	Class and Description
`static class`	`MapOptions.Builder` The Class Builder.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Boolean`	`getAttributionControl()` Gets Whether the attribution control is added to the map by default.
`java.lang.Boolean`	`getBounceAtZoomLimits()` Gets whether the map zooms beyond min/max zoom and then bounce back when pinch-zooming.
`java.lang.Boolean`	`getBoxZoom()` Gets Whether the map can be zoomed to a rectangular area specified by dragging the mouse while pressing shift.
`LatLng`	`getCenter()` Gets the Initial geographical center of the map.
`java.lang.Boolean`	`getClosePopupOnClick()` Gets whether the popups close when user clicks the map.
`java.lang.Boolean`	`getDoubleClickZoom()` Gets Whether the map can be zoomed in by double clicking on it and zoomed out by double clicking while holding shift.
`java.lang.Boolean`	`getDragging()` Gets Whether the map be draggable with mouse/touch or not.
`java.lang.Boolean`	`getFadeAnimation()` Gets Whether the tile fade animation is enabled.
`java.lang.Boolean`	`getInertia()` Gets whether the panning of the map will have an inertia effect where the map builds momentum while dragging and continues moving in the same direction for some time.
`java.lang.Number`	`getInertiaDeceleration()` Gets the rate with which the inertial movement slows down, in pixels/second2.
`java.lang.Number`	`getInertiaMaxSpeed()` Gets the Max speed of the inertial movement, in pixels/second.
`java.lang.Number`	`getInertiaThreshold()` Gets the Number of milliseconds that should pass between stopping the movement and releasing the mouse or touch to prevent inertial movement.
`java.lang.Boolean`	`getKeyboard()` Gets whether the map id focusable and allows users to navigate the map with keyboard arrows and +/- keys.
`java.lang.Number`	`getKeyboardPanOffset()` Gets Amount of pixels to pan when pressing an arrow key.
`java.lang.Number`	`getKeyboardZoomOffset()` Gets the Number of zoom levels to change when pressing + or - key.
`ILayer[]`	`getLayers()` Gets the Layers that will be added to the map initially.
`java.lang.Boolean`	`getMarkerZoomAnimation()` Gets Whether markers animate their zoom with the zoom animation, if disabled they will disappear for the length of the animation.
`LatLngBounds`	`getMaxBounds()` Gets the bounds that restricts the view if the option is set default null
`java.lang.Number`	`getMaxZoom()` Gets Maximum zoom level of the map.
`java.lang.Number`	`getMinZoom()` Gets Minimum zoom level of the map.
`java.lang.Boolean`	`getScrollWheelZoom()` Gets Whether the map can be zoomed by using the mouse wheel.
`java.lang.Boolean`	`getTap()` Gets mobile hacks for supporting instant taps (fixing 200ms click delay on iOS/Android) and touch holds (fired as contextmenu events).
`java.lang.Number`	`getTapTolerance()` Gets The max number of pixels a user can shift his finger during touch for it to be considered a valid tap.
`java.lang.Boolean`	`getTouchZoom()` Gets Whether the map can be zoomed by touch-dragging with two fingers.
`java.lang.Boolean`	`getTrackResize()` Gets Whether the map automatically handles browser window resize to update itself.
`java.lang.Boolean`	`getWorldCopyJump()` With this option enabled, the map tracks when you pan to another "copy" of the world and seamlessly jumps to the original one so that all overlays like markers and vector layers are still visible.
`java.lang.Number`	`getZoom()` Gets Initial map zoom.
`java.lang.Boolean`	`getZoomAnimation()` Gets Whether the tile zoom animation is enabled.
`java.lang.Number`	`getZoomAnimationThreshold()` Gets the value that will disable zoom animation if exceeded default 4
`java.lang.Boolean`	`getZoomControl()` Gets Whether the zoom control is added to the map by default.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getCenter
```
@JsOverlay
public final LatLng getCenter()
```
    Gets the Initial geographical center of the map.
    default null
    
    Returns:
    
    the center
  - getZoom
```
@JsOverlay
public final java.lang.Number getZoom()
```
    Gets Initial map zoom.
    default 0
    
    Returns:
    
    the zoom
  - getLayers
```
@JsOverlay
public final ILayer[] getLayers()
```
    Gets the Layers that will be added to the map initially.
    default null
    
    Returns:
    
    the layers
  - getMinZoom
```
@JsOverlay
public final java.lang.Number getMinZoom()
```
    Gets Minimum zoom level of the map. Overrides any minZoom set on map layers.
    default 0
    
    Returns:
    
    the min zoom
  - getMaxZoom
```
@JsOverlay
public final java.lang.Number getMaxZoom()
```
    Gets Maximum zoom level of the map. This overrides any maxZoom set on map layers.
    default 0
    
    Returns:
    
    the max zoom
  - getMaxBounds
```
@JsOverlay
public final LatLngBounds getMaxBounds()
```
    Gets the bounds that restricts the view if the option is set
    default null
    
    Returns:
    
    the max bounds
  - getDragging
```
@JsOverlay
public final java.lang.Boolean getDragging()
```
    Gets Whether the map be draggable with mouse/touch or not.
    default true
    
    Returns:
    
    the dragging
  - getTouchZoom
```
@JsOverlay
public final java.lang.Boolean getTouchZoom()
```
    Gets Whether the map can be zoomed by touch-dragging with two fingers.
    default true
    
    Returns:
    
    the touch zoom
  - getScrollWheelZoom
```
@JsOverlay
public final java.lang.Boolean getScrollWheelZoom()
```
    Gets Whether the map can be zoomed by using the mouse wheel. If passed 'center', it will zoom to the center of the view regardless of where the mouse was.
    default true
    
    Returns:
    
    the scroll wheel zoom
  - getDoubleClickZoom
```
@JsOverlay
public final java.lang.Boolean getDoubleClickZoom()
```
    Gets Whether the map can be zoomed in by double clicking on it and zoomed out by double clicking while holding shift. If passed 'center', double-click zoom will zoom to the center of the view regardless of where the mouse was.
    default true
    
    Returns:
    
    the double click zoom
  - getBoxZoom
```
@JsOverlay
public final java.lang.Boolean getBoxZoom()
```
    Gets Whether the map can be zoomed to a rectangular area specified by dragging the mouse while pressing shift.
    default true
    
    Returns:
    
    the box zoom
  - getTap
```
@JsOverlay
public final java.lang.Boolean getTap()
```
    Gets mobile hacks for supporting instant taps (fixing 200ms click delay on iOS/Android) and touch holds (fired as contextmenu events).
    default true
    
    Returns:
    
    the tap
  - getTapTolerance
```
@JsOverlay
public final java.lang.Number getTapTolerance()
```
    Gets The max number of pixels a user can shift his finger during touch for it to be considered a valid tap.
    default 15
    
    Returns:
    
    the tap tolerance
  - getTrackResize
```
@JsOverlay
public final java.lang.Boolean getTrackResize()
```
    Gets Whether the map automatically handles browser window resize to update itself.
    default true
    
    Returns:
    
    the track resize
  - getWorldCopyJump
```
@JsOverlay
public final java.lang.Boolean getWorldCopyJump()
```
    With this option enabled, the map tracks when you pan to another "copy" of the world and seamlessly jumps to the original one so that all overlays like markers and vector layers are still visible.
    default false
    
    Returns:
    
    the world copy jump
  - getClosePopupOnClick
```
@JsOverlay
public final java.lang.Boolean getClosePopupOnClick()
```
    Gets whether the popups close when user clicks the map.
    default true
    
    Returns:
    
    the close popup on click
  - getBounceAtZoomLimits
```
@JsOverlay
public final java.lang.Boolean getBounceAtZoomLimits()
```
    Gets whether the map zooms beyond min/max zoom and then bounce back when pinch-zooming.
    default true
    
    Returns:
    
    the close popup on click
  - getKeyboard
```
@JsOverlay
public final java.lang.Boolean getKeyboard()
```
    Gets whether the map id focusable and allows users to navigate the map with keyboard arrows and +/- keys.
    default true
    
    Returns:
    
    the keyboard
  - getKeyboardPanOffset
```
@JsOverlay
public final java.lang.Number getKeyboardPanOffset()
```
    Gets Amount of pixels to pan when pressing an arrow key.
    default 80
    
    Returns:
    
    the keyboard pan offset
  - getKeyboardZoomOffset
```
@JsOverlay
public final java.lang.Number getKeyboardZoomOffset()
```
    Gets the Number of zoom levels to change when pressing + or - key.
    default 1
    
    Returns:
    
    the keyboard zoom offset
  - getInertia
```
@JsOverlay
public final java.lang.Boolean getInertia()
```
    Gets whether the panning of the map will have an inertia effect where the map builds momentum while dragging and continues moving in the same direction for some time. Feels especially nice on touch devices.
    default true
    
    Returns:
    
    the inertia
  - getInertiaDeceleration
```
@JsOverlay
public final java.lang.Number getInertiaDeceleration()
```
    Gets the rate with which the inertial movement slows down, in pixels/second2.
    default 3000
    
    Returns:
    
    the inertia deceleration
  - getInertiaMaxSpeed
```
@JsOverlay
public final java.lang.Number getInertiaMaxSpeed()
```
    Gets the Max speed of the inertial movement, in pixels/second.
    default 1500
    
    Returns:
    
    the inertia max speed
  - getInertiaThreshold
```
@JsOverlay
public final java.lang.Number getInertiaThreshold()
```
    Gets the Number of milliseconds that should pass between stopping the movement and releasing the mouse or touch to prevent inertial movement. 32 for touch devices and 14 for the rest by default.
    default 32
    
    Returns:
    
    the inertia threshold
  - getZoomControl
```
@JsOverlay
public final java.lang.Boolean getZoomControl()
```
    Gets Whether the zoom control is added to the map by default.
    default true
    
    Returns:
    
    the zoom control
  - getAttributionControl
```
@JsOverlay
public final java.lang.Boolean getAttributionControl()
```
    Gets Whether the attribution control is added to the map by default.
    default true
    
    Returns:
    
    the attribution control
  - getFadeAnimation
```
@JsOverlay
public final java.lang.Boolean getFadeAnimation()
```
    Gets Whether the tile fade animation is enabled. By default it's enabled in all browsers that support CSS3 Transitions except Android.
    default true
    
    Returns:
    
    the fade animation
  - getZoomAnimation
```
@JsOverlay
public final java.lang.Boolean getZoomAnimation()
```
    Gets Whether the tile zoom animation is enabled. By default it's enabled in all browsers that support CSS3 Transitions except Android.
    default true
    
    Returns:
    
    the zoom animation
  - getZoomAnimationThreshold
```
@JsOverlay
public final java.lang.Number getZoomAnimationThreshold()
```
    Gets the value that will disable zoom animation if exceeded
    default 4
    
    Returns:
    
    the zoom animation threshold
  - getMarkerZoomAnimation
```
@JsOverlay
public final java.lang.Boolean getMarkerZoomAnimation()
```
    Gets Whether markers animate their zoom with the zoom animation, if disabled they will disappear for the length of the animation. By default it's enabled in all browsers that support CSS3 Transitions except Android.
    default true
    
    Returns:
    
    the marker zoom animation

Class MapOptions

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getCenter

getZoom

getLayers

getMinZoom

getMaxZoom

getMaxBounds

getDragging

getTouchZoom

getScrollWheelZoom

getDoubleClickZoom

getBoxZoom

getTap

getTapTolerance

getTrackResize

getWorldCopyJump

getClosePopupOnClick

getBounceAtZoomLimits

getKeyboard

getKeyboardPanOffset

getKeyboardZoomOffset

getInertia

getInertiaDeceleration

getInertiaMaxSpeed

getInertiaThreshold

getZoomControl

getAttributionControl

getFadeAnimation

getZoomAnimation

getZoomAnimationThreshold

getMarkerZoomAnimation