Optional
backgroundA string that represents the required background color (BGCOLOR) 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 preferred extent of the WMS model. If not defined, the bounds are automatically determined based on the layer bounds information available in the WMS capabilities. If defined, it has two purposes:
bounds
you must not specify reference
.
Optional
credentialsWhether credentials should be included with every HTTP request.
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>
Optional
getRoot URI of the getMap
request interface. If this is not specified, a model will be created
with the GetMap
URI as specified in the capabilities object.
2021.0.04
Optional
imageThe image format of the images to retrieve from the WMS server.
"image/png"
Optional
infoThe format to retrieve feature information (through
GetFeatureInfo
requests) from the WMS server.
"application/json"
Optional
referenceThe spatial reference in which this model is
defined. If you specify
bounds
, you can omit
this parameter. If this parameter and bounds
are both not defined, WGS 84 is used as default reference.
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
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
swapIndicates whether this model should swap the axis ordering of coordinates for the specified reference identifiers 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 needed to get an EPSG:4326 BBOX value that is encoded in longitude-latitude order instead of latitude-longitude, for example.
Optional
transparentIndicates if the images should be generated with transparency or not.
true
Interface to provide HTTP request options.