com.gwidgets.api.leaflet.options

Class LocateOptions.Builder

java.lang.Object

com.gwidgets.api.leaflet.options.LocateOptions.Builder

Enclosing class:

LocateOptions

public static class LocateOptions.Builder
extends java.lang.Object

The Class Builder.

Constructor Summary

Constructors

Constructor and Description
Builder() Instantiates a new builder.

Method Summary

Modifier and Type	Method and Description
LocateOptions	build() Builds the LocateOptions new instance
LocateOptions.Builder	enableHighAccuracy(java.lang.Boolean enableHighAccuracy) Gets whether high accuracy is enabled, see description in the W3C spec .
LocateOptions.Builder	maximumAge(java.lang.Number maximumAge) Maximum age of detected location.
LocateOptions.Builder	maxZoom(java.lang.Number maxZoom) The maximum zoom for automatic view setting when using `setView` option.
LocateOptions.Builder	setView(java.lang.Boolean setView) If true, automatically sets the map view to the user location with respect to detection accuracy, or to world view if geolocation failed.
LocateOptions.Builder	timeout(java.lang.Number timeout) Number of milliseconds to wait for a response from geolocation before firing a locationerror event.Timeout.
LocateOptions.Builder	watch(java.lang.Boolean watch) If true, starts continuous watching of location changes (instead of detecting it once) using W3C watchPosition method.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Instantiates a new builder.

Method Detail

watch

public LocateOptions.Builder watch(java.lang.Boolean watch)

If true, starts continuous watching of location changes (instead of detecting it once) using W3C watchPosition method. You can later stop watching using map.stopLocate() method.
default false

Parameters:

watch - the watch

Returns:

the builder

setView

public LocateOptions.Builder setView(java.lang.Boolean setView)

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

Parameters:

setView - the set view

Returns:

the builder

maxZoom

public LocateOptions.Builder maxZoom(java.lang.Number maxZoom)

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

Parameters:

maxZoomLocate - the max zoom locate

Returns:

the builder

timeout

public LocateOptions.Builder timeout(java.lang.Number timeout)

Number of milliseconds to wait for a response from geolocation before firing a locationerror event.Timeout.
default 10000

Parameters:

timeout - the timeout

Returns:

the builder

maximumAge

public LocateOptions.Builder maximumAge(java.lang.Number maximumAge)

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

Parameters:

maximumAge - the maximum age

Returns:

the builder

enableHighAccuracy

public LocateOptions.Builder enableHighAccuracy(java.lang.Boolean enableHighAccuracy)

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

Parameters:

enableHighAccuracy - the enable high accuracy

Returns:

the builder

build

public LocateOptions build()

Builds the LocateOptions new instance

Returns:

the locate options