要构造一个 IonImageryProvider,请调用
Provides tiled imagery using the Cesium ion REST API.
IonImageryProvider.fromAssetId。不要直接调用构造函数。
| Name | Type | Description |
|---|---|---|
options |
IonImageryProvider.ConstructorOptions | optional 描述初始化选项的对象 |
Example:
const imageryLayer = Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
viewer.imageryLayers.add(imageryLayer);
See:
Members
readonly credit : Credit
获取此影像提供器处于活动状态时要显示的版权信息。通常这用于注明
影像的来源。
readonly errorEvent : Event
获取当影像提供器遇到异步错误时引发的事件。通过订阅该事件,你会收到错误通知并有可能从中恢复。事件监听器会接收到
TileProviderError 的一个实例。
获取一个指示此影像提供器所提供的影像是否包含 alpha 通道的值。如果此属性为 false,则 alpha 通道(如果存在)将被忽略。如果此属性为 true,则任何没有 alpha 通道的影像都会被当作其 alpha 处处为 1.0 来处理。当此属性为 false 时,内存占用和纹理上传时间都会减少。
获取可以请求的最大细节层级。
获取可以请求的最小细节层级。通常,
只有当影像的矩形范围足够小、使得最小层级上的瓦片数量很少时,才应使用最小层级。
在最小层级上有过多瓦片的影像提供器会导致渲染问题。
readonly proxy : Proxy
获取此提供器使用的代理。
-
Default Value:
undefined
readonly rectangle : Rectangle
获取此实例所提供的影像的矩形范围(以弧度表示)。
readonly tileDiscardPolicy : TileDiscardPolicy
获取瓦片丢弃策略。如果不为 undefined,该丢弃策略负责通过其 shouldDiscardImage 函数过滤掉"缺失"的瓦片。如果此函数返回 undefined,则不会过滤任何瓦片。
获取每个瓦片的高度(以像素为单位)。
获取每个瓦片的宽度(以像素为单位)。
readonly tilingScheme : TilingScheme
获取此提供器使用的瓦片方案。
Methods
static Cesium.IonImageryProvider.fromAssetId(assetId, options) → Promise.<IonImageryProvider>
使用 Cesium ion REST API 创建一个用于分块影像的提供器。
| Name | Type | Description |
|---|---|---|
assetId |
number | 一个 ion 影像资产 ID。 |
options |
IonImageryProvider.ConstructorOptions | optional 描述初始化选项的对象. |
Returns:
一个解析为所创建的 IonImageryProvider 的 promise。
Throws:
-
RuntimeError :Cesium ion assetId 不是影像资产
-
RuntimeError :无法识别的 Cesium ion 影像类型
Example:
const imageryLayer = Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
viewer.imageryLayers.add(imageryLayer);
getTileCredits(x, y, level) → Array.<Credit>
获取在显示给定瓦片时要显示的版权信息。
| Name | Type | Description |
|---|---|---|
x |
number | 瓦片的 X 坐标。 |
y |
number | 瓦片的 Y 坐标。 |
level |
number | 瓦片的层级; |
Returns:
显示该瓦片时要显示的版权信息。
pickFeatures(x, y, level, longitude, latitude) → Promise.<Array.<ImageryLayerFeatureInfo>>|undefined
异步确定在给定瓦片内、给定经度和纬度处存在哪些要素(如果有)。此函数是可选的,因此它可能并不存在于所有 ImageryProvider 上。
| Name | Type | Description |
|---|---|---|
x |
number | 瓦片的 X 坐标。 |
y |
number | 瓦片的 Y 坐标。 |
level |
number | 瓦片的层级。 |
longitude |
number | 用于拾取要素处的经度。 |
latitude |
number | 用于拾取要素处的纬度。 |
Returns:
一个用于已拾取要素的 promise,将在异步拾取完成时解析。解析后的值是一个
ImageryLayerFeatureInfo
实例的数组。如果在给定位置没有找到任何要素,该数组可能为空。
如果不支持拾取,则也可能为 undefined。
requestImage(x, y, level, request) → Promise.<ImageryTypes>|undefined
请求给定瓦片的影像。
| Name | Type | Description |
|---|---|---|
x |
number | 瓦片的 X 坐标。 |
y |
number | 瓦片的 Y 坐标。 |
level |
number | 瓦片的层级。 |
request |
Request | optional 请求对象。仅供内部使用。 |
Returns:
一个用于影像的 promise,将在影像可用时解析;如果向服务器的活动请求过多、应当稍后重试,则为
undefined。
Type Definitions
TileMapServiceImageryProvider 构造函数的初始化选项。
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
accessToken |
string |
<optional> |
Ion.defaultAccessToken | 要使用的访问令牌。 |
server |
string | Resource |
<optional> |
Ion.defaultServer | 指向 Cesium ion API 服务器的资源。 |
