SingleTileImageryProvider

new Cesium.SingleTileImageryProvider(options)
Scene/SingleTileImageryProvider.js 43

Provides a single, top-level imagery tile. The single image is assumed to use a GeographicTilingScheme.
Name Type Description
options SingleTileImageryProvider.ConstructorOptions Object describing initialization options
See:

Members

readonly credit : Credit
Scene/SingleTileImageryProvider.js 412

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

defaultAlpha : Number|undefined
Scene/SingleTileImageryProvider.js 58

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|undefined
Scene/SingleTileImageryProvider.js 85

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|undefined
Scene/SingleTileImageryProvider.js 94

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

defaultDayAlpha : Number|undefined
Scene/SingleTileImageryProvider.js 76

The default alpha blending value on the day side of the globe of this provider, with 0.0 representing fully transparent and 1.0 representing fully opaque.
Default Value: undefined

defaultGamma : Number|undefined
Scene/SingleTileImageryProvider.js 119

The default gamma correction to apply to this provider. 1.0 uses the unmodified imagery color.
Default Value: undefined

defaultHue : Number|undefined
Scene/SingleTileImageryProvider.js 102

The default hue of this provider in radians. 0.0 uses the unmodified imagery color.
Default Value: undefined

defaultMagnificationFilter : TextureMagnificationFilter
Scene/SingleTileImageryProvider.js 135

The default texture magnification filter to apply to this provider.
Default Value: undefined

defaultMinificationFilter : TextureMinificationFilter
Scene/SingleTileImageryProvider.js 127

The default texture minification filter to apply to this provider.
Default Value: undefined

defaultNightAlpha : Number|undefined
Scene/SingleTileImageryProvider.js 67

The default alpha blending value on the night side of the globe of this provider, with 0.0 representing fully transparent and 1.0 representing fully opaque.
Default Value: undefined

defaultSaturation : Number|undefined
Scene/SingleTileImageryProvider.js 111

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

readonly errorEvent : Event
Scene/SingleTileImageryProvider.js 375

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
Scene/SingleTileImageryProvider.js 428

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
Scene/SingleTileImageryProvider.js 275

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

readonly minimumLevel : Number
Scene/SingleTileImageryProvider.js 296

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

readonly proxy : Proxy
Scene/SingleTileImageryProvider.js 220

Gets the proxy used by this provider.

readonly ready : Boolean
Scene/SingleTileImageryProvider.js 387

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

readonly readyPromise : Promise.<Boolean>
Scene/SingleTileImageryProvider.js 399

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

readonly rectangle : Rectangle
Scene/SingleTileImageryProvider.js 338

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

readonly tileDiscardPolicy : TileDiscardPolicy
Scene/SingleTileImageryProvider.js 353

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

readonly tileHeight : Number
Scene/SingleTileImageryProvider.js 254

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

readonly tileWidth : Number
Scene/SingleTileImageryProvider.js 233

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

readonly tilingScheme : TilingScheme
Scene/SingleTileImageryProvider.js 317

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

readonly url : String
Scene/SingleTileImageryProvider.js 208

Gets the URL of the single, top-level imagery tile.

Methods

getTileCredits(x, y, level) → Array.<Credit>
Scene/SingleTileImageryProvider.js 445

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) → undefined
Scene/SingleTileImageryProvider.js 493

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
Scene/SingleTileImageryProvider.js 461

Requests the image for a given tile. This function should not be called before SingleTileImageryProvider#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:
The resolved image
Throws:
  • DeveloperError : requestImage must not be called before the imagery provider is ready.

Type Definitions

Cesium.SingleTileImageryProvider.ConstructorOptions
Scene/SingleTileImageryProvider.js 14

Initialization options for the SingleTileImageryProvider constructor
Properties:
Name Type Attributes Default Description
url Resource | String The url for the tile.
rectangle Rectangle <optional>
 Rectangle.MAX_VALUE The rectangle, in radians, covered by the image.
credit Credit | String <optional>
 A credit for the data source, which is displayed on the canvas.
ellipsoid Ellipsoid <optional>
 The ellipsoid. If not specified, the WGS84 ellipsoid is used.
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.