ImageryProvider

Members

readonlycredit :Credit

Gets the credit to display when this imagery provider is active. Typically this is used to credit the source of the imagery. This function should not be called before ImageryProvider#ready returns true.

Source: Scene/ImageryProvider.js, line 206

defaultAlpha :Number

The default alpha blending value of this provider, with 0.0 representing fully transparent and 1.0 representing fully opaque.

Default Value: undefined

Source: Scene/ImageryProvider.js, line 44

defaultBrightness :Number

The default brightness of this provider. 1.0 uses the unmodified imagery color. Less than 1.0 makes the imagery darker while greater than 1.0 makes it brighter.

Default Value: undefined

Source: Scene/ImageryProvider.js, line 53

defaultContrast :Number

The default contrast of this provider. 1.0 uses the unmodified imagery color. Less than 1.0 reduces the contrast while greater than 1.0 increases it.

Default Value: undefined

Source: Scene/ImageryProvider.js, line 62

defaultGamma :Number

The default gamma correction to apply to this provider. 1.0 uses the unmodified imagery color.

Default Value: undefined

Source: Scene/ImageryProvider.js, line 87

defaultHue :Number

The default hue of this provider in radians. 0.0 uses the unmodified imagery color.

Default Value: undefined

Source: Scene/ImageryProvider.js, line 70

defaultSaturation :Number

The default saturation of this provider. 1.0 uses the unmodified imagery color. Less than 1.0 reduces the saturation while greater than 1.0 increases it.

Default Value: undefined

Source: Scene/ImageryProvider.js, line 79

readonlyerrorEvent :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.

Source: Scene/ImageryProvider.js, line 194

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

Source: Scene/ImageryProvider.js, line 230

readonlymaximumLevel :Number

Gets the maximum level-of-detail that can be requested. This function should not be called before ImageryProvider#ready returns true.

Source: Scene/ImageryProvider.js, line 143

readonlyminimumLevel :Number

Gets the minimum level-of-detail that can be requested. This function should not be called before ImageryProvider#ready returns true. 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.

Source: Scene/ImageryProvider.js, line 158

readonlyproxy :Proxy

Gets the proxy used by this provider.

Source: Scene/ImageryProvider.js, line 216

readonlyready :Boolean

Gets a value indicating whether or not the provider is ready for use.

Source: Scene/ImageryProvider.js, line 99

readonlyrectangle :Rectangle

Gets the rectangle, in radians, of the imagery provided by the instance. This function should not be called before ImageryProvider#ready returns true.

Source: Scene/ImageryProvider.js, line 110

readonlytileDiscardPolicy :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. This function should not be called before ImageryProvider#ready returns true.

Source: Scene/ImageryProvider.js, line 182

readonlytileHeight :Number

Gets the height of each tile, in pixels. This function should not be called before ImageryProvider#ready returns true.

Source: Scene/ImageryProvider.js, line 132

readonlytileWidth :Number

Gets the width of each tile, in pixels. This function should not be called before ImageryProvider#ready returns true.

Source: Scene/ImageryProvider.js, line 121

readonlytilingScheme :TilingScheme

Gets the tiling scheme used by the provider. This function should not be called before ImageryProvider#ready returns true.

Source: Scene/ImageryProvider.js, line 169

Methods

staticImageryProvider.loadImage(url) → Promise

Loads an image from a given URL. If the server referenced by the URL already has too many requests pending, this function will instead return undefined, indicating that the request should be retried later.

Name	Type	Description
url	String	The URL of the image.

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. The resolved image may be either an Image or a Canvas DOM object.

Source: Scene/ImageryProvider.js, line 297

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

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.

Throws:

• DeveloperError : getTileCredits must not be called before the imagery provider is ready.

Source: Scene/ImageryProvider.js, line 246

pickFeatures(x, y, level, longitude, latitude) → Promise

Asynchronously determines what features, if any, are located at a given longitude and latitude within a tile. This function should not be called before ImageryProvider#ready returns true. This function is optional, so it may not exist on all ImageryProviders.

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:

A promise for the picked features that will resolve when the asynchronous picking completes. The resolved value is an array of ImageryLayerFeatureInfo instances. The array may be empty if no features are found at the given location. It may also be undefined if picking is not supported.

Throws:

• DeveloperError : pickFeatures must not be called before the imagery provider is ready.

Source: Scene/ImageryProvider.js, line 284

requestImage(x, y, level) → Promise

Requests the image for a given tile. This function should not be called before ImageryProvider#ready returns true.

Name	Type	Description
x	Number	The tile X coordinate.
y	Number	The tile Y coordinate.
level	Number	The tile level.

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. The resolved image may be either an Image or a Canvas DOM object.

Throws:

• DeveloperError : requestImage must not be called before the imagery provider is ready.

Source: Scene/ImageryProvider.js, line 263