GoogleEarthEnterpriseImageryProvider

new Cesium.GoogleEarthEnterpriseImageryProvider(options)
Scene/GoogleEarthEnterpriseImageryProvider.js 89

Provides tiled imagery using the Google Earth Enterprise REST API. Notes: This provider is for use with the 3D Earth API of Google Earth Enterprise, GoogleEarthEnterpriseMapsProvider should be used with 2D Maps API.
Name Type Description
options GoogleEarthEnterpriseImageryProvider.ConstructorOptions Object describing initialization options
Example:
const geeMetadata = new GoogleEarthEnterpriseMetadata('http://www.example.com');
const gee = new Cesium.GoogleEarthEnterpriseImageryProvider({
    metadata : geeMetadata
});
See:

Members

readonly credit : Credit
Scene/GoogleEarthEnterpriseImageryProvider.js 483

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

defaultAlpha : Number|undefined
Scene/GoogleEarthEnterpriseImageryProvider.js 105

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/GoogleEarthEnterpriseImageryProvider.js 132

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/GoogleEarthEnterpriseImageryProvider.js 141

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/GoogleEarthEnterpriseImageryProvider.js 123

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/GoogleEarthEnterpriseImageryProvider.js 166

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

defaultHue : Number|undefined
Scene/GoogleEarthEnterpriseImageryProvider.js 149

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

defaultMagnificationFilter : TextureMagnificationFilter
Scene/GoogleEarthEnterpriseImageryProvider.js 182

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

defaultMinificationFilter : TextureMinificationFilter
Scene/GoogleEarthEnterpriseImageryProvider.js 174

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

defaultNightAlpha : Number|undefined
Scene/GoogleEarthEnterpriseImageryProvider.js 114

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/GoogleEarthEnterpriseImageryProvider.js 158

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/GoogleEarthEnterpriseImageryProvider.js 446

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/GoogleEarthEnterpriseImageryProvider.js 499

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.

readonly maximumLevel : Number|undefined
Scene/GoogleEarthEnterpriseImageryProvider.js 338

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

readonly minimumLevel : Number
Scene/GoogleEarthEnterpriseImageryProvider.js 359

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

readonly proxy : Proxy
Scene/GoogleEarthEnterpriseImageryProvider.js 283

Gets the proxy used by this provider.

readonly ready : Boolean
Scene/GoogleEarthEnterpriseImageryProvider.js 458

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

readonly readyPromise : Promise.<Boolean>
Scene/GoogleEarthEnterpriseImageryProvider.js 470

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

readonly rectangle : Rectangle
Scene/GoogleEarthEnterpriseImageryProvider.js 401

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

readonly tileDiscardPolicy : TileDiscardPolicy
Scene/GoogleEarthEnterpriseImageryProvider.js 424

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

readonly tileHeight : Number
Scene/GoogleEarthEnterpriseImageryProvider.js 317

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

readonly tileWidth : Number
Scene/GoogleEarthEnterpriseImageryProvider.js 296

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

readonly tilingScheme : TilingScheme
Scene/GoogleEarthEnterpriseImageryProvider.js 380

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

readonly url : String
Scene/GoogleEarthEnterpriseImageryProvider.js 271

Gets the name of the Google Earth Enterprise server url hosting the imagery.

Methods

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

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/GoogleEarthEnterpriseImageryProvider.js 641

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/GoogleEarthEnterpriseImageryProvider.js 554

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

Type Definitions

Cesium.GoogleEarthEnterpriseImageryProvider.ConstructorOptions
Scene/GoogleEarthEnterpriseImageryProvider.js 45

Initialization options for the GoogleEarthEnterpriseImageryProvider constructor
Properties:
Name Type Attributes Description
url Resource | String The url of the Google Earth Enterprise server hosting the imagery.
metadata GoogleEarthEnterpriseMetadata A metadata object that can be used to share metadata requests with a GoogleEarthEnterpriseTerrainProvider.
ellipsoid Ellipsoid <optional>
 The ellipsoid. If not specified, the WGS84 ellipsoid is used.
tileDiscardPolicy TileDiscardPolicy <optional>
 The policy that determines if a tile is invalid and should be discarded. If this value is not specified, a default is to discard tiles that fail to download.
credit Credit | String <optional>
 A credit for the data source, which is displayed on the canvas.
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.