Class: GoogleEarthImageryProvider

GoogleEarthImageryProvider

new GoogleEarthImageryProvider(options)

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 Description
options Object Object with the following properties:
Properties
Name Type Attributes Default Description
url String The url of the Google Earth server hosting the imagery.
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" } ] }
path String <optional>
 "/default_map" The path of the Google Earth server hosting the imagery.
maximumLevel Number <optional>
 The maximum level-of-detail supported by the Google Earth Enterprise server, or undefined if there is no limit.
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.
ellipsoid Ellipsoid <optional>
 The ellipsoid. If not specified, the WGS84 ellipsoid is used.
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.
Source:
See:
Throws:
  • Could not find layer with channel (id) of options.channel.
    Type
    RuntimeError
  • Could not find a version in channel (id) options.channel.
    Type
    RuntimeError
  • Unsupported projection data.projection.
    Type
    RuntimeError
Example
var google = new Cesium.GoogleEarthImageryProvider({
    url : 'https://earth.localdomain',
    channel : 1008
});

Members

(readonly) channel :Number

Gets the imagery channel (id) currently being used.
Type:
  • Number
Source:

(readonly) 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.
Type:
Source:

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.
Type:
  • Number
Default Value:
  • 1.9
Source:

(readonly) 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.
Type:
Source:

(readonly) hasAlphaChannel :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.
Type:
  • Boolean
Source:

(readonly) maximumLevel :Number

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

(readonly) minimumLevel :Number

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

(readonly) path :String

Gets the url path of the data on the Google Earth server.
Type:
  • String
Source:

(readonly) proxy :Proxy

Gets the proxy used by this provider.
Type:
  • Proxy
Source:

(readonly) ready :Boolean

Gets a value indicating whether or not the provider is ready for use.
Type:
  • Boolean
Source:

(readonly) readyPromise :Promise.<Boolean>

Gets a promise that resolves to true when the provider is ready for use.
Type:
  • Promise.<Boolean>
Source:

(readonly) 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.
Type:
Source:

(readonly) 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.
Type:
  • String
Source:

(readonly) 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.
Type:
Source:

(readonly) tileHeight :Number

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

(readonly) tileWidth :Number

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

(readonly) tilingScheme :TilingScheme

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

(readonly) url :String

Gets the URL of the Google Earth MapServer.
Type:
  • String
Source:

(readonly) version :Number

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

Methods

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

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;
Source:
Throws:
getTileCredits must not be called before the imagery provider is ready.
Type
DeveloperError
Returns:
The credits to be displayed when the tile is displayed.
Type
Array.<Credit>

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

Picking features is not currently supported by this imagery provider, so this function simply returns undefined.
Parameters:
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.
Source:
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.
Type
Promise.<Array.<ImageryLayerFeatureInfo>> | undefined

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

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.
Source:
Throws:
requestImage must not be called before the imagery provider is ready.
Type
DeveloperError
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.
Type
Promise.<(Image|Canvas)> | undefined