KBE3D / KBCore / Cesium / BingMapsImageryProvider

类: BingMapsImageryProvider

<div class="notice"> To construct a BingMapsImageryProvider, call BingMapsImageryProvider.fromUrl. Do not call the constructor directly. </div>

Provides tiled imagery using the Bing Maps Imagery REST API.

示例

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

参数

Object describing initialization options

属性

logoUrl

static logoUrl: string

Gets or sets the URL to the Bing logo for display in the credit.

---

url

readonly url: string

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

---

proxy

readonly proxy: Proxy

Gets the proxy used by this provider.

---

key

readonly key: string

Gets the Bing Maps key.

---

mapStyle

readonly mapStyle: BingMapsStyle

Gets the type of Bing Maps imagery to load.

---

mapLayer

readonly 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

/

---

culture

readonly 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.

---

tileWidth

readonly tileWidth: number

Gets the width of each tile, in pixels.

---

tileHeight

readonly tileHeight: number

Gets the height of each tile, in pixels.

---

maximumLevel

readonly maximumLevel: number | undefined

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

---

minimumLevel

readonly minimumLevel: number

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

---

tilingScheme

readonly tilingScheme: TilingScheme

Gets the tiling scheme used by this provider.

---

rectangle

readonly rectangle: Rectangle

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

---

tileDiscardPolicy

readonly 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.

---

errorEvent

readonly errorEvent: Event

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.

---

credit

readonly credit: Credit

Gets the credit to display when this imagery provider is active. Typically this is used to credit the source of the imagery.

---

hasAlphaChannel

readonly 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.

方法

fromUrl()

static fromUrl(url: string | Resource, options: ConstructorOptions): Promise<BingMapsImageryProvider>

Creates an ImageryProvider which provides tiled imagery using the Bing Maps Imagery REST API.

参数

url

The url of the Bing Maps server hosting the imagery.

string | Resource

options

ConstructorOptions

Object describing initialization options

返回

Promise<BingMapsImageryProvider>

A promise that resolves to the created BingMapsImageryProvider

示例

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

---

tileXYToQuadKey()

static tileXYToQuadKey(x: number, y: number, level: number): void

Converts a tiles (x, y, level) position into a quadkey used to request an image from a Bing Maps server.

参数

x

number

The tile's x coordinate.

y

number

The tile's y coordinate.

level

number

The tile's zoom level.

返回

void

---

quadKeyToTileXY()

static quadKeyToTileXY(quadkey: string): void

Converts a tile's quadkey used to request an image from a Bing Maps server into the (x, y, level) position.

参数

quadkey

string

The tile's quad key

返回

void

---

getTileCredits()

getTileCredits(x: number, y: number, level: number): Credit[]

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

参数

x

number

The tile X coordinate.

y

number

The tile Y coordinate.

level

number

The tile level;

返回

Credit[]

The credits to be displayed when the tile is displayed.

---

requestImage()

requestImage(x: number, y: number, level: number, request?: Request): Promise<ImageryTypes> | undefined

Requests the image for a given tile.

参数

x

number

The tile X coordinate.

y

number

The tile Y coordinate.

level

number

The tile level.

request?

Request

The request object. Intended for internal use only.

返回

Promise<ImageryTypes> | undefined

A promise for the image that will resolve when the image is available, or undefined if there are too many active requests to the server, and the request should be retried later.

---

pickFeatures()

pickFeatures(x: number, y: number, level: number, longitude: number, latitude: number): undefined

Picking features is not currently supported by this imagery provider, so this function simply returns undefined.

参数

x

number

The tile X coordinate.

y

number

The tile Y coordinate.

level

number

The tile level.

longitude

number

The longitude at which to pick features.

latitude

number

The latitude at which to pick features.

返回

undefined

Undefined since picking is not supported.

构造函数

构造函数

new BingMapsImageryProvider(options: ConstructorOptions): BingMapsImageryProvider

参数

options

ConstructorOptions

返回

BingMapsImageryProvider