kotlin-cesium-engine/cesium.engine/WebMapTileServiceImageryProvider

WebMapTileServiceImageryProvider

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

Provides tiled imagery served by WMTS 1.0.0 compliant servers. This provider supports HTTP KVP-encoded and RESTful GetTile requests, but does not yet support the SOAP encoding.

// Example 1. USGS shaded relief tiles (KVP)
const shadedRelief1 = new WebMapTileServiceImageryProvider({
    url : 'http://basemap.nationalmap.gov/arcgis/rest/services/USGSShadedReliefOnly/MapServer/WMTS',
    layer : 'USGSShadedReliefOnly',
    style : 'default',
    format : 'image/jpeg',
    tileMatrixSetID : 'default028mm',
    // tileMatrixLabels : ['default028mm:0', 'default028mm:1', 'default028mm:2' ...],
    maximumLevel: 19,
    credit : new Credit('U. S. Geological Survey')
});
viewer.imageryLayers.addImageryProvider(shadedRelief1);

// Example 2. USGS shaded relief tiles (RESTful)
const shadedRelief2 = new WebMapTileServiceImageryProvider({
    url : 'http://basemap.nationalmap.gov/arcgis/rest/services/USGSShadedReliefOnly/MapServer/WMTS/tile/1.0.0/USGSShadedReliefOnly/{Style}/{TileMatrixSet}/{TileMatrix}/{TileRow}/{TileCol}.jpg',
    layer : 'USGSShadedReliefOnly',
    style : 'default',
    format : 'image/jpeg',
    tileMatrixSetID : 'default028mm',
    maximumLevel: 19,
    credit : new Credit('U. S. Geological Survey')
});
viewer.imageryLayers.addImageryProvider(shadedRelief2);

// Example 3. NASA time dynamic weather data (RESTful)
const times = TimeIntervalCollection.fromIso8601({
    iso8601: '2015-07-30/2017-06-16/P1D',
    dataCallback: function dataCallback(interval, index) {
        return {
            Time: JulianDate.toIso8601(interval.start)
        };
    }
});
const weather = new WebMapTileServiceImageryProvider({
    url : 'https://gibs.earthdata.nasa.gov/wmts/epsg4326/best/AMSR2_Snow_Water_Equivalent/default/{Time}/{TileMatrixSet}/{TileMatrix}/{TileRow}/{TileCol}.png',
    layer : 'AMSR2_Snow_Water_Equivalent',
    style : 'default',
    tileMatrixSetID : '2km',
    maximumLevel : 5,
    format : 'image/png',
    clock: clock,
    times: times,
    credit : new Credit('NASA Global Imagery Browse Services for EOSDIS')
});
viewer.imageryLayers.addImageryProvider(weather);

Constructors

WebMapTileServiceImageryProvider

constructor(options: WebMapTileServiceImageryProvider.ConstructorOptions)

Types

ConstructorOptions

sealed interface ConstructorOptions

Initialization options for the WebMapTileServiceImageryProvider 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.

dimensions

var dimensions: Any

Gets or sets an object that contains static dimensions and their values.

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.

format

val format: String

Gets the mime type of images returned by this imagery provider.

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.

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 service hosting the imagery.

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

fun pickFeatures(x: Double, y: Double, level: Int, longitude: Double, latitude: Double): Void

Picking features is not currently supported by this imagery provider, so this function simply returns undefined.

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

WebMapTileServiceImageryProvider

See also

Constructors

Types

Properties

Functions