Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Readonly allLayers

allLayers: Collection<Layer>

A flattened collection of all layers in the map.

Read more...

Readonly allTables

allTables: Collection<Layer>

A flattened collection of tables anywhere in the map's hierarchy.

Read more...

applicationProperties

applicationProperties: ApplicationProperties

The applicationProperties contains the viewing properties of the WebMap.

Read more...

authoringApp

authoringApp: string

The name of the application that authored the WebMap.

Read more...

authoringAppVersion

authoringAppVersion: string

The version of the application that authored the WebMap.

Read more...

basemap

basemap: Basemap

Specifies a basemap for the map.

Read more...

bookmarks

bookmarks: Collection<Bookmark>

An array of saved geographic extents that allow end users to quickly navigate to a particular area of interest.

Read more...

declaredClass

declaredClass: string

destroyed

destroyed: boolean

Readonly editableLayers

A collection of editable layers.

Read more...

floorInfo

floorInfo: MapFloorInfo

When a web map is configured as floor-aware, it has a floorInfo property defined.

Read more...

ground

ground: Ground

Specifies the surface properties for the map.

Read more...

initialViewProperties

initialViewProperties: InitialViewProperties

The initial view of the WebMap.

Read more...

initialized

initialized: boolean

layers

layers: Collection<Layer>

A collection of operational layers.

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 loaded

loaded: boolean

Indicates whether the instance has loaded.

Read more...

portalItem

portalItem: PortalItem

The portal item from which the WebMap is loaded.

Read more...

presentation

presentation: any

Provides multiple slides.

Read more...

Readonly sourceVersion

sourceVersion: WebMapSourceVersion

The version of the source document from which the WebMap was read.

Read more...

tables

tables: Collection<Layer>

A collection of layer instances that are tables saved in a Map and/or a WebMap.

Read more...

thumbnailUrl

thumbnailUrl: string

The URL to the thumbnail used for the webmap.

Read more...

utilityNetworks

utilityNetworks: any

The utilityNetworks object contains utility networks saved on the web map

Read more...

widgets

widgets: Widgets

The widgets object contains widgets that are exposed to the user.

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): WebMap
  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns WebMap

add

  • add(layer: Layer | Promise<any>, index?: number): void
  • Adds a layer to the layers collection.

    Read more...

    Parameters

    • layer: Layer | Promise<any>
    • Optional index: number

    Returns void

addMany

  • addMany(layers: Layer[], index?: number): void
  • Adds a layer or an array of layers to the layers collection.

    Read more...

    Parameters

    • layers: Layer[]
    • Optional index: number

    Returns void

destroy

  • destroy(): void
  • Destroys the map, and any associated resources, including its layers, basemap, tables, and ground.

    Read more...

    Returns void

findLayerById

  • findLayerById(layerId: string): Layer
  • Returns a layer based on the given layer ID.

    Read more...

    Parameters

    • layerId: string

    Returns Layer

findTableById

  • Returns a table based on the given table ID.

    Read more...

    Parameters

    • tableId: string

    Returns SearchTable

get

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

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns 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(): Promise<any>
  • Triggers the loading of the WebMap instance.

    Read more...

    Returns Promise<any>

loadAll

  • Loads all the externally loadable resources associated with the webmap.

    Read more...

    Returns Promise<WebMap>

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

remove

  • Removes the specified layer from the layers collection.

    Read more...

    Parameters

    Returns Layer

removeAll

  • Removes all layers.

    Read more...

    Returns Layer[]

removeMany

  • Removes the specified layers.

    Read more...

    Parameters

    Returns Layer[]

reorder

  • Changes the layer order.

    Read more...

    Parameters

    • layer: Layer
    • index: number

    Returns Layer

save

  • Saves the webmap to its associated portal item.

    Read more...

    Parameters

    Returns Promise<PortalItem>

saveAs

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns WebMap

  • Parameters

    Returns WebMap

updateFrom

  • Update properties of the WebMap related to the view.

    Read more...

    Parameters

    Returns Promise<any>

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