com.gwidgets.api.leaflet.options

Class TileLayerWMSOptions.Builder

java.lang.Object

com.gwidgets.api.leaflet.options.TileLayerWMSOptions.Builder

Enclosing class:

TileLayerWMSOptions

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

The Class Builder.

Constructor Summary

Constructors

Constructor and Description
Builder(java.lang.String layers) Instantiates a new builder.

Method Summary

Modifier and Type	Method and Description
TileLayerWMSOptions	build() Builds the TileLayerWMSOptions new instance
TileLayerWMSOptions.Builder	crs(ICRS crs) Coordinate Reference System to use for the WMS requests, defaults to map CRS.
TileLayerWMSOptions.Builder	format(java.lang.String format) WMS image format (use 'image/png' for layers with transparency).
TileLayerWMSOptions.Builder	styles(java.lang.String styles) Comma-separated list of WMS styles.
TileLayerWMSOptions.Builder	transparent(java.lang.Boolean transparent) If true, the WMS service will return images with transparency.
TileLayerWMSOptions.Builder	version(java.lang.String version) Version of the WMS service to use.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(java.lang.String layers)

Instantiates a new builder.

Parameters:

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

Method Detail

styles

public TileLayerWMSOptions.Builder styles(java.lang.String styles)

Comma-separated list of WMS styles.

Parameters:

styles - the styles

Returns:

the builder

format

public TileLayerWMSOptions.Builder format(java.lang.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(java.lang.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(java.lang.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(ICRS 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

build

public TileLayerWMSOptions build()

Builds the TileLayerWMSOptions new instance

Returns:

the tile layer WMS options