Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ImageryTileLayer

Hierarchy

Index

Properties

bandIds

bandIds: number[]

Defines a band combination using 0-based band indexes.

Read more...

blendMode

blendMode: "average" | "color-burn" | "color-dodge" | "color" | "darken" | "destination-atop" | "destination-in" | "destination-out" | "destination-over" | "difference" | "exclusion" | "hard-light" | "hue" | "invert" | "lighten" | "lighter" | "luminosity" | "minus" | "multiply" | "normal" | "overlay" | "plus" | "reflect" | "saturation" | "screen" | "soft-light" | "source-atop" | "source-in" | "source-out" | "vivid-light" | "xor"

Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer.

Read more...

copyright

copyright: string

The copyright text as defined by the service.

Read more...

customParameters

customParameters: any

A list of custom parameters appended to the URL of all resources fetched by the layer.

Read more...

declaredClass

declaredClass: string

destroyed

destroyed: boolean

effect

effect: Effect

Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to how image filters work.

Read more...

fullExtent

fullExtent: Extent

The full extent of the layer.

Read more...

id

id: string

The unique ID assigned to the layer.

Read more...

initialized

initialized: boolean

interpolation

interpolation: "nearest" | "bilinear" | "cubic" | "majority"

Defines how to interpolate pixel values.

Read more...

legendEnabled

legendEnabled: boolean

Indicates whether the layer will be included in the legend.

Read more...

listMode

listMode: "show" | "hide" | "hide-children"

Indicates how the layer should display in the LayerList widget.

Read more...

Readonly loadError

loadError: Error

The Error object returned if an error occurred while loading.

Read more...

Readonly loadStatus

loadStatus: "not-loaded" | "loading" | "failed" | "loaded"

Represents the status of a load operation.

Read more...

Readonly loadWarnings

loadWarnings: any[]

A list of warnings which occurred while loading.

Read more...

Readonly loaded

loaded: boolean

Indicates whether the layer's resources have loaded.

Read more...

maxScale

maxScale: number

The maximum scale (most zoomed in) at which the layer is visible in the view.

Read more...

minScale

minScale: number

The minimum scale (most zoomed out) at which the layer is visible in the view.

Read more...

multidimensionalDefinition

multidimensionalDefinition: DimensionalDefinition[]

The multidimensional definitions associated with the layer.

Read more...

opacity

opacity: number

The opacity of the layer.

Read more...

popupEnabled

popupEnabled: boolean

Indicates whether to display popups when features in the layer are clicked.

Read more...

popupTemplate

popupTemplate: PopupTemplate

The popup template for the layer.

Read more...

portalItem

portalItem: PortalItem

The portal item from which the layer is loaded.

Read more...

Readonly rasterFields

rasterFields: Field[]

A complete list of fields that consists of raster attribute table fields, item pixel value, service pixel value, service pixel value with various server defined function templates, and raster attribute table fields.

Read more...

Readonly rasterInfo

rasterInfo: RasterInfo

Raster information retrieved from data source.

Read more...

renderer

The renderer assigned to the layer.

Read more...

sourceJSON

sourceJSON: any

The tiled image service's metadata JSON exposed by the ArcGIS REST API.

Read more...

tileInfo

tileInfo: TileInfo

The tiling scheme information for the layer.

Read more...

title

title: string

The title of the layer used to identify it in places such as the LayerList widget.

Read more...

Readonly type

type: "imagery-tile"

url

url: string

The URL of the REST endpoint of the layer.

Read more...

Readonly version

version: number

The version of ArcGIS Server in which the image service is published.

Read more...

visible

visible: boolean

Indicates if the layer is visible in the View.

Read more...

Methods

Protected _get

  • _get(propertyName: string): any
  • _get<T>(propertyName: string): T
  • Parameters

    • propertyName: string

    Returns any

  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

Protected _set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns ImageryTileLayer

cancelLoad

  • cancelLoad(): void
  • Cancels a load() operation if it is already in progress.

    Read more...

    Returns void

createLayerView

  • Called by the views, such as MapView and SceneView, when the layer is added to the Map.layers collection and a layer view must be created for it.

    Read more...

    Parameters

    Returns Promise<LayerView>

createPopupTemplate

  • Creates a default popup template for the layer, populated with all the fields of the layer.

    Read more...

    Parameters

    Returns PopupTemplate

destroy

  • destroy(): void
  • Destroys the layer and any associated resources (including its portalItem, if it is a property on the layer).

    Read more...

    Returns void

emit

  • emit(type: string, event?: any): boolean
  • Emits an event on the instance.

    Read more...

    Parameters

    • type: string
    • Optional event: any

    Returns boolean

fetchAttributionData

  • fetchAttributionData(): Promise<any>
  • Fetches custom attribution data for the layer when it becomes available.

    Read more...

    Returns Promise<any>

fetchPixels

  • Fetches pixels for a given extent.

    Read more...

    Parameters

    Returns Promise<any>

fetchTile

  • fetchTile(level: number, row: number, col: number, options?: any): Promise<any>
  • This method fetches a tile for the given level, row and column present in the view.

    Read more...

    Parameters

    • level: number
    • row: number
    • col: number
    • Optional options: any

    Returns Promise<any>

get

  • get<T>(propertyName: string): T
  • get(propertyName: string): any
  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

hasEventListener

  • hasEventListener(type: string): boolean
  • Indicates whether there is an event listener on the instance that matches the provided event name.

    Read more...

    Parameters

    • type: string

    Returns boolean

identify

  • Identify pixel values at a given location.

    Read more...

    Parameters

    Returns Promise<any>

isFulfilled

  • isFulfilled(): boolean
  • isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).

    Read more...

    Returns boolean

isRejected

  • isRejected(): boolean
  • isRejected() may be used to verify if creating an instance of the class is rejected.

    Read more...

    Returns boolean

isResolved

  • isResolved(): boolean
  • isResolved() may be used to verify if creating an instance of the class is resolved.

    Read more...

    Returns boolean

load

  • load(signal?: AbortSignal): Promise<any>
  • Loads the resources referenced by this class.

    Read more...

    Parameters

    • Optional signal: AbortSignal

    Returns Promise<any>

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

on

  • Parameters

    Returns IHandle

  • Parameters

    Returns IHandle

  • Parameters

    Returns IHandle

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns ImageryTileLayer

  • Parameters

    Returns ImageryTileLayer

watch

  • Parameters

    • path: string | string[]
    • callback: WatchCallback
    • Optional sync: boolean

    Returns WatchHandle

when

  • when(callback?: Function, errback?: Function): Promise<any>
  • when() may be leveraged once an instance of the class is created.

    Read more...

    Parameters

    • Optional callback: Function
    • Optional errback: Function

    Returns Promise<any>

Generated using TypeDoc