kotlin-cesium-engine/cesium.engine/ArcGisMapServerImageryProvider

ArcGisMapServerImageryProvider

external class ArcGisMapServerImageryProvider(options: ArcGisMapServerImageryProvider.ConstructorOptions? = definedExternally)(source)

This object is normally not instantiated directly, use [ArcGisMapServerImageryProvider.fromBasemapType] or [ArcGisMapServerImageryProvider.fromUrl].

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

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.

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

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

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

Constructors

ArcGisMapServerImageryProvider

constructor(options: ArcGisMapServerImageryProvider.ConstructorOptions? = definedExternally)

Types

Companion

object Companion

ConstructorOptions

interface ConstructorOptions

Initialization options for the ArcGisMapServerImageryProvider constructor

Properties

credit

val credit: Credit

Gets the credit to display when this imagery provider is active. Typically this is used to credit the source of the imagery.

enablePickFeatures

var 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.

errorEvent

val errorEvent: DefaultEvent

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.

hasAlphaChannel

val 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

var layers: String

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

maximumLevel

val maximumLevel: Int?

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

minimumLevel

val minimumLevel: Int

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

proxy

val proxy: Proxy

Gets the proxy used by this provider.

rectangle

val rectangle: Rectangle

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

tileDiscardPolicy

val 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.

tileHeight

val tileHeight: Int

Gets the height of each tile, in pixels.

tileWidth

val tileWidth: Int

Gets the width of each tile, in pixels.

tilingScheme

val tilingScheme: TilingScheme

Gets the tiling scheme used by this provider.

token

val token: String

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