org.fujion.lmaps

Class LeafletOptions

java.lang.Object

org.fujion.ancillary.Options

org.fujion.lmaps.LeafletOptions

All Implemented Interfaces:

org.fujion.ancillary.IOptionMapTransform, org.fujion.client.IClientTransform

public class LeafletOptions
extends org.fujion.ancillary.Options

Field Summary

Fields

Modifier and Type	Field and Description
Boolean	attributionControl Whether an attribution control is added to the map by default.
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.
LatLng	center Initial geographic center of the map.
Double	easeLinearity No information.
Boolean	fadeAnimation Whether the tile fade animation is enabled.
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.
Integer	inertiaDeceleration Max speed of the inertial movement, in pixels/second.
Boolean	keyboard Makes the map focusable and allows users to navigate the map with keyboard arrows and +/- keys.
Integer	keyboardPanDelta Amount of pixels to pan when pressing an arrow key.
Boolean	markerZoomAnimation Whether markers animate their zoom with the zoom animation, if disabled they will disappear for the length of the animation.
Double	maxBoundsViscosity If maxBounds is set, this option will control how solid the bounds are when dragging the map around.
Integer	maxZoom Maximum zoom level of the map.
Integer	minZoom Minimum zoom level of the map.
Boolean	preferCanvas Whether Paths should be rendered on a Canvas renderer.
Boolean	scrollWheelZoomBoolean Whether the map can be zoomed by using the mouse wheel.
String	scrollWheelZoomString Whether the map can be zoomed by using the mouse wheel.
Boolean	tap Enables mobile hacks for supporting instant taps (fixing 200ms click delay on iOS/Android) and touch holds (fired as contextmenu events).
Integer	tapTolerance The max number of pixels a user can shift his finger during touch for it to be considered a valid tap.
Boolean	touchZoomBoolean Whether the map can be zoomed by touch-dragging with two fingers.
String	touchZoomString Whether the map can be zoomed by touch-dragging with two fingers.
Double	transform3DLimit Defines the maximum size of a CSS translation transform.
Long	wheelDebounceTime Limits the rate at which a wheel can fire (in milliseconds).
Integer	wheelPxPerZoomLevel How many scroll pixels (as reported by L.DomEvent.getWheelDelta) mean a change of one full zoom level.
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.
Integer	zoom Initial map zoom level.
Boolean	zoomAnimation Whether the map zoom animation is enabled.
Double	zoomAnimationThreshold Won't animate zoom if the zoom difference exceeds this value.
Boolean	zoomControl Whether a zoom control is added to the map by default.

Constructor Summary

Constructors

Constructor and Description
LeafletOptions()

Method Summary

Methods inherited from class org.fujion.ancillary.Options

toMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.fujion.ancillary.IOptionMapTransform

transformForClient

Field Detail

preferCanvas

@Option
public Boolean preferCanvas

Whether Paths should be rendered on a Canvas renderer. By default, all Paths are rendered in a SVG renderer.

Default: false

attributionControl

@Option
public Boolean attributionControl

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

Default: true

zoomControl

@Option
public Boolean zoomControl

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

Default: true

zoom

@Option
public Integer zoom

Initial map zoom level.

minZoom

@Option
public Integer minZoom

Minimum zoom level of the map. If not specified and at least one GridLayer or TileLayer is in the map, the lowest of their minZoom options will be used instead.

maxZoom

@Option
public Integer maxZoom

Maximum zoom level of the map. If not specified and at least one GridLayer or TileLayer is in the map, the highest of their maxZoom options will be used instead.

center

@Option(required=true)
public LatLng center

Initial geographic center of the map.

zoomAnimation

@Option
public Boolean zoomAnimation

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

Default: true

zoomAnimationThreshold

@Option
public Double zoomAnimationThreshold

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

Default: 4

fadeAnimation

@Option
public 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

markerZoomAnimation

@Option
public 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

transform3DLimit

@Option
public 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.

Default: 2^23

inertia

@Option
public 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. Enabled by default unless running on old Android devices.

inertiaDeceleration

@Option
public Integer inertiaDeceleration

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

Default: no limit

easeLinearity

@Option
public Double easeLinearity

No information.

Default: 0.2

worldCopyJump

@Option
public 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

maxBoundsViscosity

@Option
public 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.

Default: 0.0

keyboard

@Option
public Boolean keyboard

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

Default: true

keyboardPanDelta

@Option
public Integer keyboardPanDelta

Amount of pixels to pan when pressing an arrow key.

Default: 80

scrollWheelZoomBoolean

@Option(value="scrollWheelZoom")
public Boolean scrollWheelZoomBoolean

Whether the map can be zoomed by using the mouse wheel.

Default: true

scrollWheelZoomString

@Option(value="scrollWheelZoom")
public String scrollWheelZoomString

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.

wheelDebounceTime

@Option
public Long 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.

Default: 40

wheelPxPerZoomLevel

@Option
public Integer 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).

Default: 60

tap

@Option
public 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

tapTolerance

@Option
public Integer tapTolerance

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

Default: 15

touchZoomBoolean

@Option(value="touchZoom")
public Boolean touchZoomBoolean

Whether the map can be zoomed by touch-dragging with two fingers. Enabled for touch-capable web browsers except for old Androids.

Default: *

touchZoomString

@Option(value="touchZoom")
public String touchZoomString

Whether the map can be zoomed by touch-dragging with two fingers. If passed 'center', it will zoom to the center of the view regardless of where the touch events (fingers) were. Enabled for touch-capable web browsers except for old Androids.

Default: *

bounceAtZoomLimits

@Option
public 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

Constructor Detail

LeafletOptions

public LeafletOptions()