Azure2DImageryProvider

new Cesium.Azure2DImageryProvider(options)
engine/Source/Scene/Azure2DImageryProvider.js 42

Provides 2D image tiles from Azure.
Name Type Description
options Azure2DImageryProvider.ConstructorOptions Object describing initialization options
Example:
// Azure 2D imagery provider
const azureImageryProvider = new Cesium.Azure2DImageryProvider({
    subscriptionKey: "subscription-key",
    tilesetId: "microsoft.base.road"
});

Members

readonly credit : Credit
engine/Source/Scene/Azure2DImageryProvider.js 229

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

readonly errorEvent : Event
engine/Source/Scene/Azure2DImageryProvider.js 216

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.

readonly hasAlphaChannel : boolean
engine/Source/Scene/Azure2DImageryProvider.js 257

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. When this property is false, memory usage and texture upload time are reduced.

readonly maximumLevel : number|undefined
engine/Source/Scene/Azure2DImageryProvider.js 160

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

readonly minimumLevel : number
engine/Source/Scene/Azure2DImageryProvider.js 176

Gets the minimum level-of-detail that can be requested. Generally, a minimum level should only be used when the rectangle of the imagery is small enough that the number of tiles at the minimum level is small. An imagery provider with more than a few tiles at the minimum level will lead to rendering problems.

readonly proxy : Proxy
engine/Source/Scene/Azure2DImageryProvider.js 241

Gets the proxy used by this provider.

readonly rectangle : Rectangle
engine/Source/Scene/Azure2DImageryProvider.js 124

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

readonly tileDiscardPolicy : TileDiscardPolicy
engine/Source/Scene/Azure2DImageryProvider.js 202

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.

readonly tileHeight : number
engine/Source/Scene/Azure2DImageryProvider.js 148

Gets the height of each tile, in pixels.

readonly tileWidth : number
engine/Source/Scene/Azure2DImageryProvider.js 136

Gets the width of each tile, in pixels.

readonly tilingScheme : TilingScheme
engine/Source/Scene/Azure2DImageryProvider.js 188

Gets the tiling scheme used by the provider.

readonly url : string
engine/Source/Scene/Azure2DImageryProvider.js 112

Gets the URL of the Azure 2D Imagery server.

Methods

getTileCredits(x, y, level) → Array.<Credit>|undefined
engine/Source/Scene/Azure2DImageryProvider.js 272

Gets the credits to be displayed when a given tile is displayed.
Name Type Description
x number The tile X coordinate.
y number The tile Y coordinate.
level number The tile level;
Returns:
The credits to be displayed when the tile is displayed.

pickFeatures(x, y, level, longitude, latitude) → undefined
engine/Source/Scene/Azure2DImageryProvider.js 331

Picking features is not currently supported by this imagery provider, so this function simply returns undefined.
Name Type Description
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.
Returns:
Undefined since picking is not supported.

requestImage(x, y, level, request) → Promise.<ImageryTypes>|undefined
engine/Source/Scene/Azure2DImageryProvider.js 297

Requests the image for a given tile.
Name Type Description
x number The tile X coordinate.
y number The tile Y coordinate.
level number The tile level.
request Request optional The request object. Intended for internal use only.
Returns:
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.

Type Definitions

Cesium.Azure2DImageryProvider.ConstructorOptions
engine/Source/Scene/Azure2DImageryProvider.js 11

Initialization options for the Azure2DImageryProvider constructor
Properties:
Name Type Description
options object Object with the following properties:
Properties
Name Type Attributes Default Description
url string <optional>
 "https://atlas.microsoft.com/" The Azure server url.
tilesetId string "microsoft.imagery" The Azure tileset ID. Valid options are microsoft.imagery, microsoft.base.road, and microsoft.base.labels.road
subscriptionKey string The public subscription key for the imagery.
ellipsoid Ellipsoid <optional>
 Ellipsoid.default The ellipsoid. If not specified, the default ellipsoid is used.
minimumLevel number <optional>
 0 The minimum level-of-detail supported by the imagery provider. Take care when specifying this that the number of tiles at the minimum level is small, such as four or less. A larger number is likely to result in rendering problems.
maximumLevel number <optional>
 22 The maximum level-of-detail supported by the imagery provider.
rectangle Rectangle <optional>
 Rectangle.MAX_VALUE The rectangle, in radians, covered by the image.
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.
CtrlK
packages/engine
packages/widgets