TileLayerWMSOptions.Builder (gwty-leaflet 1.0 API)

java.lang.Object
- com.gwidgets.api.leaflet.options.TileLayerWMSOptions.Builder

Enclosing class:: TileLayerWMSOptions

public static class TileLayerWMSOptions.Builder
extends Object

The Class Builder.

Constructor Summary

Constructors
Constructor and Description

Builder(String layers)
Instantiates a new builder.

Constructors
Constructor and Description
`Builder(String layers)` Instantiates a new builder.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TileLayerWMSOptions.Builder`	`attribution(String attribution)` the string used by the attribution control, describes the layer data.
`TileLayerWMSOptions.Builder`	`bounds(LatLngBounds bounds)` When this option is set, the TileLayer only loads tiles that are in the given geographical bounds.
`TileLayerWMSOptions`	`build()` Builds the TileLayerWMSOptions new instance
`TileLayerWMSOptions.Builder`	`className(String className)`
`TileLayerWMSOptions.Builder`	`crossOrigin(Boolean crossOrigin)`
`TileLayerWMSOptions.Builder`	`crs(CRS crs)` Coordinate Reference System to use for the WMS requests, defaults to map CRS.
`TileLayerWMSOptions.Builder`	`detectRetina(Boolean 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.
`TileLayerWMSOptions.Builder`	`errorTileUrl(String errorTileUrl)` URL to the tile image to show in place of the tile that failed to load.
`TileLayerWMSOptions.Builder`	`format(String format)` WMS image format (use 'image/png' for layers with transparency).
`TileLayerWMSOptions.Builder`	`keepBuffer(Double keepBuffer)`
`TileLayerWMSOptions.Builder`	`maxNativeZoom(Double maxNativeZoom)` Maximum zoom number the tiles source has available.
`TileLayerWMSOptions.Builder`	`maxZoom(Double maxZoom)` Maximum zoom number.
`TileLayerWMSOptions.Builder`	`minNativeZoom(Double minNativeZoom)`
`TileLayerWMSOptions.Builder`	`minZoom(Double minZoom)` Minimum zoom number.
`TileLayerWMSOptions.Builder`	`noWrap(Boolean noWrap)` If set to true, the tiles just won't load outside the world width (-180 to 180 longitude) instead of repeating.
`TileLayerWMSOptions.Builder`	`opacity(Double opacity)` The opacity of the tile layer.
`TileLayerWMSOptions.Builder`	`pane(String pane)`
`TileLayerWMSOptions.Builder`	`styles(String styles)` Comma-separated list of WMS styles.
`TileLayerWMSOptions.Builder`	`subdomains(String[] subdomains)` Subdomains of the tile service.
`TileLayerWMSOptions.Builder`	`tileSize(Double tileSize)` Tile size (width and height in pixels, assuming tiles are square).
`TileLayerWMSOptions.Builder`	`tms(Boolean tms)` If true, inverses Y axis numbering for tiles (turn this on for TMS services).
`TileLayerWMSOptions.Builder`	`transparent(Boolean transparent)` If true, the WMS service will return images with transparency.
`TileLayerWMSOptions.Builder`	`updateInterval(Boolean updateInterval)`
`TileLayerWMSOptions.Builder`	`updateWhenIdle(Boolean updateWhenIdle)` If false, new tiles are loaded during panning, otherwise only after it (for better performance).
`TileLayerWMSOptions.Builder`	`updateWhenZooming(Boolean updateWhenZooming)`
`TileLayerWMSOptions.Builder`	`version(String version)` Version of the WMS service to use.
`TileLayerWMSOptions.Builder`	`zIndex(Double zIndex)` The explicit zIndex of the tile layer.
`TileLayerWMSOptions.Builder`	`zoomOffset(Double zoomOffset)` The zoom number used in tile URLs will be offset with this value.
`TileLayerWMSOptions.Builder`	`zoomReverse(Boolean zoomReverse)` If set to true, 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
  - Builder
```
public Builder(String layers)
```
    Instantiates a new builder.
    
    Parameters:
    
    layers - Comma-separated list of WMS layers to show.
- Method Detail
  - styles
```
public TileLayerWMSOptions.Builder styles(String styles)
```
    Comma-separated list of WMS styles.
    
    Parameters:
    
    styles - the styles
    
    Returns:
    
    the builder
  - format
```
public TileLayerWMSOptions.Builder format(String format)
```
    WMS image format (use 'image/png' for layers with transparency).
    default 'image/jpeg'
    
    Parameters:
    
    format - the format
    
    Returns:
    
    the builder
  - transparent
```
public TileLayerWMSOptions.Builder transparent(Boolean transparent)
```
    If true, the WMS service will return images with transparency.
    default false
    
    Parameters:
    
    transparent - the transparent
    
    Returns:
    
    the builder
  - version
```
public TileLayerWMSOptions.Builder version(String version)
```
    Version of the WMS service to use.
    default "1.1.1"
    
    Parameters:
    
    version - the version
    
    Returns:
    
    the builder
  - crs
```
public TileLayerWMSOptions.Builder crs(CRS 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.
    
    Parameters:
    
    crs - the crs
    
    Returns:
    
    the builder
  - minZoom
```
public TileLayerWMSOptions.Builder minZoom(Double minZoom)
```
    Minimum zoom number.
    default 0
    
    Parameters:
    
    minZoom - the min zoom
    
    Returns:
    
    the builder
  - maxZoom
```
public TileLayerWMSOptions.Builder maxZoom(Double maxZoom)
```
    Maximum zoom number.
    default 18
    
    Parameters:
    
    maxZoom - the max zoom
    
    Returns:
    
    the builder
  - maxNativeZoom
```
public TileLayerWMSOptions.Builder maxNativeZoom(Double 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 maxNativeZoom level and auto-scaled.
    default null
    
    Parameters:
    
    maxNativeZoom - the max native zoom
    
    Returns:
    
    the builder
  - tileSize
```
public TileLayerWMSOptions.Builder tileSize(Double tileSize)
```
    Tile size (width and height in pixels, assuming tiles are square).
    default 256
    
    Parameters:
    
    tileSize - the tile size
    
    Returns:
    
    the builder
  - subdomains
```
public TileLayerWMSOptions.Builder subdomains(String[] subdomains)
```
    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"}
    
    Parameters:
    
    subdomains - the subdomains
    
    Returns:
    
    the builder
  - errorTileUrl
```
public TileLayerWMSOptions.Builder errorTileUrl(String errorTileUrl)
```
    URL to the tile image to show in place of the tile that failed to load.
    default ""
    
    Parameters:
    
    errorTileUrl - the error tile url
    
    Returns:
    
    the builder
  - attribution
```
public TileLayerWMSOptions.Builder attribution(String attribution)
```
    the string used by the attribution control, describes the layer data.
    default ""
    
    Parameters:
    
    attribution - the attribution
    
    Returns:
    
    the builder
  - tms
```
public TileLayerWMSOptions.Builder tms(Boolean tms)
```
    If true, inverses Y axis numbering for tiles (turn this on for TMS services).
    default true
    
    Parameters:
    
    tms - the tms
    
    Returns:
    
    the builder
  - noWrap
```
public TileLayerWMSOptions.Builder noWrap(Boolean noWrap)
```
    If set to true, the tiles just won't load outside the world width (-180 to 180 longitude) instead of repeating. default false
    
    Parameters:
    
    noWrap - the no wrap
    
    Returns:
    
    the builder
  - zoomOffset
```
public TileLayerWMSOptions.Builder zoomOffset(Double zoomOffset)
```
    The zoom number used in tile URLs will be offset with this value.
    default 0
    
    Parameters:
    
    zoomOffset - the zoom offset
    
    Returns:
    
    the builder
  - zoomReverse
```
public TileLayerWMSOptions.Builder zoomReverse(Boolean zoomReverse)
```
    If set to true, the zoom number used in tile URLs will be reversed (maxZoom - zoom instead of zoom).
    default false
    
    Parameters:
    
    zoomReverse - the zoom reverse
    
    Returns:
    
    the builder
  - opacity
```
public TileLayerWMSOptions.Builder opacity(Double opacity)
```
    The opacity of the tile layer.
    default 1.0
    
    Parameters:
    
    opacity - the opacity
    
    Returns:
    
    the builder
  - zIndex
```
public TileLayerWMSOptions.Builder zIndex(Double zIndex)
```
    The explicit zIndex of the tile layer. Not set by default.
    default null
    
    Parameters:
    
    zIndex - the z index
    
    Returns:
    
    the builder
  - updateWhenIdle
```
public TileLayerWMSOptions.Builder updateWhenIdle(Boolean updateWhenIdle)
```
    If false, new tiles are loaded during panning, otherwise only after it (for better performance). true by default on mobile WebKit, otherwise false.
    default true
    
    Parameters:
    
    updateWhenIdle - the update when idle
    
    Returns:
    
    the builder
  - detectRetina
```
public TileLayerWMSOptions.Builder detectRetina(Boolean 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.
    default false
    
    Parameters:
    
    detectRetina - the detect retina
    
    Returns:
    
    the builder
  - bounds
```
public TileLayerWMSOptions.Builder bounds(LatLngBounds bounds)
```
    When this option is set, the TileLayer only loads tiles that are in the given geographical bounds.
    default null
    
    Parameters:
    
    bounds - the bounds
    
    Returns:
    
    the builder
  - crossOrigin
```
public TileLayerWMSOptions.Builder crossOrigin(Boolean crossOrigin)
```
  - keepBuffer
```
public TileLayerWMSOptions.Builder keepBuffer(Double keepBuffer)
```
  - className
```
public TileLayerWMSOptions.Builder className(String className)
```
  - pane
```
public TileLayerWMSOptions.Builder pane(String pane)
```
  - updateWhenZooming
```
public TileLayerWMSOptions.Builder updateWhenZooming(Boolean updateWhenZooming)
```
  - updateInterval
```
public TileLayerWMSOptions.Builder updateInterval(Boolean updateInterval)
```
  - minNativeZoom
```
public TileLayerWMSOptions.Builder minNativeZoom(Double minNativeZoom)
```
  - build
```
public TileLayerWMSOptions build()
```
    Builds the TileLayerWMSOptions new instance
    
    Returns:
    
    the tile layer WMS options

Class TileLayerWMSOptions.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

styles

format

transparent

version

crs

minZoom

maxZoom

maxNativeZoom

tileSize

subdomains

errorTileUrl

attribution

tms

noWrap

zoomOffset

zoomReverse

opacity

zIndex

updateWhenIdle

detectRetina

bounds

crossOrigin

keepBuffer

className

pane

updateWhenZooming

updateInterval

minNativeZoom

build