Interface WMTSTileSetModelCreateOptions

Options to create WMTSTileSetModel.createFromCapabilities or WMTSTileSetModel.createFromURL

interface WMTSTileSetModelCreateOptions {
    credentials?: boolean;
    dataType?: RasterDataType;
    dimensions?: object;
    format?: string;
    reference?: CoordinateReference;
    requestHeaders?: null | HttpRequestHeaders;
    requestParameters?: null | HttpRequestParameters;
    samplingMode?: RasterSamplingMode;
    tileMatrixSet?: string;
    url?: string;
    useQuadTreeOnly?: boolean;
}

Hierarchy (view full)

Properties

credentials? dataType? dimensions? format? reference? requestHeaders? requestParameters? samplingMode? tileMatrixSet? url? useQuadTreeOnly?

Properties

Optional credentials

credentials?: boolean

Whether credentials should be included with every HTTP request.

Optional dataType

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

Optional dimensions

dimensions?: object

Dimension parameters to send along with WMTS GetTile request. Typical dimensions areTIME and ELEVATION. The object literal can contain simple key/value pairs. Accepted values are strings, numbers, booleans. Values must not be URL encoded.

Since

2021.0

Optional format

format?: string

The image format of the images to retrieve from the WMTS server

Optional reference

reference?: CoordinateReference

The preferred spatial reference of the tile matrix set, if it is not explicitly defined using tileMatrixSet. If no tile matrix set can be found for the given reference, an error is thrown.

Optional requestHeaders

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.

Optional requestParameters

requestParameters?: null | HttpRequestParameters

Custom request parameters to send along with WMTS GetMap and GetFeatureInfo request. The object literal can contain simple key/value pairs (strings, numbers, booleans). Values must not be URL encoded.

Since

2021.0

Optional samplingMode

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

Optional tileMatrixSet

tileMatrixSet?: string

The identifier of the tile matrix set. Will be computed automatically if not defined.

Optional url

url?: string

root URI of the GetTile request interface. Use this when you want to override the URI reported in the capabilities object.

Since

2021.0.04

Optional useQuadTreeOnly

useQuadTreeOnly?: boolean

Indicates that the WMTS tile set model creation must aim for quad-tree tile set structures only. The default behavior is to allow non-quad tree tile matrix sets.

Since

2023.0

Settings

Member Visibility

Theme

On This Page

credentialsdataTypedimensionsformatreferencerequestHeadersrequestParameterssamplingModetileMatrixSeturluseQuadTreeOnly