GoogleEarthEnterpriseMapsProvider

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](http://www.w3.org/TR/cors/) 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 '' and
'' 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]
const google = await GoogleEarthEnterpriseMapsProvider.fromUrl("https://earth.localdomain", 1008);

See also

Types

Link copied to clipboard
object Companion
Link copied to clipboard

Initialization options for the GoogleEarthEnterpriseMapsProvider constructor

Properties

Link copied to clipboard

Gets the imagery channel (id) currently being used.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Gets the proxy used by this provider.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Gets the height of each tile, in pixels.

Link copied to clipboard

Gets the width of each tile, in pixels.

Link copied to clipboard

Gets the tiling scheme used by this provider.

Link copied to clipboard
val url: String

Gets the URL of the Google Earth MapServer.

Link copied to clipboard

Gets the version of the data used by this provider.

Functions

Link copied to clipboard

Gets the credits to be displayed when a given tile is displayed.

Link copied to clipboard
fun pickFeatures(x: Double, y: Double, level: Int, longitude: Double, latitude: Double): Void

Picking features is not currently supported by this imagery provider, so this function simply returns undefined.

Link copied to clipboard
suspend fun requestImage(x: Double, y: Double, level: Int, request: Request? = definedExternally): ImageryTypes?

Requests the image for a given tile.

Link copied to clipboard
fun requestImageAsync(x: Double, y: Double, level: Int, request: Request? = definedExternally): Promise<ImageryTypes>?