ImageryProvider

abstract external class ImageryProvider(source)

Provides imagery to be displayed on the surface of an ellipsoid. This type describes an interface and is not intended to be instantiated directly.

See also

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
abstract 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.

Link copied to clipboard
abstract 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.

Link copied to clipboard
abstract 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.

Link copied to clipboard
abstract val maximumLevel: Int?

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

Link copied to clipboard
abstract val minimumLevel: Int

Gets the minimum level-of-detail that can be requested. Generally, a minimum level should only be used when the rectangle of the imagery is small enough that the number of tiles at the minimum level is small. An imagery provider with more than a few tiles at the minimum level will lead to rendering problems.

Link copied to clipboard
abstract val proxy: Proxy

Gets the proxy used by this provider.

Link copied to clipboard
abstract val rectangle: Rectangle

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

Link copied to clipboard

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.

Link copied to clipboard
abstract val tileHeight: Int

Gets the height of each tile, in pixels.

Link copied to clipboard
abstract val tileWidth: Int

Gets the width of each tile, in pixels.

Link copied to clipboard

Gets the tiling scheme used by the provider.

Functions

Link copied to clipboard
abstract fun getTileCredits(x: Double, y: Double, level: Int): ReadonlyArray<Credit>

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

Link copied to clipboard
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. This function is optional, so it may not exist on all ImageryProviders.

Link copied to clipboard
abstract fun pickFeaturesAsync(x: Double, y: Double, level: Int, longitude: Double, latitude: Double): Promise<ReadonlyArray<ImageryLayerFeatureInfo>>?
Link copied to clipboard
suspend fun requestImage(x: Double, y: Double, level: Int, request: Request? = definedExternally): ImageryTypes?

Requests the image for a given tile.

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