To construct a IonImageryProvider, call
Provides tiled imagery using the Cesium ion REST API.
IonImageryProvider.fromAssetId
. Do not call the constructor directly.
Name | Type | Description |
---|---|---|
options |
IonImageryProvider.ConstructorOptions | optional Object describing initialization options |
Example:
const imageryLayer = Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
viewer.imageryLayers.add(imageryLayer);
See:
Members
readonly credit : Credit
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
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
.
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.
Gets the maximum level-of-detail that can be requested.
Gets the minimum level-of-detail that can be requested. Generally,
a minimum level should only be used when the rectangle of the imagery is small
enough that the number of tiles at the minimum level is small. An imagery
provider with more than a few tiles at the minimum level will lead to
rendering problems.
readonly proxy : Proxy
Gets the proxy used by this provider.
-
Default Value:
undefined
readonly rectangle : Rectangle
Gets the rectangle, in radians, of the imagery provided by the instance.
readonly tileDiscardPolicy : 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.
Gets the height of each tile, in pixels.
Gets the width of each tile, in pixels.
readonly tilingScheme : TilingScheme
Gets the tiling scheme used by the provider.
Methods
static Cesium.IonImageryProvider.fromAssetId(assetId, options) → Promise.<IonImageryProvider>
Creates a provider for tiled imagery using the Cesium ion REST API.
Name | Type | Description |
---|---|---|
assetId |
Number | An ion imagery asset ID. |
options |
IonImageryProvider.ConstructorOptions | optional Object describing initialization options. |
Returns:
A promise which resolves to the created IonImageryProvider.
Throws:
-
RuntimeError : Cesium ion assetId is not an imagery asset
-
RuntimeError : Unrecognized Cesium ion imagery type
Example:
const imageryLayer = Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
viewer.imageryLayers.add(imageryLayer);
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.
pickFeatures(x, y, level, longitude, latitude) → Promise.<Array.<ImageryLayerFeatureInfo>>|undefined
Asynchronously determines what features, if any, are located at a given longitude and latitude within
a tile. This function is optional, so it may not exist on all ImageryProviders.
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.<ImageryTypes>|undefined
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
Initialization options for the TileMapServiceImageryProvider constructor
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
accessToken |
string |
<optional> |
Ion.defaultAccessToken | The access token to use. |
server |
string | Resource |
<optional> |
Ion.defaultServer | The resource to the Cesium ion API server. |