KBE3D / KBCore / Cesium / ArcGisMapServerImageryProvider

类: ArcGisMapServerImageryProvider

<div class="notice"> This object is normally not instantiated directly, use ArcGisMapServerImageryProvider.fromBasemapType or ArcGisMapServerImageryProvider.fromUrl. </div>

Provides tiled imagery hosted by an ArcGIS MapServer. By default, the server's pre-cached tiles are used, if available.

<br/>

An ArcGIS Access Token

is required to authenticate requests to an ArcGIS Image Tile service. To access secure ArcGIS resources, it's required to create an ArcGIS developer account or an ArcGIS online account, then implement an authentication method to obtain an access token.

Examples

// Set the default access token for accessing ArcGIS Image Tile service
Cesium.ArcGisMapService.defaultAccessToken = "<ArcGIS Access Token>";

// Add a base layer from a default ArcGIS basemap
const viewer = new Cesium.Viewer("cesiumContainer", {
  baseLayer: Cesium.ImageryLayer.fromProviderAsync(
    Cesium.ArcGisMapServerImageryProvider.fromBasemapType(
      Cesium.ArcGisBaseMapType.SATELLITE
    )
  ),
});

// Create an imagery provider from the url directly
const esri = await Cesium.ArcGisMapServerImageryProvider.fromUrl(
  "https://ibasemaps-api.arcgis.com/arcgis/rest/services/World_Imagery/MapServer", {
    token: "<ArcGIS Access Token>"
});

参数

Object describing initialization options

属性

enablePickFeatures

enablePickFeatures: boolean

Gets or sets a value indicating whether feature picking is enabled. If true, ArcGisMapServerImageryProvider#pickFeatures will invoke the "identify" operation on the ArcGIS server and return the features included in the response. If false, ArcGisMapServerImageryProvider#pickFeatures will immediately return undefined (indicating no pickable features) without communicating with the server.

---

url

readonly url: string

Gets the URL of the ArcGIS MapServer.

---

token

readonly token: string

Gets the ArcGIS token used to authenticate with the ArcGis MapServer service.

---

proxy

readonly proxy: Proxy

Gets the proxy used by this provider.

---

tileWidth

readonly tileWidth: number

Gets the width of each tile, in pixels.

---

tileHeight

readonly tileHeight: number

Gets the height of each tile, in pixels.

---

maximumLevel

readonly maximumLevel: number | undefined

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

---

minimumLevel

readonly minimumLevel: number

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

---

tilingScheme

readonly tilingScheme: TilingScheme

Gets the tiling scheme used by this provider.

---

rectangle

readonly rectangle: Rectangle

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

---

tileDiscardPolicy

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.

---

errorEvent

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.

---

credit

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.

---

usingPrecachedTiles

readonly usingPrecachedTiles: boolean

Gets a value indicating whether this imagery provider is using pre-cached tiles from the ArcGIS MapServer.

---

hasAlphaChannel

readonly hasAlphaChannel: boolean

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.

---

layers

layers: string

Gets the comma-separated list of layer IDs to show.

方法

fromBasemapType()

static fromBasemapType(style: ArcGisBaseMapType, options?: ConstructorOptions): Promise<ArcGisMapServerImageryProvider>

Creates an ImageryProvider which provides tiled imagery from an ArcGIS base map.

参数

style

ArcGisBaseMapType

The style of the ArcGIS base map imagery. Valid options are ArcGisBaseMapType.SATELLITE, ArcGisBaseMapType.OCEANS, and ArcGisBaseMapType.HILLSHADE.

options?

ConstructorOptions

Object describing initialization options.

返回

Promise<ArcGisMapServerImageryProvider>

A promise that resolves to the created ArcGisMapServerImageryProvider.

Examples

// Set the default access token for accessing ArcGIS Image Tile service
Cesium.ArcGisMapService.defaultAccessToken = "<ArcGIS Access Token>";

// Add a base layer from a default ArcGIS basemap
const provider = await Cesium.ArcGisMapServerImageryProvider.fromBasemapType(
  Cesium.ArcGisBaseMapType.SATELLITE);

// Add a base layer from a default ArcGIS Basemap
const viewer = new Cesium.Viewer("cesiumContainer", {
  baseLayer: Cesium.ImageryLayer.fromProviderAsync(
    Cesium.ArcGisMapServerImageryProvider.fromBasemapType(
      Cesium.ArcGisBaseMapType.HILLSHADE, {
        token: "<ArcGIS Access Token>"
      }
    )
  ),
});

---

fromUrl()

static fromUrl(url: string | Resource, options?: ConstructorOptions): Promise<ArcGisMapServerImageryProvider>

Creates an ImageryProvider which provides tiled imagery hosted by an ArcGIS MapServer. By default, the server's pre-cached tiles are used, if available.

参数

url

The URL of the ArcGIS MapServer service.

string | Resource

options?

ConstructorOptions

Object describing initialization options.

返回

Promise<ArcGisMapServerImageryProvider>

A promise that resolves to the created ArcGisMapServerImageryProvider.

示例

const esri = await Cesium.ArcGisMapServerImageryProvider.fromUrl(
    "https://services.arcgisonline.com/ArcGIS/rest/services/World_Imagery/MapServer"
);

---

getTileCredits()

getTileCredits(x: number, y: number, level: number): Credit[]

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

参数

x

number

The tile X coordinate.

y

number

The tile Y coordinate.

level

number

The tile level;

返回

Credit[]

The credits to be displayed when the tile is displayed.

---

requestImage()

requestImage(x: number, y: number, level: number, request?: Request): Promise<ImageryTypes> | undefined

Requests the image for a given tile.

参数

x

number

The tile X coordinate.

y

number

The tile Y coordinate.

level

number

The tile level.

request?

Request

The request object. Intended for internal use only.

返回

Promise<ImageryTypes> | undefined

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.

---

pickFeatures()

pickFeatures(x: number, y: number, level: number, longitude: number, latitude: number): Promise<ImageryLayerFeatureInfo[]> | undefined

/** Asynchronously determines what features, if any, are located at a given longitude and latitude within a tile.

参数

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.

返回

Promise<ImageryLayerFeatureInfo[]> | undefined

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.

构造函数

构造函数

new ArcGisMapServerImageryProvider(options?: ConstructorOptions): ArcGisMapServerImageryProvider

参数

options?

ConstructorOptions

返回

ArcGisMapServerImageryProvider