net.java.html.leaflet

Class TileLayerOptions

java.lang.Object

net.java.html.leaflet.TileLayerOptions

public final class TileLayerOptions
extends Object

Options for configuring a TileLayer.

Constructor Summary

Constructors

Constructor and Description
TileLayerOptions() Creates a TileLayerOptions object

Method Summary

Modifier and Type	Method and Description
TileLayerOptions	setAttribution(String attribution) Sets the attribution option
TileLayerOptions	setBounds(LatLngBounds bounds) Sets the bounds option
TileLayerOptions	setContinuousWorld(boolean continuousWorld) Sets the continuousWorld option
TileLayerOptions	setDetectRetina(boolean detectRetina) Sets the detectRetina option
TileLayerOptions	setErrorTileUrl(String url) Sets the error tile url option
TileLayerOptions	setId(String id) Sets the id option
TileLayerOptions	setMaxNativeZoom(int maxNativeZoom) Sets the maxNativeZoom option
TileLayerOptions	setMaxZoom(int maxZoom) Sets the maxZoom option
TileLayerOptions	setMinZoom(int minZoom) Sets the minZoom option.
TileLayerOptions	setNoWrap(boolean noWrap) Sets the noWrap option
TileLayerOptions	setopacity(int opacity) Sets the opacity option
TileLayerOptions	setReuseTiles(boolean reuseTiles) Sets the reuseTiles option
TileLayerOptions	setSubdomains(String subdomain) Sets the subdomains option
TileLayerOptions	setSubdomains(String[] subdomains) Sets the subdomains option
TileLayerOptions	setTileSize(int tileSize) Sets the tileSize option
TileLayerOptions	setTms(boolean tms) Sets the tms option
TileLayerOptions	setUnloadInvisibleTiles(boolean unload) Sets the unload invisible tiles option
TileLayerOptions	setUpdateWhenIdle(boolean updateWhenIdle) Sets the updateWhenIdle option
TileLayerOptions	setZIndex(int zIndex) Sets the zIndex option
TileLayerOptions	setZoomOffset(int zoomOffset) Sets the zoomOffset option
TileLayerOptions	setZoomReverse(boolean zoomReverse) Sets the zoomReverse option

Methods inherited from class java.lang.Object

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

Constructor Detail

TileLayerOptions

public TileLayerOptions()

Creates a TileLayerOptions object

Method Detail

setMinZoom

public TileLayerOptions setMinZoom(int minZoom)

Sets the minZoom option.

Parameters:

minZoom - Minimum zoom number

Returns:

updated options

setMaxZoom

public TileLayerOptions setMaxZoom(int maxZoom)

Sets the maxZoom option

Parameters:

maxZoom - Maximum zoom number

Returns:

updated options

setMaxNativeZoom

public TileLayerOptions setMaxNativeZoom(int maxNativeZoom)

Sets the maxNativeZoom option

Parameters:

maxNativeZoom - 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 maxZoom level and auto-scaled.

Returns:

updated options

setTileSize

public TileLayerOptions setTileSize(int tileSize)

Sets the tileSize option

Parameters:

tileSize - Tile size (width and height in pixels, assuming tiles are square).

Returns:

updated options

setSubdomains

public TileLayerOptions setSubdomains(String subdomain)

Sets the subdomains option

Parameters:

subdomain - Subdomains of the tile service. Each letter of the String is a subdomain name.

Returns:

updated options

setSubdomains

public TileLayerOptions setSubdomains(String[] subdomains)

Sets the subdomains option

Parameters:

subdomains - Subdomains of the tile service.

Returns:

updated options

setErrorTileUrl

public TileLayerOptions setErrorTileUrl(String url)

Sets the error tile url option

Parameters:

url - URL to the tile image to show in place of the tile that failed to load.

Returns:

updated options

setAttribution

public TileLayerOptions setAttribution(String attribution)

Sets the attribution option

Parameters:

attribution - The string used by the attribution control, describes the layer data.

Returns:

updated options

setTms

public TileLayerOptions setTms(boolean tms)

Sets the tms option

Parameters:

tms - If true, inverses Y axis numbering for tiles (turn this on for TMS services)

Returns:

updated options

setContinuousWorld

public TileLayerOptions setContinuousWorld(boolean continuousWorld)

Sets the continuousWorld option

Parameters:

continuousWorld - If set to true, the tile coordinates won't be wrapped by world width (-180 to 180 longitude) or clamped to lie within world height (-90 to 90). Use this if you use Leaflet for maps that don't reflect the real world (e.g. game, indoor or photo maps).

Returns:

updated options

setNoWrap

public TileLayerOptions setNoWrap(boolean noWrap)

Sets the noWrap option

Parameters:

noWrap - If set to true, the tiles just won't load outside the world width (-180 to 180 longitude) instead of repeating.

Returns:

updated options

setZoomOffset

public TileLayerOptions setZoomOffset(int zoomOffset)

Sets the zoomOffset option

Parameters:

zoomOffset - The zoom number used in tile URLs will be offset with this value.

Returns:

updated options

setZoomReverse

public TileLayerOptions setZoomReverse(boolean zoomReverse)

Sets the zoomReverse option

Parameters:

zoomReverse - If set to true, the zoom number used in tile URLs will be reversed (maxZoom - zoom instead of zoom)

Returns:

updated options

setopacity

public TileLayerOptions setopacity(int opacity)

Sets the opacity option

Parameters:

opacity - The opacity of the tile layer.

Returns:

updated options

setZIndex

public TileLayerOptions setZIndex(int zIndex)

Sets the zIndex option

Parameters:

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

Returns:

updated options

setUnloadInvisibleTiles

public TileLayerOptions setUnloadInvisibleTiles(boolean unload)

Sets the unload invisible tiles option

Parameters:

unload - If true, all the tiles that are not visible after panning are removed (for better performance). true by default on mobile WebKit, otherwise false.

Returns:

updated options

setUpdateWhenIdle

public TileLayerOptions setUpdateWhenIdle(boolean updateWhenIdle)

Sets the updateWhenIdle option

Parameters:

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

Returns:

updated options

setDetectRetina

public TileLayerOptions setDetectRetina(boolean detectRetina)

Sets the detectRetina option

Parameters:

detectRetina - If true and user is on a retina display, it will request four tiles of half the specified size and a bigger zoom level in place of one to utilize the high resolution.

Returns:

updated options

setReuseTiles

public TileLayerOptions setReuseTiles(boolean reuseTiles)

Sets the reuseTiles option

Parameters:

reuseTiles - If true, all the tiles that are not visible after panning are placed in a reuse queue from which they will be fetched when new tiles become visible (as opposed to dynamically creating new ones). This will in theory keep memory usage low and eliminate the need for reserving new memory whenever a new tile is needed.

Returns:

updated options

setBounds

public TileLayerOptions setBounds(LatLngBounds bounds)

Sets the bounds option

Parameters:

bounds - When this option is set, the TileLayer only loads tiles that are in the given geographical bounds.

Returns:

updated options

setId

public TileLayerOptions setId(String id)

Sets the id option

Parameters:

id - (Unique) identifier for a layer.

Returns:

updated options