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.
| Name | Type | Description | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object |
Object with the following properties:
|
Throws:
-
RuntimeError : Could not find layer with channel (id) of
options.channel. -
RuntimeError : Could not find a version in channel (id)
options.channel. -
RuntimeError : Unsupported projection
data.projection.
Example:
var google = new Cesium.GoogleEarthImageryProvider({
url : '//earth.localdomain',
channel : 1008
});See:
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#readyreturns true. -
defaultGamma :Number
-
The default
ImageryLayer#gammato use for imagery layers created for this provider. By default, this is set to 1.9. Changing this value after creating anImageryLayerfor this provider will have no effect. Instead, set the layer'sImageryLayer#gammaproperty.-
Default Value:
1.9 -
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. -
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.
-
maximumLevel :Number
-
Gets the maximum level-of-detail that can be requested. This function should not be called before
GoogleEarthImageryProvider#readyreturns true. -
minimumLevel :Number
-
Gets the minimum level-of-detail that can be requested. This function should not be called before
GoogleEarthImageryProvider#readyreturns 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#readyreturns true. -
requestType :String
-
Gets the type of data that is being requested from the provider. This function should not be called before
GoogleEarthImageryProvider#readyreturns 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#readyreturns true. -
tileHeight :Number
-
Gets the height of each tile, in pixels. This function should not be called before
GoogleEarthImageryProvider#readyreturns true. -
tileWidth :Number
-
Gets the width of each tile, in pixels. This function should not be called before
GoogleEarthImageryProvider#readyreturns true. -
tilingScheme :TilingScheme
-
Gets the tiling scheme used by this provider. This function should not be called before
GoogleEarthImageryProvider#readyreturns 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#readyreturns true.
Methods
-
getTileCredits(x, y, level) → Array.<Credit>
-
Gets the credits to be displayed when a given tile is displayed.
Name Type Description xNumber The tile X coordinate. yNumber The tile Y coordinate. levelNumber The tile level; Returns:
The credits to be displayed when the tile is displayed.Throws:
-
DeveloperError :
getTileCreditsmust not be called before the imagery provider is ready.
-
-
pickFeatures(x, y, level, longitude, latitude) → Promise
-
Picking features is not currently supported by this imagery provider, so this function simply returns undefined.
Name Type Description xNumber The tile X coordinate. yNumber The tile Y coordinate. levelNumber The tile level. longitudeNumber The longitude at which to pick features. latitudeNumber 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 ofImageryLayerFeatureInfoinstances. The array may be empty if no features are found at the given location. It may also be undefined if picking is not supported. -
requestImage(x, y, level) → Promise
-
Requests the image for a given tile. This function should not be called before
GoogleEarthImageryProvider#readyreturns true.Name Type Description xNumber The tile X coordinate. yNumber The tile Y coordinate. levelNumber The tile level. 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 :
requestImagemust not be called before the imagery provider is ready.
-