Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

declaredClass

declaredClass: string

destroyed

destroyed: boolean

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

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

opacity

opacity: number

The opacity of 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: "group" | "area-measurement" | "base-dynamic" | "base-elevation" | "base-tile" | "bing-maps" | "building-scene" | "csv" | "direct-line-measurement" | "elevation" | "feature" | "geojson" | "geo-rss" | "graphics" | "imagery" | "unknown" | "imagery-tile" | "integrated-mesh" | "kml" | "map-image" | "map-notes" | "ogc-feature" | "open-street-map" | "point-cloud" | "route" | "scene" | "stream" | "tile" | "unsupported" | "vector-tile" | "wcs" | "web-tile" | "wfs" | "wms" | "wmts" | "slice" | "line-of-sight" | "voxel" | "subtype-group"

The layer type provides a convenient way to check the type of the layer without the need to import specific layer modules.

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

  • _set<T>(propertyName: string, value: T): Layer
  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns Layer

cancelLoad

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

    Read more...

    Returns void

createLayerView

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>

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

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

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns Layer

  • Parameters

    Returns Layer

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