BingMapsImageryProvider

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
});

See also

Types

Link copied to clipboard
object Companion
Link copied to clipboard

Initialization options for the BingMapsImageryProvider constructor

Properties

Link copied to clipboard

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

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.

Link copied to clipboard

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

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.

Link copied to clipboard
val key: String

Gets the Bing Maps key.

Link copied to clipboard

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

Link copied to clipboard

Gets the type of Bing Maps imagery to load.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Gets the proxy used by this provider.

Link copied to clipboard

Gets the rectangle, in radians, of the imagery provided by this 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

Gets the height of each tile, in pixels.

Link copied to clipboard

Gets the width of each tile, in pixels.

Link copied to clipboard

Gets the tiling scheme used by this provider.

Link copied to clipboard
val url: String

Gets the name of the BingMaps server url hosting the imagery.

Functions

Link copied to clipboard

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

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

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
fun requestImageAsync(x: Double, y: Double, level: Int, request: Request? = definedExternally): Promise<ImageryTypes>?