SingleTileImageryProvider

Provides a single, top-level imagery tile. The single image is assumed to be in the Geographic projection (i.e. WGS84 / EPSG:4326), and will be rendered using a GeographicTilingScheme.

See also

Constructors

Link copied to clipboard

Types

Link copied to clipboard
external object Companion
Link copied to clipboard
external interface ConstructorOptions

Initialization options for the SingleTileImageryProvider constructor

Properties

Link copied to clipboard
open external override 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
open external override 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
open external override 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
open external override val maximumLevel: Int?

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

Link copied to clipboard
open external override val minimumLevel: Int

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

Link copied to clipboard
open external override val proxy: Proxy

Gets the proxy used by this provider.

Link copied to clipboard
open external override val rectangle: Rectangle

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

Link copied to clipboard
open external override 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.

Link copied to clipboard
open external override val tileHeight: Int

Gets the height of each tile, in pixels.

Link copied to clipboard
open external override val tileWidth: Int

Gets the width of each tile, in pixels.

Link copied to clipboard
open external override val tilingScheme: TilingScheme

Gets the tiling scheme used by this provider.

Link copied to clipboard
external val url: String

Gets the URL of the single, top-level imagery tile.

Functions

Link copied to clipboard
open external override 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 external 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
open external override fun pickFeaturesAsync(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.

Link copied to clipboard
suspend external fun requestImage(x: Double, y: Double, level: Int, request: Request? = definedExternally): ImageryTypes?

Requests the image for a given tile.

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

Requests the image for a given tile.