Options
All
  • Public
  • Public/Protected
  • All
Menu

Constructor options for WMTSTileSetModelConstructorOptions.

Hierarchy

Overview

Properties

bounds

bounds: Bounds

The spatial extent for this tileset

Optional credentials

credentials: boolean

Whether credentials should be included with every HTTP request.

Optional dataType

dataType: RasterDataType

Configures 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 WMS protocol.

The default is IMAGE.

since

2021.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. Default: "image/jpeg"

layer

layer: string

the name of the WMTS layer

Optional level0Columns

level0Columns: number

The number of tile columns at the coarsest level, the default value is 1.

Optional level0Rows

level0Rows: number

The number of tile rows at the coarsest level. Default: 1

Optional levelCount

levelCount: number

The number of levels contained in this tileset. Default: 22

Optional reference

The spatial reference in which this model is defined. By default the reference is deduced from the bounds parameter.

Optional requestHeaders

requestHeaders: {} | null

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

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 layer's RasterSamplingMode, corresponding to the setting representation of the underlying raster data.

For IMAGE dataType, the default sampling mode is AREA. For ELEVATION dataType, the default is POINT.

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

since

2021.0

Optional style

style: string

The style to apply on the image when making a request, the default value is "default".

Optional tileHeight

tileHeight: number

The height of each individual tile in pixels. Default: 256

tileMatrices

tileMatrices: number[] | string[]

The array of tile matrices identifiers

tileMatrixSet

tileMatrixSet: string

The name of the tile matrix set

Optional tileWidth

tileWidth: number

The width of each individual tile in pixels. Default: 256

url

url: string

root URI of the GetTile request interface

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method