Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ImageryLayer

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

capabilities

Describes the layer's supported capabilities.

Read more...

compressionQuality

compressionQuality: number

The compression quality value.

Read more...

compressionTolerance

compressionTolerance: number

Controls the tolerance of the lerc compression algorithm.

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

definitionExpression

definitionExpression: string

The SQL where clause used to filter rasters.

Read more...

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

fields

fields: Field[]

An array of fields in the layer.

Read more...

format

format: "png" | "png8" | "png24" | "png32" | "jpg" | "bmp" | "gif" | "jpgpng" | "lerc" | "tiff"

The format of the exported image.

Read more...

fullExtent

fullExtent: Extent

The full extent of the layer.

Read more...

hasMultidimensions

hasMultidimensions: boolean

Indicates if the layer has multidimensionalInfo.

Read more...

id

id: string

The unique ID assigned to the layer.

Read more...

imageMaxHeight

imageMaxHeight: number

Indicates the maximum height of the image exported by the service.

Read more...

imageMaxWidth

imageMaxWidth: number

Indicates the maximum width of the image exported by the service.

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

mosaicRule

mosaicRule: MosaicRule

Defines how overlapping images should be mosaicked.

Read more...

Readonly multidimensionalInfo

multidimensionalInfo: RasterMultidimensionalInfo

The multidimensional information associated with the layer if the layer's hasMultidimensions property is true.

Read more...

noData

noData: number | number[]

The pixel value representing no available information.

Read more...

noDataInterpretation

noDataInterpretation: "any" | "all"

Interpretation of the noData setting.

Read more...

objectIdField

objectIdField: string

The name of an oid field containing a unique value or identifier for each raster in the layer.

Read more...

opacity

opacity: number

The opacity of the layer.

Read more...

pixelFilter

pixelFilter: PixelFilterFunction

A function that processes pixelData.

Read more...

pixelType

pixelType: "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"

Raster source pixel type.

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

refreshInterval

refreshInterval: number

Refresh interval of the layer in minutes.

Read more...

renderer

The renderer assigned to the layer.

Read more...

renderingRule

renderingRule: RasterFunction

Specifies the rule for how the requested image should be rendered.

Read more...

Readonly serviceRasterInfo

serviceRasterInfo: RasterInfo

Source raster information of the image service.

Read more...

sourceJSON

sourceJSON: any

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

Read more...

Readonly spatialReference

spatialReference: SpatialReference

The spatial reference of the image service.

Read more...

timeExtent

timeExtent: TimeExtent

The layer's time extent.

Read more...

timeInfo

timeInfo: TimeInfo

TimeInfo provides information such as date fields that store start and end time for each feature and the fullTimeExtent for the layer.

Read more...

timeOffset

timeOffset: TimeInterval

A temporary offset of the time data based on a certain TimeInterval.

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"

url

url: string

The URL to the REST endpoint of the layer.

Read more...

useViewTime

useViewTime: boolean

Determines if the layer will update its temporal data based on the view's timeExtent.

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 ImageryLayer

cancelLoad

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

    Read more...

    Returns void

computeHistograms

computeStatisticsHistograms

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>

fetchImage

generateRasterInfo

  • Generates raster info for the specified rendering rule.

    Read more...

    Parameters

    Returns Promise<RasterInfo>

get

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

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

getCatalogItemICSInfo

  • getCatalogItemICSInfo(rasterId: number, abortOptions?: AbortSignal): Promise<any>
  • Gets the image coordinate system information of a catalog item in an image service.

    Read more...

    Parameters

    • rasterId: number
    • Optional abortOptions: AbortSignal

    Returns Promise<any>

getCatalogItemRasterInfo

  • getCatalogItemRasterInfo(rasterId: number, abortOptions?: AbortSignal): Promise<RasterInfo>
  • Get the raster info of a catalog item in an image service.

    Read more...

    Parameters

    • rasterId: number
    • Optional abortOptions: AbortSignal

    Returns Promise<RasterInfo>

getSamples

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

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

queryRasters

redraw

  • redraw(): void
  • Executes the pixelFilter function and redraws the layer.

    Read more...

    Returns void

refresh

  • refresh(): void
  • Fetches all the data for the layer.

    Read more...

    Returns void

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns ImageryLayer

  • Parameters

    Returns ImageryLayer

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