# GoogleEarthEnterpriseMapsProvider

#### new Cesium.GoogleEarthEnterpriseMapsProvider(options)
Scene/GoogleEarthEnterpriseMapsProvider.js 92

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. This provider is for use with 2D Maps API as part of Google Earth Enterprise. For 3D Earth API uses, it is necessary to use `GoogleEarthEnterpriseImageryProvider`

Name | Type | Description
--- | --- | ---
`options` | GoogleEarthEnterpriseMapsProvider.ConstructorOptions | Object describing initialization options

##### 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.GoogleEarthEnterpriseMapsProvider({
        url : 'https://earth.localdomain',
        channel : 1008
    });

##### See:

- ArcGisMapServerImageryProvider
- BingMapsImageryProvider
- OpenStreetMapImageryProvider
- SingleTileImageryProvider
- TileMapServiceImageryProvider
- WebMapServiceImageryProvider
- WebMapTileServiceImageryProvider
- UrlTemplateImageryProvider
- Cross-Origin Resource Sharing

### Members

#### static Cesium.GoogleEarthEnterpriseMapsProvider.logoUrl : String
Scene/GoogleEarthEnterpriseMapsProvider.js 753

Gets or sets the URL to the Google Earth logo for display in the credit.

#### readonly channel : Number
Scene/GoogleEarthEnterpriseMapsProvider.js 394

Gets the imagery channel (id) currently being used.

#### readonly credit : Credit
Scene/GoogleEarthEnterpriseMapsProvider.js 635

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

#### defaultAlpha : Number|undefined
Scene/GoogleEarthEnterpriseMapsProvider.js 111

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/GoogleEarthEnterpriseMapsProvider.js 138

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/GoogleEarthEnterpriseMapsProvider.js 147

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/GoogleEarthEnterpriseMapsProvider.js 129

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/GoogleEarthEnterpriseMapsProvider.js 172

The default gamma correction to apply to this provider. 1.0 uses the unmodified imagery color.

Default Value: `1.9`

#### defaultHue : Number|undefined
Scene/GoogleEarthEnterpriseMapsProvider.js 155

The default hue of this provider in radians. 0.0 uses the unmodified imagery color.

Default Value: `undefined`

#### defaultMagnificationFilter : TextureMagnificationFilter
Scene/GoogleEarthEnterpriseMapsProvider.js 188

The default texture magnification filter to apply to this provider.

Default Value: `undefined`

#### defaultMinificationFilter : TextureMinificationFilter
Scene/GoogleEarthEnterpriseMapsProvider.js 180

The default texture minification filter to apply to this provider.

Default Value: `undefined`

#### defaultNightAlpha : Number|undefined
Scene/GoogleEarthEnterpriseMapsProvider.js 120

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/GoogleEarthEnterpriseMapsProvider.js 164

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/GoogleEarthEnterpriseMapsProvider.js 598

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/GoogleEarthEnterpriseMapsProvider.js 651

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.

#### readonly maximumLevel : Number|undefined
Scene/GoogleEarthEnterpriseMapsProvider.js 449

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

#### readonly minimumLevel : Number
Scene/GoogleEarthEnterpriseMapsProvider.js 470

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

#### readonly path : String
Scene/GoogleEarthEnterpriseMapsProvider.js 370

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

#### readonly proxy : Proxy
Scene/GoogleEarthEnterpriseMapsProvider.js 382

Gets the proxy used by this provider.

#### readonly ready : Boolean
Scene/GoogleEarthEnterpriseMapsProvider.js 610

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

#### readonly readyPromise : Promise.<Boolean>
Scene/GoogleEarthEnterpriseMapsProvider.js 622

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

#### readonly rectangle : Rectangle
Scene/GoogleEarthEnterpriseMapsProvider.js 553

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

#### readonly requestType : String
Scene/GoogleEarthEnterpriseMapsProvider.js 533

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

#### readonly tileDiscardPolicy : TileDiscardPolicy
Scene/GoogleEarthEnterpriseMapsProvider.js 576

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

#### readonly tileHeight : Number
Scene/GoogleEarthEnterpriseMapsProvider.js 428

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

#### readonly tileWidth : Number
Scene/GoogleEarthEnterpriseMapsProvider.js 407

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

#### readonly tilingScheme : TilingScheme
Scene/GoogleEarthEnterpriseMapsProvider.js 491

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

#### readonly url : String
Scene/GoogleEarthEnterpriseMapsProvider.js 358

Gets the URL of the Google Earth MapServer.

#### readonly version : Number
Scene/GoogleEarthEnterpriseMapsProvider.js 512

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

### Methods

#### getTileCredits(x, y, level) → Array.<Credit>
Scene/GoogleEarthEnterpriseMapsProvider.js 668

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) → Promise.<Array.<ImageryLayerFeatureInfo>>|undefined
Scene/GoogleEarthEnterpriseMapsProvider.js 735

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.

#### requestImage(x, y, level, request) → Promise.<(HTMLImageElement|HTMLCanvasElement)>|undefined
Scene/GoogleEarthEnterpriseMapsProvider.js 691

Requests the image for a given tile. This function should not be called before `GoogleEarthEnterpriseMapsProvider#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. 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.

### Type Definitions

#### Cesium.GoogleEarthEnterpriseMapsProvider.ConstructorOptions
Scene/GoogleEarthEnterpriseMapsProvider.js 17

Initialization options for the GoogleEarthEnterpriseMapsProvider constructor

##### Properties:

Name | Type | Attributes | Default | Description
--- | --- | --- | --- | ---
`url` | Resource | 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.