Interface WMSTileSetModelCreateOptions

Interface to provide HTTP request options.

interface WMSTileSetModelCreateOptions {
    backgroundColor?: string;
    bounds?: Bounds;
    credentials?: boolean;
    dataType?: RasterDataType;
    dimensions?: any;
    getFeatureInfoRoot?: string;
    getMapRoot?: string;
    imageFormat?: string;
    infoFormat?: string;
    reference?: CoordinateReference;
    requestHeaders?: null | HttpRequestHeaders;
    requestParameters?: any;
    samplingMode?: RasterSamplingMode;
    sld?: string;
    sldBody?: string;
    swapAxes?: string[];
    transparent?: boolean;
}

Hierarchy (view full)

Properties

backgroundColor? bounds? credentials? dataType? dimensions? getFeatureInfoRoot? getMapRoot? imageFormat? infoFormat? reference? requestHeaders? requestParameters? samplingMode? sld? sldBody? swapAxes? transparent?

Properties

OptionalbackgroundColor

backgroundColor?: string

A 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.

Optionalbounds

bounds?: Bounds

The 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:

  1. it defines the extent for which data should be loaded.
  2. the reference of this bounds is the reference which will be used to request images from the server. By convention, this model's reference is equal to the reference of this bounds parameter. It is also important to ensure that the reference of this bounds is supported by the WMS server. If you specify bounds you must not specify reference.

Optionalcredentials

credentials?: boolean

Whether credentials should be included with every HTTP request.

OptionaldataType

dataType?: RasterDataType

Configures the model'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.

The default is IMAGE.

Since

2024.0

Optionaldimensions

dimensions?: any

Dimension 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.

Default

<code>null</code>

OptionalgetFeatureInfoRoot

getFeatureInfoRoot?: string

Root URI of the getFeatureInfo request interface. Use this option to override the GetFeatureInfo URI that was returned in the capabilities object.

Since

2024.0

OptionalgetMapRoot

getMapRoot?: string

Root URI of the GetMap request interface. Use this option to override the GetMap URI that was returned in the capabilities object.

Since

2021.0.04

OptionalimageFormat

imageFormat?: string

The image format of the images to retrieve from the WMS server.

Default

"image/png"

OptionalinfoFormat

infoFormat?: string

The format to retrieve feature information (through GetFeatureInfo requests) from the WMS server.

Default

"application/json"

Optionalreference

reference?: CoordinateReference

The 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.

OptionalrequestHeaders

requestHeaders?: null | HttpRequestHeaders

An 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.

OptionalrequestParameters

requestParameters?: any

Custom 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.

OptionalsamplingMode

samplingMode?: RasterSamplingMode

Configures the model's RasterSamplingMode, corresponding to the setting representation of the underlying raster data.

For AREA. For POINT.

For elevation, samplingMode POINT is recommended for performance and accuracy.

Since

2024.0

Optionalsld

sld?: string

A 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.

OptionalsldBody

sldBody?: string

A 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.

OptionalswapAxes

swapAxes?: string[]

Indicates 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.

Optionaltransparent

transparent?: boolean

Indicates if the images should be generated with transparency or not.

Default

true

Settings

Member Visibility

On This Page

Properties