kotlin-cesium-engine/cesium.engine/WebMapServiceImageryProvider

WebMapServiceImageryProvider

external class WebMapServiceImageryProvider(options: WebMapServiceImageryProvider.ConstructorOptions)(source)

Provides tiled imagery hosted by a Web Map Service (WMS) server.

const provider = new WebMapServiceImageryProvider({
    url : 'https://sampleserver1.arcgisonline.com/ArcGIS/services/Specialty/ESRI_StatesCitiesRivers_USA/MapServer/WMSServer',
    layers : '0',
    proxy: new DefaultProxy('/proxy/')
});
const imageryLayer = new ImageryLayer(provider);
viewer.imageryLayers.add(imageryLayer);

Constructors

constructor(options: WebMapServiceImageryProvider.ConstructorOptions)

Types

Companion

object Companion

ConstructorOptions

interface ConstructorOptions

Initialization options for the WebMapServiceImageryProvider constructor

Properties

clock

var clock: Clock

Gets or sets a clock that is used to get keep the time used for time dynamic parameters.

credit

val credit: Credit

Gets the credit to display when this imagery provider is active. Typically this is used to credit the source of the imagery.

enablePickFeatures

var enablePickFeatures: Boolean

Gets or sets a value indicating whether feature picking is enabled. If true, WebMapServiceImageryProvider.pickFeatures will invoke the GetFeatureInfo service on the WMS server and attempt to interpret 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 data source does not support picking features or if you don't want this provider's features to be pickable.

errorEvent

val errorEvent: DefaultEvent

Gets an event that is raised when the imagery provider encounters an asynchronous error. By subscribing to the event, you will be notified of the error and can potentially recover from it. Event listeners are passed an instance of TileProviderError.

getFeatureInfoUrl

val getFeatureInfoUrl: Resource

Gets the getFeatureInfo URL of the WMS server.

hasAlphaChannel

val hasAlphaChannel: Boolean

Gets a value indicating whether or not the images provided by this imagery provider include an alpha channel. 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 reduced.

layers

val layers: String

Gets the names of the WMS layers, separated by commas.

maximumLevel

val maximumLevel: Int?

Gets the maximum level-of-detail that can be requested.

minimumLevel

val minimumLevel: Int

Gets the minimum level-of-detail that can be requested.

proxy

val proxy: Proxy

Gets the proxy used by this provider.

rectangle

val rectangle: Rectangle

Gets the rectangle, in radians, of the imagery provided by this instance.

tileDiscardPolicy

val tileDiscardPolicy: TileDiscardPolicy

Gets the tile discard policy. If not undefined, the discard policy is responsible for filtering out "missing" tiles via its shouldDiscardImage function. If this function returns undefined, no tiles are filtered.

tileHeight

val tileHeight: Int

Gets the height of each tile, in pixels.

tileWidth

val tileWidth: Int

Gets the width of each tile, in pixels.

tilingScheme

val tilingScheme: TilingScheme

Gets the tiling scheme used by this provider.

times

var times: TimeIntervalCollection

Gets or sets a time interval collection that is used to get time dynamic parameters. The data of each TimeInterval is an object containing the keys and values of the properties that are used during tile requests.

url

val url: String

Gets the URL of the WMS server.

Functions

getTileCredits

fun getTileCredits(x: Double, y: Double, level: Int): ReadonlyArray<Credit>

Gets the credits to be displayed when a given tile is displayed.

pickFeatures

suspend fun pickFeatures(x: Double, y: Double, level: Int, longitude: Double, latitude: Double): ReadonlyArray<ImageryLayerFeatureInfo>?

Asynchronously determines what features, if any, are located at a given longitude and latitude within a tile.

pickFeaturesAsync

fun pickFeaturesAsync(x: Double, y: Double, level: Int, longitude: Double, latitude: Double): Promise<ReadonlyArray<ImageryLayerFeatureInfo>>?

requestImage

suspend fun requestImage(x: Double, y: Double, level: Int, request: Request? = definedExternally): ImageryTypes?

Requests the image for a given tile.

requestImageAsync

fun requestImageAsync(x: Double, y: Double, level: Int, request: Request? = definedExternally): Promise<ImageryTypes>?

WebMapServiceImageryProvider

See also

Constructors

Types

Properties

Functions