new GoogleEarthEnterpriseImageryProvider()
Provide image tiles using Google Earth Enterprise REST API.
Notes: This provider is used for the 3D Earth API of Google Earth Enterprise, and the Google Earth Enterprise Maps Provider should be used in conjunction with the 2D Map API.
| Name | Type | Description |
|---|---|---|
options.url |
String |
The URL of the Google Earth Enterprise server hosting the images. |
options.metadata |
GoogleEarthEnterpriseMetadata |
This is a metadata object that can be used to share metadata requests with Google Earth Enterprise Imagery Provider. |
options.proxy |
Proxy |
optional
Proxy used for requests. This object should have a getURL function that returns the proxy URL if necessary. |
options.ellipsoid |
Ellipsoid |
optional
Ellipsoid body. If not specified, use WGS84 ellipsoid. |
options.tileDiscardPolicy |
TileDiscardPolicy |
optional
The strategy for determining whether tiles are invalid and should be discarded. If this value is not specified, the default policy is to discard tiles that have failed to download. |
options.credit |
Credit | String |
optional
The copyright information of the data source is displayed on the canvas. |
- See:
-
- GoogleEarthEnterpriseTerrainProvider
- ArcGisMapServerImageryProvider
- GoogleEarthEnterpriseMapsProvider
- createOpenStreetMapImageryProvider
- SingleTileImageryProvider
- createTileMapServiceImageryProvider
- WebMapServiceImageryProvider
- WebMapTileServiceImageryProvider
- UrlTemplateImageryProvider
- Cross-Origin Resource Sharing
Example
var geeMetadata = new GoogleEarthEnterpriseMetadata('http://www.earthenterprise.org/3d');
var gee = new SuperMap3D.GoogleEarthEnterpriseImageryProvider({
metadata : geeMetadata
});
Members
-
readonly creditCredit
-
Obtain the copyright information that needs to be displayed when the image provider is active. Usually used to label the source of images. This function should not be called until GoogleEarthBusinessImageryProvider # ready returns true.
-
readonly errorEventEvent
-
Get an event that is triggered when the image provider encounters an asynchronous error. By subscribing to this event, you will be notified of an error and may have the opportunity to recover from it. The event listener will receive a TileProviderError instance.
-
readonly hasAlphaChannelBoolean
-
Get a value indicating whether the image provided by this image provider contains an alpha channel. If this attribute is false, even if there is an alpha channel, it will be ignored. If this property is true, an image without an alpha channel will be considered to have an alpha value of 1.0 anywhere. Setting this property to false can reduce memory usage and texture upload time.
-
readonly maximumLevelNumber
-
Obtain the maximum level of detail that can be requested. Before calling this method, ensure that GoogleEarthBusinessImageryProvider # ready returns true.
-
readonly minimumLevelNumber
-
Obtain the minimum level of detail that can be requested. Before calling this method, ensure that GoogleEarthBusinessImageryProvider # ready returns true.
-
readonly proxyProxy
-
Obtain a proxy for metadata requests.
-
readonly proxyProxy
-
Get the proxy used by this provider.
-
readonly readyBoolean
-
Get a value indicating whether the provider is ready for use.
-
readonly readyPromisePromise.<Boolean>
-
Get a promise that parses to true when the provider is ready to use it.
-
readonly rectangleRectangle
-
Obtain the rectangular range (in radians) of the image provided by this instance. Before calling this method, ensure that GoogleEarthBusinessImageryProvider # ready returns true.
-
readonly tileDiscardPolicyTileDiscardPolicy
-
Obtain tile discard strategy. If not defined, the discard policy is responsible for filtering out "missing" tiles through its should DiscardImage function. If this function returns undefined, it will not filter any tiles. Before calling this method, ensure that GoogleEarthBusinessImageryProvider # ready returns true
-
readonly tileHeightNumber
-
Get the height of each tile in pixels. Before calling this method, ensure that GoogleEarthBusinessImageryProvider # ready returns true.
-
readonly tileWidthNumber
-
Get the width of each tile in pixels. Before calling this method, ensure that GoogleEarthBusinessImageryProvider # ready returns true.
-
readonly tilingSchemeTilingScheme
-
Obtain the tile scheme used by this provider. Before calling this method, ensure that GoogleEarthBusinessImageryProvider # ready returns true.
-
readonly urlString
-
Obtain the URL of the Google Earth Enterprise server hosting the images.
Methods
-
getTileCredits(x, y, level){Array.<Credit>}
-
Obtain the copyright information that needs to be displayed when displaying a specific tile.
Name Type Description xNumber The X-coordinate of the tile.
yNumber The Y coordinate of the tile.
levelNumber The hierarchy of tiles;
Throws:
-
Do not call getTileCredits until the image provider is ready.
- Type
- DeveloperError
Returns:
Type Description Array.<Credit> The copyright information that needs to be displayed when displaying tiles. -
-
pickFeatures(x, y, level, longitude, latitude){Promise.<Array.<ImageryLayerFeatureInfo>>|undefined}
-
The current image provider does not support feature picking function, so this function only returns undefined.
Name Type Description xNumber The X-coordinate of the tile.
yNumber The Y coordinate of the tile.
levelNumber The hierarchy of tiles.
longitudeNumber Longitude used for picking features.
latitudeNumber The latitude used to pick up features.
Returns:
Type Description Promise.<Array.<ImageryLayerFeatureInfo>> | undefined A promise about picked features will be parsed upon completion of asynchronous picking. The parsed value is an array of ImageryLayerElementInfo instances. If no features are found at a given location, the array may be empty. If picking is not supported, it may also be undefined. -
requestImage(x, y, level, request){Promise.<(Image|Canvas)>|undefined}
-
Request an image for a given tile. This function should not be called until GoogleEarthBusinessImageryProvider # ready returns true.
Name Type Description xNumber The X-coordinate of the tile.
yNumber The Y coordinate of the tile.
levelNumber The hierarchy of tiles;
requestRequest optional Request object. For internal use only.
Throws:
-
requestImagemust not be called before the imagery provider is ready. - Type
- DeveloperError
Returns:
Type Description Promise.<(Image|Canvas)> | undefined A promise about an image that will be parsed when the image is available, or return undefined if there are too many active requests on the server and the request should be retried later. The parsed image can be an Image object or a Canvas DOM object. -