com.gwidgets.api.leaflet.options

Class TileLayerOptions

java.lang.Object

com.gwidgets.api.leaflet.options.TileLayerOptions

@JsType(isNative=true,
        namespace="<global>",
        name="Object")
public class TileLayerOptions
extends Object

The Class TileLayerOptions.

Author:

Zakaria Amine

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TileLayerOptions.Builder

Constructor Summary

Constructors

Constructor and Description
TileLayerOptions()

Method Summary

Modifier and Type	Method and Description
String	getAttribution() Gets the string used by the attribution control, describes the layer data.
LatLngBounds	getBounds() Gets whether the TileLayer only loads tiles that are in the given geographical bounds.
String	getClassName()
boolean	getCrossOrigin()
boolean	getDetectRetina() Gets the detect retina option is set default false
String	getErrorTileUrl() Gets the URL to the tile image to show in place of the tile that failed to load.
int	getKeepBuffer()
double	getMaxNativeZoom() Gets the Maximum zoom number the tiles source has available.
int	getMaxZoom() Gets the max zoom.
double	getMinNativeZoom()
int	getMinZoom() Gets the min zoom.
boolean	getNoWrap() Gets whether the tiles just won't load outside the world width (-180 to 180 longitude) instead of repeating.
double	getOpacity() Gets the opacity of the tile layer.
String	getPane()
String[]	getSubdomains() Gets the Subdomains of the tile service.
int	getTileSize() Gets the Tile size (width and height in pixels, assuming tiles are square).
boolean	getTms() Gets whether If true, inverses Y axis numbering for tiles (turn this on for TMS services).
boolean	getUpdateInterval()
boolean	getUpdateWhenIdle() Gets whether the new tiles are loaded during panning, otherwise only after it (for better performance).
boolean	getUpdateWhenZooming()
int	getzIndex() Gets The explicit zIndex of the tile layer.
int	getZoomOffset() Gets The zoom number used in tile URLs will be offset with this value.
boolean	getZoomReverse() Gets the zoom number used in tile URLs will be reversed (maxZoom - zoom instead of zoom).

Methods inherited from class java.lang.Object

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

Constructor Detail

TileLayerOptions

public TileLayerOptions()

Method Detail

getMinZoom

@JsOverlay
public final int getMinZoom()

Gets the min zoom.
default 0

Returns:

the min zoom

getMaxZoom

@JsOverlay
public final int getMaxZoom()

Gets the max zoom.
default 18

Returns:

the max zoom

getMaxNativeZoom

@JsOverlay
public final double getMaxNativeZoom()

Gets the Maximum zoom number the tiles source has available. If it is specified, the tiles on all zoom levels higher than maxNativeZoom will be loaded from maxNativeZoom level and auto-scaled.
default null

Returns:

the max native zoom

getTileSize

@JsOverlay
public final int getTileSize()

Gets the Tile size (width and height in pixels, assuming tiles are square).
default 256

Returns:

the tile size

getSubdomains

@JsOverlay
public final String[] getSubdomains()

Gets the Subdomains of the tile service. Can be passed in the form of one string (where each letter is a subdomain name) or an array of strings.
default 'abc'

Returns:

the subdomains

getErrorTileUrl

@JsOverlay
public final String getErrorTileUrl()

Gets the URL to the tile image to show in place of the tile that failed to load.
default ""

Returns:

the error tile url

getAttribution

@JsOverlay
public final String getAttribution()

Gets the string used by the attribution control, describes the layer data.
default ""

Returns:

the attribution

getTms

@JsOverlay
public final boolean getTms()

Gets whether If true, inverses Y axis numbering for tiles (turn this on for TMS services).
default false

Returns:

the tms

getNoWrap

@JsOverlay
public final boolean getNoWrap()

Gets whether the tiles just won't load outside the world width (-180 to 180 longitude) instead of repeating.
default false

Returns:

the no wrap

getZoomOffset

@JsOverlay
public final int getZoomOffset()

Gets The zoom number used in tile URLs will be offset with this value.
default 0

Returns:

the zoom offset

getZoomReverse

@JsOverlay
public final boolean getZoomReverse()

Gets the zoom number used in tile URLs will be reversed (maxZoom - zoom instead of zoom).
default false

Returns:

the zoom reverse

getOpacity

@JsOverlay
public final double getOpacity()

Gets the opacity of the tile layer.
default 1.0

Returns:

the opacity

getzIndex

@JsOverlay
public final int getzIndex()

Gets The explicit zIndex of the tile layer. Not set by default.
default null

Returns:

the z index

getUpdateWhenIdle

@JsOverlay
public final boolean getUpdateWhenIdle()

Gets whether the new tiles are loaded during panning, otherwise only after it (for better performance). true by default on mobile WebKit, otherwise false.
default true

Returns:

the update when idle

getDetectRetina

@JsOverlay
public final boolean getDetectRetina()

Gets the detect retina option is set
default false

Returns:

the detect retina

getBounds

@JsOverlay
public final LatLngBounds getBounds()

Gets whether the TileLayer only loads tiles that are in the given geographical bounds.
default null

Returns:

the bounds

getMinNativeZoom

@JsOverlay
public final double getMinNativeZoom()

getUpdateWhenZooming

@JsOverlay
public final boolean getUpdateWhenZooming()

getUpdateInterval

@JsOverlay
public final boolean getUpdateInterval()

getCrossOrigin

@JsOverlay
public final boolean getCrossOrigin()

getPane

@JsOverlay
public final String getPane()

getClassName

@JsOverlay
public final String getClassName()

getKeepBuffer

@JsOverlay
public final int getKeepBuffer()