GoogleEarthImageryProvider - Cesium Documentation

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

  Name | Type | Description
  --- | --- | ---

  `options`

  Object

  Object with the following properties:

  Name | Type | 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 | `"/default_map"` | optional 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.

  ##### 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:

  - ArcGisMapServerImageryProvider
  - BingMapsImageryProvider
  - OpenStreetMapImageryProvider
  - SingleTileImageryProvider
  - TileMapServiceImageryProvider
  - WebMapServiceImageryProvider
  - WebMapTileServiceImageryProvider
  - UrlTemplateImageryProvider
  - Cross-Origin Resource Sharing
  Source: Scene/GoogleEarthImageryProvider.js, line 100

### Members

#### readonlychannel :Number

  Gets the imagery channel (id) currently being used.
  Source: Scene/GoogleEarthImageryProvider.js, line 269

#### readonlycredit :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.
  Source: Scene/GoogleEarthImageryProvider.js, line 480

#### 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: `1.9`
  Source: Scene/GoogleEarthImageryProvider.js, line 128

#### readonlyerrorEvent :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`.
  Source: Scene/GoogleEarthImageryProvider.js, line 455

#### readonlyhasAlphaChannel :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.
  Source: Scene/GoogleEarthImageryProvider.js, line 496

#### readonlymaximumLevel :Number

  Gets the maximum level-of-detail that can be requested. This function should not be called before `GoogleEarthImageryProvider#ready` returns true.
  Source: Scene/GoogleEarthImageryProvider.js, line 320

#### readonlyminimumLevel :Number

  Gets the minimum level-of-detail that can be requested. This function should not be called before `GoogleEarthImageryProvider#ready` returns true.
  Source: Scene/GoogleEarthImageryProvider.js, line 339

#### readonlypath :String

  Gets the url path of the data on the Google Earth server.
  Source: Scene/GoogleEarthImageryProvider.js, line 245

#### readonlyproxy :Proxy

  Gets the proxy used by this provider.
  Source: Scene/GoogleEarthImageryProvider.js, line 257

#### readonlyready :Boolean

  Gets a value indicating whether or not the provider is ready for use.
  Source: Scene/GoogleEarthImageryProvider.js, line 467

#### readonlyrectangle :Rectangle

  Gets the rectangle, in radians, of the imagery provided by this instance. This function should not be called before `GoogleEarthImageryProvider#ready` returns true.
  Source: Scene/GoogleEarthImageryProvider.js, line 414

#### readonlyrequestType :String

  Gets the type of data that is being requested from the provider. This function should not be called before `GoogleEarthImageryProvider#ready` returns true.
  Source: Scene/GoogleEarthImageryProvider.js, line 396

#### readonlytileDiscardPolicy :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.
  Source: Scene/GoogleEarthImageryProvider.js, line 435

#### readonlytileHeight :Number

  Gets the height of each tile, in pixels. This function should not be called before `GoogleEarthImageryProvider#ready` returns true.
  Source: Scene/GoogleEarthImageryProvider.js, line 301

#### readonlytileWidth :Number

  Gets the width of each tile, in pixels. This function should not be called before `GoogleEarthImageryProvider#ready` returns true.
  Source: Scene/GoogleEarthImageryProvider.js, line 282

#### readonlytilingScheme :TilingScheme

  Gets the tiling scheme used by this provider. This function should not be called before `GoogleEarthImageryProvider#ready` returns true.
  Source: Scene/GoogleEarthImageryProvider.js, line 358

#### readonlyurl :String

  Gets the URL of the Google Earth MapServer.
  Source: Scene/GoogleEarthImageryProvider.js, line 233

#### readonlyversion :Number

  Gets the version of the data used by this provider. This function should not be called before `GoogleEarthImageryProvider#ready` returns true.
  Source: Scene/GoogleEarthImageryProvider.js, line 377

### Methods

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

  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.
  Source: Scene/GoogleEarthImageryProvider.js, line 513

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

  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:

  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.
  Source: Scene/GoogleEarthImageryProvider.js, line 556

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

  Name | Type | Description
  --- | --- | ---
  `x` | Number | The tile X coordinate.
  `y` | Number | The tile Y coordinate.
  `level` | Number | 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 : `requestImage` must not be called before the imagery provider is ready.
  Source: Scene/GoogleEarthImageryProvider.js, line 531