kotlin-cesium-engine/cesium.engine/BingMapsImageryProvider

BingMapsImageryProvider

external class BingMapsImageryProvider(source)

To construct a BingMapsImageryProvider, call [BingMapsImageryProvider.fromUrl]. Do not call the constructor directly.

Provides tiled imagery using the Bing Maps Imagery REST API.

const bing = await BingMapsImageryProvider.fromUrl(
  "https://dev.virtualearth.net", {
    key: "get-yours-at-https://www.bingmapsportal.com/",
    mapStyle: BingMapsStyle.AERIAL
});

Types

Companion

object Companion

ConstructorOptions

sealed interface ConstructorOptions

Initialization options for the BingMapsImageryProvider constructor

Properties

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.

culture

val culture: String

The culture to use when requesting Bing Maps imagery. Not all cultures are supported. See [http://msdn.microsoft.com/en-us/library/hh441729.aspx] for information on the supported cultures.

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.

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. Setting this property to false reduces memory usage and texture upload time.

key

val key: String

Gets the Bing Maps key.

mapLayer

val mapLayer: String

Gets the additional map layer options as defined in [https://learn.microsoft.com/en-us/bingmaps/rest-services/imagery/get-imagery-metadata#template-parameters]/

mapStyle

val mapStyle: BingMapsStyle

Gets the type of Bing Maps imagery to load.

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.

url

val url: String

Gets the name of the BingMaps server url 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>?

BingMapsImageryProvider

See also

Types

Properties

Functions