# GoogleEarthEnterpriseMapsProvider

#### new Cesium.GoogleEarthEnterpriseMapsProvider(options)
engine/Source/Scene/GoogleEarthEnterpriseMapsProvider.js 202

To construct a GoogleEarthEnterpriseMapsProvider, call `GoogleEarthEnterpriseImageryProvider.fromUrl`. Do not call the constructor directly.
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:

    const google = await Cesium.GoogleEarthEnterpriseMapsProvider.fromUrl("https://earth.localdomain", 1008);

##### See:

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

### Members

#### static Cesium.GoogleEarthEnterpriseMapsProvider.logoUrl : string
engine/Source/Scene/GoogleEarthEnterpriseMapsProvider.js 571

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

#### readonly channel : number
engine/Source/Scene/GoogleEarthEnterpriseMapsProvider.js 277

Gets the imagery channel (id) currently being used.

#### readonly credit : Credit
engine/Source/Scene/GoogleEarthEnterpriseMapsProvider.js 413

Gets the credit to display when this imagery provider is active. Typically this is used to credit the source of the imagery.

#### readonly errorEvent : Event
engine/Source/Scene/GoogleEarthEnterpriseMapsProvider.js 400

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
engine/Source/Scene/GoogleEarthEnterpriseMapsProvider.js 429

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
engine/Source/Scene/GoogleEarthEnterpriseMapsProvider.js 313

Gets the maximum level-of-detail that can be requested.

#### readonly minimumLevel : number
engine/Source/Scene/GoogleEarthEnterpriseMapsProvider.js 325

Gets the minimum level-of-detail that can be requested.

#### readonly path : string
engine/Source/Scene/GoogleEarthEnterpriseMapsProvider.js 253

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

#### readonly proxy : Proxy
engine/Source/Scene/GoogleEarthEnterpriseMapsProvider.js 265

Gets the proxy used by this provider.

#### readonly rectangle : Rectangle
engine/Source/Scene/GoogleEarthEnterpriseMapsProvider.js 372

Gets the rectangle, in radians, of the imagery provided by this instance.

#### readonly requestType : string
engine/Source/Scene/GoogleEarthEnterpriseMapsProvider.js 361

Gets the type of data that is being requested from the provider.

#### readonly tileDiscardPolicy : TileDiscardPolicy
engine/Source/Scene/GoogleEarthEnterpriseMapsProvider.js 386

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.

#### readonly tileHeight : number
engine/Source/Scene/GoogleEarthEnterpriseMapsProvider.js 301

Gets the height of each tile, in pixels.

#### readonly tileWidth : number
engine/Source/Scene/GoogleEarthEnterpriseMapsProvider.js 289

Gets the width of each tile, in pixels.

#### readonly tilingScheme : TilingScheme
engine/Source/Scene/GoogleEarthEnterpriseMapsProvider.js 337

Gets the tiling scheme used by this provider.

#### readonly url : string
engine/Source/Scene/GoogleEarthEnterpriseMapsProvider.js 241

Gets the URL of the Google Earth MapServer.

#### readonly version : number
engine/Source/Scene/GoogleEarthEnterpriseMapsProvider.js 349

Gets the version of the data used by this provider.

### Methods

#### static Cesium.GoogleEarthEnterpriseMapsProvider.fromUrl(url, options) → Promise.<GoogleEarthEnterpriseMapsProvider>
engine/Source/Scene/GoogleEarthEnterpriseMapsProvider.js 450

Creates a tiled imagery provider using the Google Earth Imagery API.

Name | Type | Description
--- | --- | ---
`url` | Resource | string | The url of the Google Earth server hosting the imagery.
`options` | GoogleEarthEnterpriseMapsProvider.ConstructorOptions | optional Object describing initialization options

##### Returns:

The created GoogleEarthEnterpriseMapsProvider.

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

    const google = await Cesium.GoogleEarthEnterpriseMapsProvider.fromUrl("https://earth.localdomain", 1008);

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

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.

#### pickFeatures(x, y, level, longitude, latitude) → undefined
engine/Source/Scene/GoogleEarthEnterpriseMapsProvider.js 553

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:

Undefined since picking is not supported.

#### requestImage(x, y, level, request) → Promise.<ImageryTypes>|undefined
engine/Source/Scene/GoogleEarthEnterpriseMapsProvider.js 520

Requests the image for a given tile.

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.

### Type Definitions

#### Cesium.GoogleEarthEnterpriseMapsProvider.ConstructorOptions
engine/Source/Scene/GoogleEarthEnterpriseMapsProvider.js 14

Initialization options for the GoogleEarthEnterpriseMapsProvider constructor

##### Properties:

Name | Type | Attributes | Default | 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" } ] }
`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> | Ellipsoid.default | The ellipsoid. If not specified, the default ellipsoid is used.

Need help? The fastest way to get answers is from the community and team on the Cesium Forum.