ConstructorOptions

Initialization options for the UrlTemplateImageryProvider constructor

See also

Properties

Link copied to clipboard
abstract var credit: Credit?

A credit for the data source, which is displayed on the canvas. Default value - ''

Link copied to clipboard
abstract var customTags: Any?

Allow to replace custom keywords in the URL template. The object must have strings as keys and functions as values.

Link copied to clipboard
abstract var ellipsoid: Ellipsoid?

The ellipsoid. If the tilingScheme is specified, this parameter is ignored and the tiling scheme's ellipsoid is used instead. If neither parameter is specified, the WGS84 ellipsoid is used.

Link copied to clipboard

If true, UrlTemplateImageryProvider.pickFeatures will request the pickFeaturesUrl and attempt to interpret the features included in the response. If false, UrlTemplateImageryProvider.pickFeatures will immediately return undefined (indicating no pickable features) without communicating with the server. Set this property to false if you know your data source does not support picking features or if you don't want this provider's features to be pickable. Note that this can be dynamically overridden by modifying the UriTemplateImageryProvider.enablePickFeatures property. Default value - true

Link copied to clipboard

The formats in which to get feature information at a specific location when UrlTemplateImageryProvider.pickFeatures is invoked. If this parameter is not specified, feature picking is disabled.

Link copied to clipboard
abstract var hasAlphaChannel: Boolean?

true if the images provided by this imagery provider include an alpha channel; otherwise, false. If this property is false, an alpha channel, if present, will be ignored. If this property is true, any images without an alpha channel will be treated as if their alpha is 1.0 everywhere. When this property is false, memory usage and texture upload time are potentially reduced. Default value - true

Link copied to clipboard
abstract var maximumLevel: Int?

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

Link copied to clipboard
abstract var minimumLevel: Int?

The minimum level-of-detail supported by the imagery provider. Take care when specifying this that the number of tiles at the minimum level is small, such as four or less. A larger number is likely to result in rendering problems. Default value - 0

Link copied to clipboard
abstract var pickFeaturesUrl: Resource?

The URL template to use to pick features. If this property is not specified, UrlTemplateImageryProvider.pickFeatures will immediately returned undefined, indicating no features picked. The URL template supports all of the keywords supported by the url parameter, plus the following:

Link copied to clipboard
abstract var rectangle: Rectangle?

The rectangle, in radians, covered by the image. Default value - Rectangle.MAX_VALUE

Link copied to clipboard

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

A policy for discarding tile images according to some criteria

Link copied to clipboard
abstract var tileHeight: Int?

Pixel height of image tiles. Default value - 256

Link copied to clipboard
abstract var tileWidth: Int?

Pixel width of image tiles. Default value - 256

Link copied to clipboard
abstract var tilingScheme: TilingScheme?

The tiling scheme specifying how the ellipsoidal surface is broken into tiles. If this parameter is not provided, a WebMercatorTilingScheme is used. Default value - WebMercatorTilingScheme

Link copied to clipboard
abstract var url: Resource

The URL template to use to request tiles. It has the following keywords:

Link copied to clipboard
abstract var urlSchemeZeroPadding: Any?

Gets the URL scheme zero padding for each tile coordinate. The format is '000' where each coordinate will be padded on the left with zeros to match the width of the passed string of zeros. e.g. Setting: urlSchemeZeroPadding : { '{x}' : '0000'} will cause an 'x' value of 12 to return the string '0012' for {x} in the generated URL. It the passed object has the following keywords: