MapOptions.Builder (gwty-leaflet 1.0 API)

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

Enclosing class:: MapOptions

public static class MapOptions.Builder
extends Object

The Class Builder.

Constructor Summary

Constructors
Constructor and Description

Builder(LatLng center, Double zoom, Double minZoom)
Instantiates a new MapOtions builder.

Constructors
Constructor and Description
`Builder(LatLng center, Double zoom, Double minZoom)` Instantiates a new MapOtions builder.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MapOptions.Builder`	`attributionControl(Boolean attributionControl)` Whether the attribution control is added to the map by default.
`MapOptions.Builder`	`bounceAtZoomLimits(Boolean bounceAtZoomLimits)` Set it to false if you don't want the map to zoom beyond min/max zoom and then bounce back when pinch-zooming.
`MapOptions.Builder`	`boxZoom(Boolean boxZoom)` Whether the map can be zoomed to a rectangular area specified by dragging the mouse while pressing shift.
`MapOptions`	`build()` Builds the options
`MapOptions.Builder`	`closePopupOnClick(Boolean closePopupOnClick)` Set it to false if you don't want popups to close when user clicks the map.
`MapOptions.Builder`	`doubleClickZoom(Boolean doubleClickZoom)` Whether the map can be zoomed in by double clicking on it and zoomed out by double clicking while holding shift.
`MapOptions.Builder`	`dragging(Boolean dragging)` Whether the map is draggable with mouse/touch or not.
`MapOptions.Builder`	`fadeAnimation(Boolean fadeAnimation)` Whether the tile fade animation is enabled.
`MapOptions.Builder`	`inertia(Boolean inertia)` If enabled, 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.
`MapOptions.Builder`	`inertiaDeceleration(double inertiaDeceleration)` The rate with which the inertial movement slows down, in pixels/second2.
`MapOptions.Builder`	`inertiaMaxSpeed(double inertiaMaxSpeed)` Max speed of the inertial movement, in pixels/second.
`MapOptions.Builder`	`inertiaThreshold(double inertiaThreshold)` Number of milliseconds that should pass between stopping the movement and releasing the mouse or touch to prevent inertial movement.
`MapOptions.Builder`	`keyboard(Boolean keyboard)` Makes the map focusable and allows users to navigate the map with keyboard arrows and +/- keys.
`MapOptions.Builder`	`keyboardPanDelta(double keyboardPanDelta)` Amount of pixels to pan when pressing an arrow key.
`MapOptions.Builder`	`layers(Layer[] layers)` Layers that will be added to the map initially.
`MapOptions.Builder`	`markerZoomAnimation(Boolean markerZoomAnimation)` Whether markers animate their zoom with the zoom animation, if disabled they will disappear for the length of the animation.
`MapOptions.Builder`	`maxBounds(LatLngBounds maxBounds)` When this option is set, the map restricts the view to the given geographical bounds, bouncing the user back when he tries to pan outside the view.
`MapOptions.Builder`	`maxBoundsViscosity(double maxBoundsViscosity)` If maxBounds is set, this option will control how solid the bounds are when dragging the map around.
`MapOptions.Builder`	`maxZoom(Double maxZoom)` Maximum zoom level of the map.
`MapOptions.Builder`	`preferCanvas(Boolean preferCanvas)` Whether Paths should be rendered on a Canvas renderer.
`MapOptions.Builder`	`renderer(Renderer renderer)` The default method for drawing vector layers on the map.
`MapOptions.Builder`	`scrollWheelZoom(Boolean scrollWheelZoom)` Whether the map can be zoomed by using the mouse wheel.
`MapOptions.Builder`	`tap(Boolean tap)` Enables mobile hacks for supporting instant taps (fixing 200ms click delay on iOS/Android) and touch holds (fired as contextmenu events).
`MapOptions.Builder`	`tapTolerance(double tapTolerance)` The max number of pixels a user can shift his finger during touch for it to be considered a valid tap.
`MapOptions.Builder`	`touchZoom(Boolean touchZoom)` Whether the map can be zoomed by touch-dragging with two fingers.
`MapOptions.Builder`	`trackResize(Boolean trackResize)` Whether the map automatically handles browser window resize to update itself.
`MapOptions.Builder`	`transform3DLimit(double transform3DLimit)` Defines the maximum size of a CSS translation transform.
`MapOptions.Builder`	`wheelDebounceTime(double wheelDebounceTime)` Limits the rate at which a wheel can fire (in milliseconds).
`MapOptions.Builder`	`wheelPxPerZoomLevel(double wheelPxPerZoomLevel)` How many scroll pixels (as reported by L.DomEvent.getWheelDelta) mean a change of one full zoom level.
`MapOptions.Builder`	`worldCopyJump(Boolean worldCopyJump)` 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.
`MapOptions.Builder`	`zoomAnimation(Boolean zoomAnimation)` Whether the tile zoom animation is enabled.
`MapOptions.Builder`	`zoomAnimationThreshold(double zoomAnimationThreshold)` Won't animate zoom if the zoom difference exceeds this value.
`MapOptions.Builder`	`zoomControl(Boolean zoomControl)` Whether the zoom control is added to the map by default.
`MapOptions.Builder`	`zoomDelta(double zoomDelta)` Controls how much the map's zoom level will change after a zoomIn(), zoomOut(), pressing + or - on the keyboard, or using the zoom controls.
`MapOptions.Builder`	`zoomSnap(double zoomSnap)` Forces the map's zoom level to always be a multiple of this, particularly right after a fitBounds() or a pinch-zoom.

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

- Constructor Detail
  - Builder
```
public Builder(LatLng center,
               Double zoom,
               Double minZoom)
```
    Instantiates a new MapOtions builder.
    
    Parameters:
    
    center - Initial geographical center of the map.
    
    zoom - Initial map zoom.
    
    minZoom - Minimum zoom level of the map. Overrides any minZoom set on map layers.
- Method Detail
  - layers
```
public MapOptions.Builder layers(Layer[] layers)
```
    Layers that will be added to the map initially. default null
    
    Parameters:
    
    layers - the Layers that will be added to the map initially.
    
    Returns:
    
    the builder
  - maxZoom
```
public MapOptions.Builder maxZoom(Double maxZoom)
```
    Maximum zoom level of the map. This overrides any maxZoom set on map layers. default 0
    
    Parameters:
    
    maxZoom - the max zoom
    
    Returns:
    
    the builder
  - maxBounds
```
public MapOptions.Builder maxBounds(LatLngBounds maxBounds)
```
    When this option is set, the map restricts the view to the given geographical bounds, bouncing the user back when he tries to pan outside the view. To set the restriction dynamically, use setMaxBounds method.
    
    Parameters:
    
    maxBounds - the max bounds
    
    Returns:
    
    the builder
  - dragging
```
public MapOptions.Builder dragging(Boolean dragging)
```
    Whether the map is draggable with mouse/touch or not. default null
    
    Parameters:
    
    dragging - true or flase
    
    Returns:
    
    the builder
  - touchZoom
```
public MapOptions.Builder touchZoom(Boolean touchZoom)
```
    Whether the map can be zoomed by touch-dragging with two fingers. default true
    
    Parameters:
    
    touchZoom - true or false
    
    Returns:
    
    the builder
  - scrollWheelZoom
```
public MapOptions.Builder scrollWheelZoom(Boolean scrollWheelZoom)
```
    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
    
    Parameters:
    
    scrollWheelZoom - true or false
    
    Returns:
    
    the builder
  - doubleClickZoom
```
public MapOptions.Builder doubleClickZoom(Boolean doubleClickZoom)
```
    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
    
    Parameters:
    
    doubleClickZoom - true or false
    
    Returns:
    
    the builder
  - boxZoom
```
public MapOptions.Builder boxZoom(Boolean boxZoom)
```
    Whether the map can be zoomed to a rectangular area specified by dragging the mouse while pressing shift. default true
    
    Parameters:
    
    boxZoom - true or false
    
    Returns:
    
    the builder
  - tap
```
public MapOptions.Builder tap(Boolean tap)
```
    Enables mobile hacks for supporting instant taps (fixing 200ms click delay on iOS/Android) and touch holds (fired as contextmenu events). default true
    
    Parameters:
    
    tap - true or false
    
    Returns:
    
    the builder
  - tapTolerance
```
public MapOptions.Builder tapTolerance(double tapTolerance)
```
    The max number of pixels a user can shift his finger during touch for it to be considered a valid tap. default 15
    
    Parameters:
    
    tapTolerance - the tap tolerance number
    
    Returns:
    
    the builder
  - trackResize
```
public MapOptions.Builder trackResize(Boolean trackResize)
```
    Whether the map automatically handles browser window resize to update itself. default true
    
    Parameters:
    
    trackResize - true or false
    
    Returns:
    
    the builder
  - worldCopyJump
```
public MapOptions.Builder worldCopyJump(Boolean worldCopyJump)
```
    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
    
    Parameters:
    
    worldCopyJump - true or false
    
    Returns:
    
    the builder
  - closePopupOnClick
```
public MapOptions.Builder closePopupOnClick(Boolean closePopupOnClick)
```
    Set it to false if you don't want popups to close when user clicks the map. default true
    
    Parameters:
    
    closePopupOnClick - true or false
    
    Returns:
    
    the builder
  - bounceAtZoomLimits
```
public MapOptions.Builder bounceAtZoomLimits(Boolean bounceAtZoomLimits)
```
    Set it to false if you don't want the map to zoom beyond min/max zoom and then bounce back when pinch-zooming. default true
    
    Parameters:
    
    closePopupOnClick - true or false
    
    Returns:
    
    the builder
  - keyboard
```
public MapOptions.Builder keyboard(Boolean keyboard)
```
    Makes the map focusable and allows users to navigate the map with keyboard arrows and +/- keys. default true
    
    Parameters:
    
    keyboard - true or false
    
    Returns:
    
    the builder
  - keyboardPanDelta
```
public MapOptions.Builder keyboardPanDelta(double keyboardPanDelta)
```
    Amount of pixels to pan when pressing an arrow key. default 80
    
    Parameters:
    
    keyboardPanOffset - the keyboard pan offset
    
    Returns:
    
    the builder
  - inertia
```
public MapOptions.Builder inertia(Boolean inertia)
```
    If enabled, 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
    
    Parameters:
    
    inertia - true or false
    
    Returns:
    
    the builder
  - inertiaDeceleration
```
public MapOptions.Builder inertiaDeceleration(double inertiaDeceleration)
```
    The rate with which the inertial movement slows down, in pixels/second2. default 3000
    
    Parameters:
    
    inertiaDeceleration - the inertia deceleration
    
    Returns:
    
    the builder
  - inertiaMaxSpeed
```
public MapOptions.Builder inertiaMaxSpeed(double inertiaMaxSpeed)
```
    Max speed of the inertial movement, in pixels/second. default 1500
    
    Parameters:
    
    inertiaMaxSpeed - the inertia max speed
    
    Returns:
    
    the builder
  - inertiaThreshold
```
public MapOptions.Builder inertiaThreshold(double inertiaThreshold)
```
    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
    
    Parameters:
    
    inertiaThreshold - the inertia threshold
    
    Returns:
    
    the builder
  - zoomControl
```
public MapOptions.Builder zoomControl(Boolean zoomControl)
```
    Whether the zoom control is added to the map by default. default true
    
    Parameters:
    
    zoomControl - true or false
    
    Returns:
    
    the builder
  - attributionControl
```
public MapOptions.Builder attributionControl(Boolean attributionControl)
```
    Whether the attribution control is added to the map by default. default true
    
    Parameters:
    
    attributionControl - true or false
    
    Returns:
    
    the builder
  - fadeAnimation
```
public MapOptions.Builder fadeAnimation(Boolean fadeAnimation)
```
    Whether the tile fade animation is enabled. By default it's enabled in all browsers that support CSS3 Transitions except Android. default true
    
    Parameters:
    
    fadeAnimation - true or false
    
    Returns:
    
    the builder
  - zoomAnimation
```
public MapOptions.Builder zoomAnimation(Boolean zoomAnimation)
```
    Whether the tile zoom animation is enabled. By default it's enabled in all browsers that support CSS3 Transitions except Android. default true
    
    Parameters:
    
    zoomAnimation - the zoom animation
    
    Returns:
    
    the builder
  - zoomAnimationThreshold
```
public MapOptions.Builder zoomAnimationThreshold(double zoomAnimationThreshold)
```
    Won't animate zoom if the zoom difference exceeds this value. default 4
    
    Parameters:
    
    zoomAnimationThreshold - the zoom animation threshold
    
    Returns:
    
    the builder
  - markerZoomAnimation
```
public MapOptions.Builder markerZoomAnimation(Boolean markerZoomAnimation)
```
    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
    
    Parameters:
    
    markerZoomAnimation - true or false
    
    Returns:
    
    the builder
  - preferCanvas
```
public MapOptions.Builder preferCanvas(Boolean preferCanvas)
```
    Whether Paths should be rendered on a Canvas renderer. By default, all Paths are rendered in a SVG renderer.
    
    Parameters:
    
    preferCanvas -
    
    Returns:
    
    the builder
  - renderer
```
public MapOptions.Builder renderer(Renderer renderer)
```
    The default method for drawing vector layers on the map. L.SVG or L.Canvas by default depending on browser support.
    
    Parameters:
    
    renderer -
    
    Returns:
    
    the builder
  - wheelDebounceTime
```
public MapOptions.Builder wheelDebounceTime(double wheelDebounceTime)
```
    Limits the rate at which a wheel can fire (in milliseconds). By default user can't zoom via wheel more often than once per 40 ms.
    
    Parameters:
    
    wheelDebounceTime -
    
    Returns:
    
    the builder
  - wheelPxPerZoomLevel
```
public MapOptions.Builder wheelPxPerZoomLevel(double wheelPxPerZoomLevel)
```
    How many scroll pixels (as reported by L.DomEvent.getWheelDelta) mean a change of one full zoom level. Smaller values will make wheel-zooming faster (and vice versa).
    
    Parameters:
    
    wheelPxPerZoomLevel -
    
    Returns:
    
    the builder
  - zoomSnap
```
public MapOptions.Builder zoomSnap(double zoomSnap)
```
    Forces the map's zoom level to always be a multiple of this, particularly right after a fitBounds() or a pinch-zoom. By default, the zoom level snaps to the nearest integer; lower values (e.g. 0.5 or 0.1) allow for greater granularity. A value of 0 means the zoom level will not be snapped after fitBounds or a pinch-zoom.
    
    Parameters:
    
    zoomSnap -
    
    Returns:
    
    the builder
  - zoomDelta
```
public MapOptions.Builder zoomDelta(double zoomDelta)
```
    Controls how much the map's zoom level will change after a zoomIn(), zoomOut(), pressing + or - on the keyboard, or using the zoom controls. Values smaller than 1 (e.g. 0.5) allow for greater granularity.
    
    Parameters:
    
    zoomDelta -
    
    Returns:
    
    the builder
  - maxBoundsViscosity
```
public MapOptions.Builder maxBoundsViscosity(double maxBoundsViscosity)
```
    If maxBounds is set, this option will control how solid the bounds are when dragging the map around. The default value of 0.0 allows the user to drag outside the bounds at normal speed, higher values will slow down map dragging outside bounds, and 1.0 makes the bounds fully solid, preventing the user from dragging outside the bounds.
    
    Parameters:
    
    maxBoundsViscosity -
    
    Returns:
    
    the builder
  - transform3DLimit
```
public MapOptions.Builder transform3DLimit(double transform3DLimit)
```
    Defines the maximum size of a CSS translation transform. The default value should not be changed unless a web browser positions layers in the wrong place after doing a large panBy.
    
    Parameters:
    
    transform3DLimit -
    
    Returns:
    
    the builder
  - build
```
public MapOptions build()
```
    Builds the options
    
    Returns:
    
    the map options instance

Class MapOptions.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

layers

maxZoom

maxBounds

dragging

touchZoom

scrollWheelZoom

doubleClickZoom

boxZoom

tap

tapTolerance

trackResize

worldCopyJump

closePopupOnClick

bounceAtZoomLimits

keyboard

keyboardPanDelta

inertia

inertiaDeceleration

inertiaMaxSpeed

inertiaThreshold

zoomControl

attributionControl

fadeAnimation

zoomAnimation

zoomAnimationThreshold

markerZoomAnimation

preferCanvas

renderer

wheelDebounceTime

wheelPxPerZoomLevel

zoomSnap

zoomDelta

maxBoundsViscosity

transform3DLimit

build