GoogleEarthImageryProvider

new GoogleEarthImageryProvider

Provides tiled imagery using the Google Earth Imagery API. Notes: This imagery provider does not work with the public Google Earth servers. It works with the Google Earth Enterprise Server. By default the Google Earth Enterprise server does not set the Cross-Origin Resource Sharing headers. You can either use a proxy server which adds these headers, or in the /opt/google/gehttpd/conf/gehttpd.conf and add the 'Header set Access-Control-Allow-Origin "*"' option to the '<Directory />' and '<Directory "/opt/google/gehttpd/htdocs">' directives.

Parameters:

Name	Type	Argument	Default	Description
`description.url`	String			The url of the Google Earth server hosting the imagery.
`description.channel`	Number			The channel (id) to be used when requesting data from the server. The channel number can be found by looking at the json file located at: earth.localdomain/default_map/query?request=Json&vars=geeServerDefs The /default_map path may differ depending on your Google Earth Enterprise server configuration. Look for the "id" that is associated with a "ImageryMaps" requestType. There may be more than one id available. Example: { layers: [ { id: 1002, requestType: "ImageryMaps" }, { id: 1007, requestType: "VectorMapsRaster" } ] }
`description.path`	String	<optional>	"/default_map"	The path of the Google Earth server hosting the imagery.
`description.maximumLevel`	Number	<optional>	23	The maximum level-of-detail supported by the Google Earth Enterprise server.
`description.tileDiscardPolicy`	TileDiscardPolicy	<optional>		The policy that determines if a tile is invalid and should be discarded. To ensure that no tiles are discarded, construct and pass a NeverTileDiscardPolicy for this parameter.
`description.proxy`	Proxy	<optional>		A proxy to use for requests. This object is expected to have a getURL function which returns the proxied URL, if needed.

Throws:

RuntimeError : Could not find layer with channel (id) of description.channel.
RuntimeError : Could not find a version in channel (id) description.channel.
RuntimeError : Unsupported projection data.projection.

Example

var google = new Cesium.GoogleEarthImageryProvider({
    url : '//earth.localdomain',
    channel : 1008
});

See:

Source:

eEarthImageryProvider.js

Members

channel :Number

Gets the imagery channel (id) currently being used.

credit :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 GoogleEarthImageryProvider#ready returns true.

defaultGamma :Number

The default ImageryLayer#gamma to use for imagery layers created for this provider. By default, this is set to 1.9. Changing this value after creating an ImageryLayer for this provider will have no effect. Instead, set the layer's ImageryLayer#gamma property.

Default Value:

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

maximumLevel :Number

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

minimumLevel :Number

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

path :String

Gets the url path of the data on the Google Earth server.

proxy :Proxy

Gets the proxy used by this provider.

ready :Boolean

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

rectangle :Rectangle

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

requestType :String

Gets the type of data that is being requested from the provider. This function should not be called before GoogleEarthImageryProvider#ready returns true.

tileDiscardPolicy :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 GoogleEarthImageryProvider#ready returns true.

tileHeight :Number

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

tileWidth :Number

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

tilingScheme :TilingScheme

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

url :String

Gets the URL of the Google Earth MapServer.

version :Number

Gets the version of the data used by this provider. This function should not be called before GoogleEarthImageryProvider#ready returns true.

Methods

getTileCredits

Gets the credits to be displayed when a given tile is displayed.

Parameters:

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

Throws:

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

Returns:

Credit[] The credits to be displayed when the tile is displayed.

requestImage

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

Parameters:

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

Throws:

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

Returns:

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