BingMapsImageryProvider

new SuperMap3D.BingMapsImageryProvider(options)

Bing Maps image service provider.
Name Type Description
options Object Objects have the following properties:
Name Type Default Description
url String Bing Maps server url。
key String optional The key used by the application can be applied for at the official website https://www.bingmapsportal.com/. If no key is provided, BingMapsApi.defaultKey will be used; if BingMapsApi.defaultKey is also undefined, a message will be written to remind you to create an application. When using Bing Maps, applications cannot be deployed without creating a separate key.
tileProtocol String optional The protocol to use when loading tiles, such as 'http:' or 'https:'. By default, loads using the same protocol as the page.
mapStyle BingMapsStyle BingMapsStyle.AERIAL optional Service type.
culture String '' optional For details, please refer to http://msdn.microsoft.com/en-us/library/hh441729.aspx.
ellipsoid Ellipsoid optional Ellipsoid. Defaults to the WGS84 ellipsoid when not defined.
tileDiscardPolicy TileDiscardPolicy optional The policy that determines whether a slice is invalid and discarded. Defaults to DiscardMissingTileImagePolicy when not specified.
proxy Proxy optional The requested proxy. This object has a getURL function that returns the proxy's URL if needed.
Example:
var bing = new SuperMap3D.BingMapsImageryProvider({
    url : 'https://dev.virtualearth.net',
    key : 'get-yours-at-https://www.bingmapsportal.com/',
    mapStyle : SuperMap3D.BingMapsStyle.AERIAL
});
See:

Members

readonlycredit : Credit

Gets description information for a service while the service is active.

readonlyculture : String

Get the language used when requesting Bing Maps service, see http://msdn.microsoft.com/en-us/library/hh441729.aspx for details.

defaultGamma : Number

Imagery layers are created using the default @link ImageryLayer#gamma. Changing the @link ImageryLayer#gamma value after creating @link ImageryLayer has no effect, you can set the @link ImageryLayer#gamma property of the image layer.
Default Value: 1.0

readonlyerrorEvent : Event

Gets the event raised when an asynchronous error occurs in the image service. Event listeners are passed an instance of TileProviderError.

readonlyhasAlphaChannel : Boolean

Gets a value indicating whether the image provided by the image provider contains an alpha channel. If this property is false, the alpha channel (if present) will be ignored. If this property is true, any image without an alpha channel is considered to have an alpha value of 1. Setting this value to false will reduce memory usage and texture loading time.

readonlykey : String

Get the service key.

readonlymapStyle : BingMapsStyle

Get the service type.

readonlymaximumLevel : Number

Gets the maximum level of detail (LOD) that can be requested. This property cannot be called before BingMapsImageryProvider#ready returns true.

readonlyminimumLevel : Number

Gets the smallest level of detail (LOD) that can be requested. This property cannot be called before BingMapsImageryProvider#ready returns true.

readonlyproxy : Proxy

Get the proxy used by the service provider.

readonlyready : Boolean

Gets a value indicating whether the service is available for use.

readonlyreadyPromise : Promise.<Boolean>

Get a promise that resolves to true when the service is ready for use.

readonlyrectangle : Rectangle

Get the image rectangle and radian parameters provided by the instance. This function is called when @link BingMapsImageryProvider#ready returns true.

readonlytileDiscardPolicy : TileDiscardPolicy

Get the tile discarding strategy. If undefined, the discard strategy filters out nonexistent tiles via the shouldDiscardImage function. If the function returns undefined, no tiles are filtered out. This function is called whenBingMapsImageryProvider#ready returns true.

readonlytileHeight : Number

Get the height of each tile in pixels. This property cannot be called before BingMapsImageryProvider#ready returns true

readonlytileWidth : Number

Get the width of each tile in pixels. This property cannot be called before BingMapsImageryProvider#ready returns true.

readonlytilingScheme : TilingScheme

Get the segmentation strategy used by the service provider. This property cannot be called before BingMapsImageryProvider#ready returns true.

readonlyurl : String

Get the url of the service.

Methods

staticSuperMap3D.BingMapsImageryProvider.quadKeyToTileXY(quadkey)

Requests an image from the Bing Maps server, converting a tile's quad key to a (x, y, level) position.
Name Type Description
quadkey String The tile's quad key.
See:

staticSuperMap3D.BingMapsImageryProvider.tileXYToQuadKey(x, y, level)

Converts the (x, y, level) position of a tile into a quad key to request images from the Bing Maps server.
Name Type Description
x Number The x coordinate of the tile.
y Number The y coordinate of the tile.
level Number The zoom level of the tile.
See:

getTileCredits(x, y, level) → Array.<Credit>

Get the subtitle information displayed by the tile.
Name Type Description
x Number The x coordinate of the tile.
y Number The y coordinate of the tile.
level Number The level of the tile.
Returns:
Subtitle information displayed by the tile.
Throws:
  • DeveloperError : getTileCredits must not be called until the image service is available.

pickFeatures(x, y, level, longitude, latitude) → Promise.<Array.<ImageryLayerFeatureInfo>>|undefined

Pick feature objects. If the imagery provider does not currently support picking, the function will return undefined. ClippingType.js
Name Type Description
x Number The x coordinate of the tile.
y Number The y coordinate of the tile.
level Number The level of the tile.
longitude Number Pick the longitude of the feature object.
latitude Number The latitude of the picked feature object.
Returns:
A promise for picking features is formed when the asynchronous picking operation completes. The value of the promise is an array of ImageryLayerFeatureInfo instances. If no feature object is found at the specified location, the array will be empty. If the pick operation is not supported, the operand may be undefined.

requestImage(x, y, level, request) → Promise.<(Image|Canvas)>|undefined

Requests an image for the specified tile.BingMapsImageryProvider#readyThis function is called when true is returned.
Name Type Description
x Number The x coordinate of the tile.
y Number The y coordinate of the tile.
level Number The level of the tile.
request Request optional request object. For internal use only.
Returns:
A promise to form the image when the image is available, or undefined (if the server receives too many requests, the request is prompted to retry later). The parsed image can be an image or a Canvas DOM object.
Throws:
  • DeveloperError : requestImage Do not call until image service is available.