ConstructorOptions

sealed interface ConstructorOptions(source)

Initialization options for the WebMapServiceImageryProvider constructor

See also

Properties

Link copied to clipboard
abstract var 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 var credit: Credit?

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

Link copied to clipboard
abstract var crs: String?

CRS specification, for use with WMS specification >= 1.3.0.

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, WebMapServiceImageryProvider.pickFeatures will invoke the GetFeatureInfo operation on the WMS server and return the features included in the response. If false, WebMapServiceImageryProvider.pickFeatures will immediately return undefined (indicating no pickable features) without communicating with the server. Set this property to false if you know your WMS server does not support GetFeatureInfo or if you don't want this provider's features to be pickable. Note that this can be dynamically overridden by modifying the WebMapServiceImageryProvider#enablePickFeatures property. Default value - true

Link copied to clipboard

The formats in which to try WMS GetFeatureInfo requests. Default value - WebMapServiceImageryProvider.DefaultGetFeatureInfoFormats

Link copied to clipboard

Additional parameters to pass to the WMS server in the GetFeatureInfo URL. Default value - WebMapServiceImageryProvider.GetFeatureInfoDefaultParameters

Link copied to clipboard

The getFeatureInfo URL of the WMS service. If the property is not defined then we use the property value of url.

Link copied to clipboard
abstract var layers: String

The layers to include, separated by commas.

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. If not specified, 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 parameters: Any?

Additional parameters to pass to the WMS server in the GetMap URL. Default value - WebMapServiceImageryProvider.DefaultParameters

Link copied to clipboard
abstract var rectangle: Rectangle?

The rectangle of the layer. Default value - Rectangle.MAX_VALUE

Link copied to clipboard
abstract var srs: String?

SRS specification, for use with WMS specification 1.1.0 or 1.1.1

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
abstract var tileHeight: Int?

The height of each tile in pixels. Default value - 256

Link copied to clipboard
abstract var tileWidth: Int?

The width of each tile in pixels. Default value - 256

Link copied to clipboard
abstract var tilingScheme: TilingScheme?

The tiling scheme to use to divide the world into tiles. Default value - GeographicTilingScheme()

Link copied to clipboard

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

Link copied to clipboard
abstract var url: Resource

The URL of the WMS service. The URL supports the same keywords as the UrlTemplateImageryProvider.