IonImageryProvider

Members

readonlycredit : Credit

Scene/IonImageryProvider.js 394

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 IonImageryProvider#ready returns true.

defaultAlpha : Number

Scene/IonImageryProvider.js 101

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

Default Value: undefined

defaultBrightness : Number

Scene/IonImageryProvider.js 110

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

defaultContrast : Number

Scene/IonImageryProvider.js 119

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

defaultGamma : Number

Scene/IonImageryProvider.js 144

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

Default Value: undefined

defaultHue : Number

Scene/IonImageryProvider.js 127

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

Default Value: undefined

defaultMagnificationFilter : TextureMagnificationFilter

Scene/IonImageryProvider.js 160

The default texture magnification filter to apply to this provider.

Default Value: undefined

defaultMinificationFilter : TextureMinificationFilter

Scene/IonImageryProvider.js 152

The default texture minification filter to apply to this provider.

Default Value: undefined

defaultSaturation : Number

Scene/IonImageryProvider.js 136

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

readonlyerrorEvent : Event

Scene/IonImageryProvider.js 380

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.

readonlyhasAlphaChannel : Boolean

Scene/IonImageryProvider.js 415

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.

readonlymaximumLevel : Number

Scene/IonImageryProvider.js 301

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

readonlyminimumLevel : Number

Scene/IonImageryProvider.js 323

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

readonlyready : Boolean

Scene/IonImageryProvider.js 222

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

readonlyreadyPromise : Promise.<Boolean>

Scene/IonImageryProvider.js 234

Gets a promise that resolves to true when the provider is ready for use.

readonlyrectangle : Rectangle

Scene/IonImageryProvider.js 247

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

readonlytileDiscardPolicy : TileDiscardPolicy

Scene/IonImageryProvider.js 361

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 IonImageryProvider#ready returns true.

readonlytileHeight : Number

Scene/IonImageryProvider.js 283

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

readonlytileWidth : Number

Scene/IonImageryProvider.js 265

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

readonlytilingScheme : TilingScheme

Scene/IonImageryProvider.js 341

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

Methods

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

Scene/IonImageryProvider.js 438

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.

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

Scene/IonImageryProvider.js 497

Asynchronously determines what features, if any, are located at a given longitude and latitude within a tile. This function should not be called before IonImageryProvider#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.

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

Scene/IonImageryProvider.js 469

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

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