com.gwidgets.api.leaflet.options

Class LocateOptions

java.lang.Object

com.gwidgets.api.leaflet.options.LocateOptions

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

The Class LocateOptions.

Author:

Zakaria Amine

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LocateOptions.Builder The Class Builder.

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getEnableHighAccuracy() Gets whether high accuracy is enabled, see description in the W3C spec .
java.lang.Number	getMaximumAge() Gets the maximum age of detected location.
java.lang.Number	getMaxZoom() Gets the maximum zoom for automatic view setting when using `setView` option.
java.lang.Boolean	getSetView() Gets whether If true, automatically sets the map view to the user location with respect to detection accuracy, or to world view if geolocation failed.
java.lang.Number	getTimeout() Gets the number of milliseconds to wait for a response from geolocation before firing a locationerror event.
java.lang.Boolean	getWatch() Gets whether continuous watching of location changes (instead of detecting it once) using W3C watchPosition method is set.

Methods inherited from class java.lang.Object

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

Method Detail

getWatch

@JsOverlay
public final java.lang.Boolean getWatch()

Gets whether continuous watching of location changes (instead of detecting it once) using W3C watchPosition method is set.
default false

Returns:

the watch

getSetView

@JsOverlay
public final java.lang.Boolean getSetView()

Gets whether If true, automatically sets the map view to the user location with respect to detection accuracy, or to world view if geolocation failed.
default false

Returns:

the sets the view

getMaxZoom

@JsOverlay
public final java.lang.Number getMaxZoom()

Gets the maximum zoom for automatic view setting when using `setView` option.
default infinity

Returns:

the max zoom locate

getTimeout

@JsOverlay
public final java.lang.Number getTimeout()

Gets the number of milliseconds to wait for a response from geolocation before firing a locationerror event.
default 10000

Returns:

the timeout

getMaximumAge

@JsOverlay
public final java.lang.Number getMaximumAge()

Gets the maximum age of detected location. If less than this amount of milliseconds passed since last geolocation response, locate will return a cached location.
default 0

Returns:

the maximum age

getEnableHighAccuracy

@JsOverlay
public final java.lang.Boolean getEnableHighAccuracy()

Gets whether high accuracy is enabled, see description in the W3C spec .
default false

Returns:

the enable high accuracy