Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Overview

Properties

Optional credentials

credentials: boolean

Whether credentials should be included with every HTTP request.

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

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

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 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 wont 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

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