net.java.html.leaflet

Class TileLayerWMSOptions

java.lang.Object

net.java.html.leaflet.TileLayerWMSOptions

public final class TileLayerWMSOptions
extends Object

Options for configuring a TileLayerWMS.

Constructor Summary

Constructors

Constructor and Description
TileLayerWMSOptions(String layers) Creates a TileLayerWMSOptions object

Method Summary

Modifier and Type	Method and Description
TileLayerWMSOptions	setAttribution(String attribution) Sets the attribution option
TileLayerWMSOptions	setBounds(LatLngBounds bounds) Sets the bounds option
TileLayerWMSOptions	setContinuousWorld(boolean continuousWorld) Sets the continuousWorld option
TileLayerWMSOptions	setCRS(ICRS crs) Sets the CRS option
TileLayerWMSOptions	setDetectRetina(boolean detectRetina) Sets the detectRetina option
TileLayerWMSOptions	setErrorTileUrl(String url) Sets the error tile url option
TileLayerWMSOptions	setFormat(String format) Sets the format option.
TileLayerWMSOptions	setId(String id) Sets the id option
TileLayerWMSOptions	setMaxNativeZoom(int maxNativeZoom) Sets the maxNativeZoom option
TileLayerWMSOptions	setMaxZoom(int maxZoom) Sets the maxZoom option
TileLayerWMSOptions	setMinZoom(int minZoom) Sets the minZoom option.
TileLayerWMSOptions	setNoWrap(boolean noWrap) Sets the noWrap option
TileLayerWMSOptions	setopacity(int opacity) Sets the opacity option
TileLayerWMSOptions	setReuseTiles(boolean reuseTiles) Sets the reuseTiles option
TileLayerWMSOptions	setStyles(String styles) Sets the styles option
TileLayerWMSOptions	setSubdomains(String subdomain) Sets the subdomains option
TileLayerWMSOptions	setSubdomains(String[] subdomains) Sets the subdomains option
TileLayerWMSOptions	setTileSize(int tileSize) Sets the tileSize option
TileLayerWMSOptions	setTms(boolean tms) Sets the tms option
TileLayerWMSOptions	setTransparent(boolean transparent) Sets the transparent option
TileLayerWMSOptions	setUnloadInvisibleTiles(boolean unload) Sets the unload invisible tiles option
TileLayerWMSOptions	setUpdateWhenIdle(boolean updateWhenIdle) Sets the updateWhenIdle option
TileLayerWMSOptions	setVersion(String version) Sets the version option
TileLayerWMSOptions	setZIndex(int zIndex) Sets the zIndex option
TileLayerWMSOptions	setZoomOffset(int zoomOffset) Sets the zoomOffset option
TileLayerWMSOptions	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

TileLayerWMSOptions

public TileLayerWMSOptions(String layers)

Creates a TileLayerWMSOptions object

Parameters:

layers - Comma-separated list of WMS layers to show.

Method Detail

setMinZoom

public TileLayerWMSOptions setMinZoom(int minZoom)

Sets the minZoom option.

Parameters:

minZoom - Minimum zoom number

Returns:

updated options

setMaxZoom

public TileLayerWMSOptions setMaxZoom(int maxZoom)

Sets the maxZoom option

Parameters:

maxZoom - Maximum zoom number

Returns:

updated options

setMaxNativeZoom

public TileLayerWMSOptions 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 TileLayerWMSOptions 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 TileLayerWMSOptions 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 TileLayerWMSOptions setSubdomains(String[] subdomains)

Sets the subdomains option

Parameters:

subdomains - Subdomains of the tile service.

Returns:

updated options

setErrorTileUrl

public TileLayerWMSOptions 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 TileLayerWMSOptions 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 TileLayerWMSOptions 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 TileLayerWMSOptions 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 TileLayerWMSOptions 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 TileLayerWMSOptions 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 TileLayerWMSOptions 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 TileLayerWMSOptions setopacity(int opacity)

Sets the opacity option

Parameters:

opacity - The opacity of the tile layer.

Returns:

updated options

setZIndex

public TileLayerWMSOptions 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 TileLayerWMSOptions 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 TileLayerWMSOptions 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 TileLayerWMSOptions 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 TileLayerWMSOptions 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 TileLayerWMSOptions 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 TileLayerWMSOptions setId(String id)

Sets the id option

Parameters:

id - (Unique) identifier for a layer.

Returns:

updated options

setStyles

public TileLayerWMSOptions setStyles(String styles)

Sets the styles option

Parameters:

styles - Comma-separated list of WMS styles.

Returns:

Updated options.

setFormat

public TileLayerWMSOptions setFormat(String format)

Sets the format option.

Parameters:

format - WMS image format (use 'image/png' for layers with transparency).

Returns:

Update options.

setTransparent

public TileLayerWMSOptions setTransparent(boolean transparent)

Sets the transparent option

Parameters:

transparent - If true, the WMS service will return images with transparency.

Returns:

updated option

setVersion

public TileLayerWMSOptions setVersion(String version)

Sets the version option

Parameters:

version - Version of the WMS service to use.

Returns:

updated options

setCRS

public TileLayerWMSOptions setCRS(ICRS crs)

Sets the CRS option

Parameters:

crs - Coordinate Reference System to use for the WMS requests, defaults to map CRS. Don't change this if you're not sure what it means.

Returns:

updated options