net.java.html.leaflet

Class MapOptions

java.lang.Object

net.java.html.leaflet.MapOptions

public final class MapOptions
extends Object

Options for configuring a Map.

Constructor Summary

Constructors

Constructor and Description
MapOptions()

Method Summary

Modifier and Type	Method and Description
MapOptions	setAttributionControl(boolean attributionControl) Whether the attribution control is added to the map by default.
MapOptions	setBounceAtZoomLimits(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	setBoxZoom(boolean boxZoom) Whether the map can be zoomed to a rectangular area specified by dragging the mouse while pressing shift.
MapOptions	setCenter(LatLng latLng) Initial geographical center of the map.
MapOptions	setClosePopupOnClick(boolean closePopupOnClick) Set it to false if you don't want popups to close when user clicks the map.
MapOptions	setCRS(ICRS crs) Coordinate Reference System to use.
MapOptions	setDoubleClickZoom(boolean doubleClickZoom) Whether the map can be zoomed in by double clicking on it and zoomed out by double clicking while holding shift.
MapOptions	setDragging(boolean dragging) Whether the map is draggable with mouse/touch or not.
MapOptions	setFadeAnimation(boolean fadeAnimation) Whether the tile fade animation is enabled.
MapOptions	setInertia(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	setInertiaDeceleration(int inertiaDeceleration) The rate with which the inertial movement slows down, in pixels/second^2.
MapOptions	setInertiaMaxSpeed(int inertiaMaxSpeed) Max speed of the inertial movement, in pixels/second.
MapOptions	setInertiaThreshold(int 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.
MapOptions	setKeyboard(boolean keyboard) Makes the map focusable and allows users to navigate the map with keyboard arrows and +/- keys.
MapOptions	setKeyboardPanOffset(int keyboardPanOffset) Amount of pixels to pan when pressing an arrow key.
MapOptions	setKeyboardZoomOffset(int keyboardZoomOffset) Number of zoom levels to change when pressing + or - key.
MapOptions	setLayers(ILayer[] layers) Layers that will be added to the map initially.
MapOptions	setMarkerZoomAnimation(boolean markerZoomAnimation) Whether markers animate their zoom with the zoom animation, if disabled they will disappear for the length of the animation.
MapOptions	setMaxBounds(LatLngBounds bounds) 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	setMaxZoom(int maxZoom) Maximum zoom level of the map.
MapOptions	setMinZoom(int minZoom) Minimum zoom level of the map.
MapOptions	setScrollWheelZoom(boolean scrollWheelZoom) Whether the map can be zoomed by using the mouse wheel.
MapOptions	setTap(boolean tap) Enables mobile hacks for supporting instant taps (fixing 200ms click delay on iOS/Android) and touch holds (fired as contextmenu events).
MapOptions	setTapTolerance(int tapTolerance) The max number of pixels a user can shift his finger during touch for it to be considered a valid tap.
MapOptions	setTouchZoom(boolean touchZoom) Whether the map can be zoomed by touch-dragging with two fingers.
MapOptions	setTrackResize(boolean trackResize) Whether the map automatically handles browser window resize to update itself.
MapOptions	setWorldCopyJump(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	setZoom(int zoom) Initial map zoom.
MapOptions	setZoomAnimation(boolean zoomAnimation) Whether the tile zoom animation is enabled.
MapOptions	setZoomAnimationThreshold(int zoomAnimationThreshold) Won't animate zoom if the zoom difference exceeds this value.
MapOptions	setZoomControl(boolean zoomControl) Whether the zoom control is added to the map by default.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MapOptions

public MapOptions()

Method Detail

setCenter

public MapOptions setCenter(LatLng latLng)

Initial geographical center of the map.

Parameters:

latLng - The initial geographical center of the map.

Returns:

Returns a MapOptions object with the set options.

setZoom

public MapOptions setZoom(int zoom)

Initial map zoom.

Parameters:

zoom - The initial map zoom.

Returns:

Returns a MapOptions object with the set options.

setLayers

public MapOptions setLayers(ILayer[] layers)

Layers that will be added to the map initially.

Parameters:

layers - The layers that will be added to the map initially.

Returns:

Returns a MapOptions object with the set options.

setMinZoom

public MapOptions setMinZoom(int minZoom)

Minimum zoom level of the map. Overrides any minZoom set on map layers.

Parameters:

minZoom - The minimum zoom level of the map.

Returns:

Returns a MapOptions object with the set options.

setMaxZoom

public MapOptions setMaxZoom(int maxZoom)

Maximum zoom level of the map. This overrides any maxZoom set on map layers.

Parameters:

maxZoom - The maximum zoom level of the map.

Returns:

Returns a MapOptions object with the set options.

setMaxBounds

public MapOptions setMaxBounds(LatLngBounds bounds)

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.

Parameters:

bounds - The geographical bounds.

Returns:

Returns a MapOptions object with the set options.

setCRS

public MapOptions setCRS(ICRS crs)

Coordinate Reference System to use. Don't change this if you're not sure what it means.

Parameters:

crs - The coordinate Reference System.

Returns:

Returns a MapOptions object with the set options.

setDragging

public MapOptions setDragging(boolean dragging)

Whether the map is draggable with mouse/touch or not.

Parameters:

dragging - The draggable option.

Returns:

Returns a MapOptions object with the set options.

setTouchZoom

public MapOptions setTouchZoom(boolean touchZoom)

Whether the map can be zoomed by touch-dragging with two fingers.

Parameters:

touchZoom - The touch zoom option.

Returns:

Returns a MapOptions object with the set options.

setScrollWheelZoom

public MapOptions setScrollWheelZoom(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.

Parameters:

scrollWheelZoom - The mouse wheel zoom option.

Returns:

Returns a MapOptions object with the set options.

setDoubleClickZoom

public MapOptions setDoubleClickZoom(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.

Parameters:

doubleClickZoom - The double click zoom option.

Returns:

Returns a MapOptions object with the set options.

setBoxZoom

public MapOptions setBoxZoom(boolean boxZoom)

Whether the map can be zoomed to a rectangular area specified by dragging the mouse while pressing shift.

Parameters:

boxZoom - The box zoom option.

Returns:

Returns a MapOptions object with the set options.

setTap

public MapOptions setTap(boolean tap)

Enables mobile hacks for supporting instant taps (fixing 200ms click delay on iOS/Android) and touch holds (fired as contextmenu events).

Parameters:

tap - The tap option.

Returns:

Returns a MapOptions object with the set options.

setTapTolerance

public MapOptions setTapTolerance(int tapTolerance)

The max number of pixels a user can shift his finger during touch for it to be considered a valid tap.

Parameters:

tapTolerance - The tap tolerance.

Returns:

Returns a MapOptions object with the set options.

setTrackResize

public MapOptions setTrackResize(boolean trackResize)

Whether the map automatically handles browser window resize to update itself.

Parameters:

trackResize - The track resize option.

Returns:

Returns a MapOptions object with the set options.

setWorldCopyJump

public MapOptions setWorldCopyJump(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.

Parameters:

worldCopyJump - The world copy jump option.

Returns:

Returns a MapOptions object with the set options.

setClosePopupOnClick

public MapOptions setClosePopupOnClick(boolean closePopupOnClick)

Set it to false if you don't want popups to close when user clicks the map.

Parameters:

closePopupOnClick - The close popup on click option.

Returns:

Returns a MapOptions object with the set options.

setBounceAtZoomLimits

public MapOptions setBounceAtZoomLimits(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.

Parameters:

bounceAtZoomLimits - The bounce at zoom limits option.

Returns:

Returns a MapOptions object with the set options.

setKeyboard

public MapOptions setKeyboard(boolean keyboard)

Makes the map focusable and allows users to navigate the map with keyboard arrows and +/- keys.

Parameters:

keyboard - The keyboard option.

Returns:

Returns a MapOptions object with the set options.

setKeyboardPanOffset

public MapOptions setKeyboardPanOffset(int keyboardPanOffset)

Amount of pixels to pan when pressing an arrow key.

Parameters:

keyboardPanOffset - the keyboard pan offset.

Returns:

Returns a MapOptions object with the set options.

setKeyboardZoomOffset

public MapOptions setKeyboardZoomOffset(int keyboardZoomOffset)

Number of zoom levels to change when pressing + or - key.

Parameters:

keyboardZoomOffset - The keyboard zoom offset.

Returns:

Returns a MapOptions object with the set options.

setInertia

public MapOptions setInertia(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.

Parameters:

inertia - The inertia option.

Returns:

Returns a MapOptions object with the set options.

setInertiaDeceleration

public MapOptions setInertiaDeceleration(int inertiaDeceleration)

The rate with which the inertial movement slows down, in pixels/second^2.

Parameters:

inertiaDeceleration - The inertia deceleration.

Returns:

Returns a MapOptions object with the set options.

setInertiaMaxSpeed

public MapOptions setInertiaMaxSpeed(int inertiaMaxSpeed)

Max speed of the inertial movement, in pixels/second.

Parameters:

inertiaMaxSpeed - The inertia max speed.

Returns:

Returns a MapOptions object with the set options.

setInertiaThreshold

public MapOptions setInertiaThreshold(int 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.

Parameters:

inertiaThreshold - The inertia threshold.

Returns:

Returns a MapOptions object with the set options.

setZoomControl

public MapOptions setZoomControl(boolean zoomControl)

Whether the zoom control is added to the map by default.

Parameters:

zoomControl - The zoom control option.

Returns:

Returns a MapOptions object with the set options.

setAttributionControl

public MapOptions setAttributionControl(boolean attributionControl)

Whether the attribution control is added to the map by default.

Parameters:

attributionControl - The attribution control option.

Returns:

Returns a MapOptions object with the set options.

setFadeAnimation

public MapOptions setFadeAnimation(boolean fadeAnimation)

Whether the tile fade animation is enabled. By default it's enabled in all browsers that support CSS3 Transitions except Android.

Parameters:

fadeAnimation - The fade animation option.

Returns:

Returns a MapOptions object with the set options.

setZoomAnimation

public MapOptions setZoomAnimation(boolean zoomAnimation)

Whether the tile zoom animation is enabled. By default it's enabled in all browsers that support CSS3 Transitions except Android.

Parameters:

zoomAnimation - The zoom animation option.

Returns:

Returns a MapOptions object with the set options.

setZoomAnimationThreshold

public MapOptions setZoomAnimationThreshold(int zoomAnimationThreshold)

Won't animate zoom if the zoom difference exceeds this value.

Parameters:

zoomAnimationThreshold - The zoom animation threshold.

Returns:

Returns a MapOptions object with the set options.

setMarkerZoomAnimation

public MapOptions setMarkerZoomAnimation(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.

Parameters:

markerZoomAnimation - The marker zoom animation option.

Returns:

Returns a MapOptions object with the set options.