ConstructorOptions

external interface ConstructorOptions(source)

Initialization options for the WebMapTileServiceImageryProvider constructor

See also

Properties

Link copied to clipboard
abstract external val clock: Clock?

A Clock instance that is used when determining the value for the time dimension. Required when times is specified.

Link copied to clipboard
abstract external val credit: Credit?

A credit for the data source, which is displayed on the canvas.

Link copied to clipboard
abstract external val dimensions: JsAny?

A object containing static dimensions and their values.

Link copied to clipboard
abstract external val ellipsoid: Ellipsoid?

The ellipsoid. If not specified, the WGS84 ellipsoid is used.

Link copied to clipboard
abstract external val enablePickFeatures: Boolean?

If true, WebMapTileServiceImageryProvider.pickFeatures will invoke the GetFeatureInfo operation on the WMTS server and return the features included in the response. If false, WebMapTileServiceImageryProvider.pickFeatures will immediately return undefined (indicating no pickable features) without communicating with the server. Set this property to false if you know your WMTS server does not support GetFeatureInfo or if you don't want this provider's features to be pickable. Defaults to true for KVP encoding. For RESTful encoding, defaults to true only when {@link WebMapTileServiceImageryProvider.ConstructorOptions#getFeatureInfoUrl} is specified, and false otherwise.

Link copied to clipboard
abstract external val format: String?

The MIME type for images to retrieve from the server. Default value - 'image/jpeg'

Link copied to clipboard

The formats in which to try WMTS GetFeatureInfo requests. Since feature info responses vary across WMTS services, you may need to supply a custom format and parsing callback; see the Sandcastle example for a complete example of writing your own callback. Default value - WebMapTileServiceImageryProvider.DefaultGetFeatureInfoFormats

Link copied to clipboard
abstract external val getFeatureInfoParameters: JsAny?

Additional parameters to include in GetFeatureInfo requests. Keys are lowercased internally.

Link copied to clipboard
abstract external val getFeatureInfoUrl: Resource?

The GetFeatureInfo URL of the WMTS service. If not specified, the value of url is used.

Link copied to clipboard
abstract external val layer: String

The layer name for WMTS requests.

Link copied to clipboard
abstract external val maximumLevel: Int?

The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit.

Link copied to clipboard
abstract external val minimumLevel: Int?

The minimum level-of-detail supported by the imagery provider. Default value - 0

Link copied to clipboard
abstract external val rectangle: Rectangle?

The rectangle covered by the layer. Default value - Rectangle.MAX_VALUE

Link copied to clipboard
abstract external val style: String

The style name for WMTS requests.

Link copied to clipboard
abstract external val subdomains: ReadonlyArray<JsString>?

The subdomains to use for the {s} placeholder in the URL template. If this parameter is a single string, each character in the string is a subdomain. If it is an array, each element in the array is a subdomain. Default value - 'abc'

Link copied to clipboard
abstract external val tileHeight: Int?

The tile height in pixels. Default value - 256

Link copied to clipboard
abstract external val tileMatrixLabels: ReadonlyArray<JsAny>?

A list of identifiers in the TileMatrix to use for WMTS requests, one per TileMatrix level.

Link copied to clipboard
abstract external val tileMatrixSetID: String

The identifier of the TileMatrixSet to use for WMTS requests.

Link copied to clipboard
abstract external val tileWidth: Int?

The tile width in pixels. Default value - 256

Link copied to clipboard
abstract external val tilingScheme: TilingScheme?

The tiling scheme corresponding to the organization of the tiles in the TileMatrixSet.

Link copied to clipboard
abstract external val times: TimeIntervalCollection?

TimeIntervalCollection with its data property being an object containing time dynamic dimension and their values.

Link copied to clipboard
abstract external val url: Resource

The base URL for the WMTS GetTile operation (for KVP-encoded requests) or the tile-URL template (for RESTful requests). The tile-URL template should contain the following variables: {style}, {TileMatrixSet}, {TileMatrix}, {TileRow}, {TileCol}. The first two are optional if actual values are hardcoded or not required by the server. The {s} keyword may be used to specify subdomains.