此对象通常不直接实例化,请使用
提供由 ArcGIS MapServer 托管的瓦片影像。默认情况下,如果可用,则使用服务器的预缓存瓦片。
ArcGisMapServerImageryProvider.fromBasemapType 或 ArcGisMapServerImageryProvider.fromUrl。
需要 ArcGIS 访问令牌 来验证对 ArcGIS 图像瓦片服务的请求。 要访问安全的 ArcGIS 资源,需要创建 ArcGIS 开发者帐户或 ArcGIS 在线帐户,然后实现身份验证方法以获取访问令牌。
| Name | Type | Description |
|---|---|---|
options |
ArcGisMapServerImageryProvider.ConstructorOptions | optional 描述初始化选项的对象 |
Examples:
// 设置访问 ArcGIS 图像瓦片服务的默认访问令牌
Cesium.ArcGisMapService.defaultAccessToken = "<ArcGIS Access Token>";
// 从默认 ArcGIS 底图添加基础图层
const viewer = new Cesium.Viewer("cesiumContainer", {
baseLayer: Cesium.ImageryLayer.fromProviderAsync(
Cesium.ArcGisMapServerImageryProvider.fromBasemapType(
Cesium.ArcGisBaseMapType.SATELLITE
)
),
});
// 直接从 URL 创建影像提供程序
const esri = await Cesium.ArcGisMapServerImageryProvider.fromUrl(
"https://ibasemaps-api.arcgis.com/arcgis/rest/services/World_Imagery/MapServer", {
token: "<ArcGIS Access Token>"
});
See:
Members
readonly credit : Credit
获取在此影像提供程序处于活动状态时显示的署名。通常用于为影像来源署名。
获取或设置一个值,该值指示是否启用要素拾取。如果为 true,
ArcGisMapServerImageryProvider#pickFeatures 将在 ArcGIS 服务器上调用 "identify" 操作并返回响应中包含的要素。如果为 false,ArcGisMapServerImageryProvider#pickFeatures 将立即返回 undefined(表示没有可拾取的要素)而不与服务器通信。
-
Default Value:
true
readonly errorEvent : Event
获取一个事件,该事件在影像提供程序遇到异步错误时触发。通过订阅该事件,您将收到错误通知并可能从中恢复。事件监听器会接收到
TileProviderError 的实例。
获取一个值,指示此影像提供程序提供的图像是否包含 alpha 通道。如果此属性为 false,则将忽略 alpha 通道(如果存在)。如果此属性为 true,则任何没有 alpha 通道的图像将被视为其 alpha 值在所有位置均为 1.0。当此属性为 false 时,可减少内存使用和纹理上传时间。
-
Default Value:
true
获取要显示的图层 ID 的逗号分隔列表。
获取可请求的最大细节级别。
获取可请求的最小细节级别。
readonly proxy : Proxy
获取此提供程序使用的代理。
readonly rectangle : Rectangle
获取此实例提供的影像的矩形(以弧度为单位)。
readonly tileDiscardPolicy : TileDiscardPolicy
获取瓦片丢弃策略。如果未定义,丢弃策略负责通过其 shouldDiscardImage 函数过滤掉"缺失"的瓦片。如果此函数返回 undefined,则不过滤任何瓦片。
获取每个瓦片的高度(像素)。
获取每个瓦片的宽度(像素)。
readonly tilingScheme : TilingScheme
获取此提供程序使用的瓦片方案。
获取用于向 ArcGis MapServer 服务进行身份验证的 ArcGIS 令牌。
获取 ArcGIS MapServer 的 URL。
获取一个值,指示此影像提供程序是否正在使用 ArcGIS MapServer 的预缓存瓦片。
-
Default Value:
true
Methods
static Cesium.ArcGisMapServerImageryProvider.fromBasemapType(style, options) → Promise.<ArcGisMapServerImageryProvider>
创建一个
ImageryProvider,提供来自 ArcGIS 底图的瓦片影像。
| Name | Type | Description |
|---|---|---|
style |
ArcGisBaseMapType |
ArcGIS 底图影像的样式。有效选项为 ArcGisBaseMapType.SATELLITE、ArcGisBaseMapType.OCEANS 和 ArcGisBaseMapType.HILLSHADE。 |
options |
ArcGisMapServerImageryProvider.ConstructorOptions | optional 描述初始化选项的对象。 |
Returns:
解析为创建的 ArcGisMapServerImageryProvider 的 Promise。
Examples:
// 设置访问 ArcGIS 图像瓦片服务的默认访问令牌
Cesium.ArcGisMapService.defaultAccessToken = "<ArcGIS Access Token>";
// 从默认 ArcGIS 底图添加基础图层
const provider = await Cesium.ArcGisMapServerImageryProvider.fromBasemapType(
Cesium.ArcGisBaseMapType.SATELLITE);
// 从默认 ArcGIS 底图添加基础图层
const viewer = new Cesium.Viewer("cesiumContainer", {
baseLayer: Cesium.ImageryLayer.fromProviderAsync(
Cesium.ArcGisMapServerImageryProvider.fromBasemapType(
Cesium.ArcGisBaseMapType.HILLSHADE, {
token: "<ArcGIS Access Token>"
}
)
),
});
static Cesium.ArcGisMapServerImageryProvider.fromUrl(url, options) → Promise.<ArcGisMapServerImageryProvider>
创建一个
ImageryProvider,提供由 ArcGIS MapServer 托管的瓦片影像。默认情况下,如果可用,则使用服务器的预缓存瓦片。
| Name | Type | Description |
|---|---|---|
url |
Resource | string | ArcGIS MapServer 服务的 URL。 |
options |
ArcGisMapServerImageryProvider.ConstructorOptions | optional 描述初始化选项的对象。 |
Returns:
解析为创建的 ArcGisMapServerImageryProvider 的 Promise。
Throws:
-
RuntimeError : metadata spatial reference specifies an unknown WKID
-
RuntimeError : metadata fullExtent.spatialReference specifies an unknown WKID
Example:
const esri = await Cesium.ArcGisMapServerImageryProvider.fromUrl(
"https://services.arcgisonline.com/ArcGIS/rest/services/World_Imagery/MapServer"
);
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
异步确定在瓦片内给定经度和纬度处存在哪些要素(如果有)。
| Name | Type | Description |
|---|---|---|
x |
number | 瓦片 X 坐标。 |
y |
number | 瓦片 Y 坐标。 |
level |
number | 瓦片级别。 |
longitude |
number | 拾取要素的经度。 |
latitude |
number | 拾取要素的纬度。 |
Returns:
拾取要素的 Promise,将在异步拾取完成时解析。解析值为
ImageryLayerFeatureInfo 实例的数组。如果在给定位置未找到要素,则数组可能为空。
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
ArcGisMapServerImageryProvider 构造函数的初始化选项
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
tileDiscardPolicy |
TileDiscardPolicy |
<optional> |
确定瓦片是否无效并应丢弃的策略。如果未指定此值,对于瓦片地图服务器使用默认 DiscardMissingTileImagePolicy,对于非瓦片地图服务器使用 NeverTileDiscardPolicy。在前一种情况下,我们请求最大瓦片级别的瓦片 0,0,并检查像素 (0,0)、(200,20)、(20,200)、(80,110) 和 (160, 130)。如果所有这些像素都是透明的,则禁用丢弃检查并且不丢弃任何瓦片。如果其中任何像素具有非透明颜色,则丢弃在这些像素位置具有相同值的任何瓦片。这些默认设置的最终结果应该是对标准 ArcGIS Server 进行正确的瓦片丢弃。要确保不丢弃任何瓦片,请为此参数构造并传递 NeverTileDiscardPolicy。 |
|
usePreCachedTilesIfAvailable |
boolean |
<optional> |
true | 如果为 true,则在预缓存瓦片可用时使用它们。导出瓦片仅受已弃用的 API 支持。 |
layers |
string |
<optional> |
要显示的图层的逗号分隔列表,如果应显示所有图层则为 undefined。 | |
enablePickFeatures |
boolean |
<optional> |
true | 如果为 true,ArcGisMapServerImageryProvider#pickFeatures 将调用 MapServer 上的 Identify 服务并返回响应中包含的要素。如果为 false,ArcGisMapServerImageryProvider#pickFeatures 将立即返回 undefined(表示没有可拾取的要素)而不与服务器通信。如果不想让此提供程序的要素可被拾取,请将此属性设置为 false。可以通过在对象上设置 ArcGisMapServerImageryProvider#enablePickFeatures 属性来覆盖。 |
rectangle |
Rectangle |
<optional> |
Rectangle.MAX_VALUE | 图层的矩形。在访问瓦片图层时忽略此参数。 |
tilingScheme |
TilingScheme |
<optional> |
new GeographicTilingScheme() | 用于将世界划分为瓦片的瓦片方案。在访问瓦片服务器时忽略此参数。 |
ellipsoid |
Ellipsoid |
<optional> |
Ellipsoid.default | 椭球体。如果指定并使用了 tilingScheme,则忽略此参数,而使用瓦片方案的椭球体。如果未指定任何参数,则使用默认椭球体。 |
credit |
Credit | string |
<optional> |
数据源的署名,显示在画布上。在访问瓦片服务器时忽略此参数。 | |
tileWidth |
number |
<optional> |
256 | 每个瓦片的宽度(像素)。在访问瓦片服务器时忽略此参数。 |
tileHeight |
number |
<optional> |
256 | 每个瓦片的高度(像素)。在访问瓦片服务器时忽略此参数。 |
maximumLevel |
number |
<optional> |
请求的最大瓦片级别,如果没有最大值则为 undefined。在访问瓦片服务器时忽略此参数。 |
