Optional
backgroundA string that represents the required background color when
images are requested from the server (only applicable when transparent
is false). The color format is "0xRRGGBB", where RGB values are
represented as hexadecimal numbers. If a string is passed that
does not adhere to this format an exception will be thrown.
Optional
boundsThe extent of the WMS model. This parameter has two purposes:
reference
instead.
bounds
you must not specify reference
.
Optional
credentialsWhether credentials should be included with every HTTP request.
Optional
dataConfigures the layer's RasterDataType.
The ELEVATION raster data type will only have an effect in a 3D map, and acts as a way of representing 3D terrain visually. The ELEVATION dataType will not be visualized as a colorized heightmap as it only affects the 3D height values of the surface of the earth. It can be used when an elevation data is served through the WMTS protocol.
The default is IMAGE.
2021.0
Optional
dimensionsDimension parameters to send along with WMS GetMap
and
GetFeatureInfo
requests. Typical dimensions are
TIME
and ELEVATION
. The object literal
can contain simple key/value pairs. Accepted values are strings,
numbers, booleans. Values must not be URL encoded.
<code>null</code>
Root URI of the getMap
request interface.
Optional
imageThe image format of the images to retrieve from the WMS server.
"image/png"
Optional
infoThe default MIME-type for GetFeatureInfo
requests.
This can be overridden in the params of getFeatureInfoUrl.
"application/json" is used as default.
The WMS layers that will be requested from the WMS service.
Optional
level0The number of tile columns at the coarsest level. level0Columns will be computed automatically if not defined at construction time. If you do define level0Columns, you must also define level0Rows.
Optional
level0The number of tile rows at the coarsest level. level0Rows will be computed automatically if not defined. if you define level0Rows, you must also define level0Columns.
Optional
levelThe number of levels contained in this tileset. levelCount is 22 by default.
Optional
queryThe WMS layers that will be queried for feature info from the WMS service. If this is missing or an empty array, this model will not be queryable. See WMSTileSetLayer.getFeatureInfo for how to make feature info requests.
Optional
referenceThe spatial reference in which this model is
defined. You must only specify this parameter
if you do not know the extent of the WMS
coverage; in that case the world bounds will
be assumed. If you specify
bounds
, you can omit
this parameter.
Optional
requestAn object literal that represents headers (as a key-value map) to send with each HTTP request. If set (and not empty), an XHR with the specified headers will be performed instead of creating an Image.
Optional
requestCustom request parameters to send along with WMS GetMap and GetFeatureInfo request. The object literal can contain simple key/value pairs (strings, numbers, booleans). Values must not be URL encoded.
Optional
samplingConfigures the layer's RasterSamplingMode, corresponding to the setting representation of the underlying raster data.
For elevation, samplingMode POINT is recommended for performance and accuracy.
2021.0
Optional
sldA URL to a Styled Layer Descriptor (SLD) that must be used to make a request.
This parameter conflicts with sldBody
, only one of these two
parameters can be used at construction time.
Optional
sldA Styled Layer Descriptor (SLD) XML Document that must be used to make a
request. The value must not be URL-encoded. This parameter conflicts with
the sld
parameter, only one of these two parameters can be
used at construction time.
Optional
stylesThe styles to apply on the image when making a request. Each style corresponds to a layer. Defaults to an empty array, meaning that no style names are configured for the requested layers.
Optional
subdomainsWhen specified, WMSTileSetModel.getTileURL will replace the
{s}
pattern in getMapRoot
with values
from subdomains
. This will cause tile requests to
be spread across different subdomains. Browsers limit the amount of
connections to a single domain. Using subdomains
avoids hitting this limit.
Optional
swapIndicates whether this model should swap the axis ordering of coordinates for the specified reference identifier(s) in WMS requests. If undefined, the axis ordering dictated by the model reference is respected. For each specified reference, the order will be reversed. This is for example needed to get an EPSG:4326 BBOX value that is encoded in longitude-latitude order instead of latitude-longitude.
Optional
tileThe height of each individual tile in pixels. TileHeight will be computed automatically if not defined at construction time. If you define tileHeight you must also define tileWidth.
Optional
tileThe width of each individual tile in pixels. TileWidth will be computed automatically if not defined. If you define tileWidth, you must also define tileHeight.
Optional
transparentIndicates if the images should be generated transparent or not.
false
Optional
versionVersion of the WMS Server.
"1.3.0"
Constructor options for WMSTileSetModel