Class BingMapsProvider

Bing maps tile provider.

API Reference

https://msdn.microsoft.com/en-us/library/bb259689.aspx (Bing Maps Tile System)
https://msdn.microsoft.com/en-us/library/mt823633.aspx (Directly accessing the Bing Maps tiles)
https://www.bingmapsportal.com/

Hierarchy

MapProvider
- BingMapsProvider

Index

Constructors

constructor

new BingMapsProvider(apiKey?: string, type?: string): BingMapsProvider
Parameters
- apiKey: string = ''
  
  Bing API key.
- type: string = BingMapsProvider.AERIAL
  
  Type provider.
Returns BingMapsProvider
Overrides MapProvider.constructor
- Defined in source/providers/BingMapsProvider.ts:67

Properties

apiKey

apiKey: string

Server API access token.

bounds

bounds: number[] = []

Map bounds.

center

center: number[] = []

Map center point.

format

format: string = 'jpeg'

Map image tile format, the formats available are:

gif: Use GIF image format.
jpeg: Use JPEG image format. JPEG format is the default for Road, Aerial and AerialWithLabels imagery.
png: Use PNG image format. PNG is the default format for OrdnanceSurvey imagery.

mapSize

mapSize: number = 512

Size of the map tiles.

maxZoom

maxZoom: number = 19

Maximum zoom level allowed by the provider.

minZoom

minZoom: number = 1

Minimum zoom level allowed by the provider.

name

name: string = ''

Name of the map provider

subdomain

subdomain: string = 't1'

Tile server subdomain.

type

type: string

The type of the map used.

`Static` ADDRESS

ADDRESS: string = 'https://dev.virtualearth.net'

Base address of the bing map provider.

`Static` AERIAL

AERIAL: string = 'a'

Display an aerial view of the map.

`Static` AERIAL_LABELS

AERIAL_LABELS: string = 'h'

Display an aerial view of the map with labels.

`Static` OBLIQUE

OBLIQUE: string = 'o'

Use this value to display a bird's eye (oblique) view of the map.

`Static` OBLIQUE_LABELS

OBLIQUE_LABELS: string = 'b'

Display a bird's eye (oblique) with labels view of the map.

`Static` ROAD

ROAD: string = 'r'

Display a road view of the map.

Methods

fetchTile

fetchTile(zoom: number, x: number, y: number): Promise<any>
Get a tile for the x, y, zoom based on the provider configuration.

The tile should be returned as a image object, compatible with canvas context 2D drawImage() and with webgl texImage2D() method.

Returns
Promise with the image obtained for the tile ready to use.
Parameters
- zoom: number
  
  Zoom level.
- x: number
  
  Tile x.
- y: number
  
  Tile y.
Returns Promise<any>
Overrides MapProvider.fetchTile
- Defined in source/providers/BingMapsProvider.ts:145

getMetaData

getMetaData(): Promise<void>
Get the base URL for the map configuration requested.

Uses the follwing format

http://ecn.{subdomain}.tiles.virtualearth.net/tiles/r{quadkey}.jpeg?g=129&mkt={culture}&shading=hill&stl=H

Returns Promise<void>
Overrides MapProvider.getMetaData
- Defined in source/providers/BingMapsProvider.ts:107

`Static` quadKey

quadKey(zoom: number, x: number, y: number): string
Convert x, y, zoom quadtree to a bing maps specific quadkey.

Adapted from original C# code at https://msdn.microsoft.com/en-us/library/bb259689.aspx.
Parameters
- zoom: number
- x: number
- y: number
Returns string
- Defined in source/providers/BingMapsProvider.ts:120

Class BingMapsProvider

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

apiKey: string = ''

type: string = BingMapsProvider.AERIAL

Returns BingMapsProvider

Properties

apiKey

bounds

center

format

mapSize

maxZoom

meta

minZoom

name

subdomain

type

Static ADDRESS

Static AERIAL

Static AERIAL_LABELS

Static OBLIQUE

Static OBLIQUE_LABELS

Static ROAD

Methods

fetchTile

Returns

Parameters

zoom: number

x: number

y: number

Returns Promise<any>

getMetaData

Returns Promise<void>

Static quadKey

Parameters

zoom: number

x: number

y: number

Returns string

Settings

Member Visibility

Theme

`Static` ADDRESS

`Static` AERIAL

`Static` AERIAL_LABELS

`Static` OBLIQUE

`Static` OBLIQUE_LABELS

`Static` ROAD

`Static` quadKey