Class EsriMap

Hierarchy

Accessor
LayersMixin
TablesMixin
- EsriMap

Index

Constructors

Properties

allLayers allTables basemap declaredClass destroyed editableLayers ground initialized layers tables

Methods

_get _set add addHandles addMany destroy findLayerById findTableById get hasHandles notifyChange own remove removeAll removeHandles removeMany reorder set watch

Constructors

constructor

new EsriMap(properties?): EsriMap
The Map class contains properties and methods for storing, managing, and overlaying layers common to both 2D and 3D viewing.

Read more...
Parameters
- Optional properties: MapProperties
Returns EsriMap
Inherited from Accessor.constructor
- Defined in node_modules/@arcgis/core/interfaces.d.ts:31221

Properties

`Readonly` allLayers

allLayers: Collection<Layer>

A flattened collection of all layers in the map.

`Readonly` allTables

allTables: Collection<Layer>

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

basemap

basemap: EsriBasemap

Specifies a basemap for the map.

declaredClass

declaredClass: string

destroyed

destroyed: boolean

`Readonly` editableLayers

editableLayers: Collection<EsriFeatureLayer | SceneLayer | SubtypeGroupLayer>

A collection of editable layers.

ground

ground: Ground

Specifies the surface properties for the map.

initialized

initialized: boolean

layers

layers: Collection<Layer>

A collection of operational layers.

tables

tables: Collection<Layer>

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

Methods

`Protected` _get

_get(propertyName): any
Parameters
- propertyName: string
Returns any
Inherited from Accessor._get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:32
_get<T>(propertyName): T
Type Parameters
- T
Parameters
- propertyName: string
Returns T
Inherited from Accessor._get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:33

`Protected` _set

_set<T>(propertyName, value): EsriMap
Type Parameters
- T
Parameters
- propertyName: string
- value: T
Returns EsriMap
Inherited from Accessor._set
- Defined in node_modules/@arcgis/core/interfaces.d.ts:34

add

add(layer, index?): void
Adds a layer to the layers collection.

Read more...
Parameters
- layer: Promise<any> | Layer
- Optional index: number
Returns void
Inherited from LayersMixin.add
- Defined in node_modules/@arcgis/core/interfaces.d.ts:65403

addHandles

addHandles<T>(handles, groupKey?): void
Type Parameters
- T
Parameters
- handles: IHandle | IHandle[]
- Optional groupKey: Exclude<T, IHandle>
Returns void
Inherited from Accessor.addHandles
- Defined in node_modules/@arcgis/core/interfaces.d.ts:28

addMany

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

Read more...
Parameters
- layers: Layer[]
- Optional index: number
Returns void
Inherited from LayersMixin.addMany
- Defined in node_modules/@arcgis/core/interfaces.d.ts:65409

destroy

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

Read more...

Returns void
Inherited from Accessor.destroy
- Defined in node_modules/@arcgis/core/interfaces.d.ts:31227

findLayerById

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

Read more...
Parameters
- layerId: string
Returns Layer
Inherited from LayersMixin.findLayerById
- Defined in node_modules/@arcgis/core/interfaces.d.ts:65415

findTableById

findTableById(tableId): Layer
Returns a table based on the given table ID.

Read more...
Parameters
- tableId: string
Returns Layer
Inherited from TablesMixin.findTableById
- Defined in node_modules/@arcgis/core/interfaces.d.ts:65657

get

get<T>(propertyName): T
Type Parameters
- T
Parameters
- propertyName: string
Returns T
Inherited from Accessor.get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:21
get(propertyName): any
Parameters
- propertyName: string
Returns any
Inherited from Accessor.get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:22

hasHandles

hasHandles<T>(groupKey?): boolean
Type Parameters
- T
Parameters
- Optional groupKey: Exclude<T, IHandle>
Returns boolean
Inherited from Accessor.hasHandles
- Defined in node_modules/@arcgis/core/interfaces.d.ts:30

`Protected` notifyChange

notifyChange(propertyName): void
Parameters
- propertyName: string
Returns void
Inherited from Accessor.notifyChange
- Defined in node_modules/@arcgis/core/interfaces.d.ts:31

own

own(handles): void
Deprecated
Since 4.25. Use addHandles(), removeHandles() and hasHandles() instead.
Parameters
- handles: IHandle | IHandle[]
Returns void
Inherited from Accessor.own
- Defined in node_modules/@arcgis/core/interfaces.d.ts:27

remove

remove(layer): Layer
Removes the specified layer from the layers collection.

Read more...
Parameters
- layer: Layer
Returns Layer
Inherited from LayersMixin.remove
- Defined in node_modules/@arcgis/core/interfaces.d.ts:65421

removeAll

removeAll(): Layer[]
Removes all layers.

Read more...

Returns Layer[]
Inherited from LayersMixin.removeAll
- Defined in node_modules/@arcgis/core/interfaces.d.ts:65427

removeHandles

removeHandles<T>(groupKey?): void
Type Parameters
- T
Parameters
- Optional groupKey: Exclude<T, IHandle>
Returns void
Inherited from Accessor.removeHandles
- Defined in node_modules/@arcgis/core/interfaces.d.ts:29

removeMany

removeMany(layers): Layer[]
Removes the specified layers.

Read more...
Parameters
- layers: Layer[]
Returns Layer[]
Inherited from LayersMixin.removeMany
- Defined in node_modules/@arcgis/core/interfaces.d.ts:65433

reorder

reorder(layer, index): Layer
Changes the layer order.

Read more...
Parameters
- layer: Layer
- index: number
Returns Layer
Inherited from LayersMixin.reorder
- Defined in node_modules/@arcgis/core/interfaces.d.ts:65439

set

set<T>(propertyName, value): EsriMap
Type Parameters
- T
Parameters
- propertyName: string
- value: T
Returns EsriMap
Inherited from Accessor.set
- Defined in node_modules/@arcgis/core/interfaces.d.ts:23
set(props): EsriMap
Parameters
- props: HashMap<any>
Returns EsriMap
Inherited from Accessor.set
- Defined in node_modules/@arcgis/core/interfaces.d.ts:24

watch

watch(path, callback, sync?): WatchHandle
Parameters
- path: string | string[]
- callback: WatchCallback
- Optional sync: boolean
Returns WatchHandle
Inherited from Accessor.watch
- Defined in node_modules/@arcgis/core/interfaces.d.ts:25

Class EsriMap

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional properties: MapProperties

Returns EsriMap

Properties

Readonly allLayers

Readonly allTables

basemap

declaredClass

destroyed

Readonly editableLayers

ground

initialized

layers

tables

Methods

Protected _get

Parameters

propertyName: string

Returns any

Type Parameters

T

Parameters

propertyName: string

Returns T

Protected _set

Type Parameters

T

Parameters

propertyName: string

value: T

Returns EsriMap

add

Parameters

layer: Promise<any> | Layer

Optional index: number

Returns void

addHandles

Type Parameters

T

Parameters

handles: IHandle | IHandle[]

Optional groupKey: Exclude<T, IHandle>

Returns void

addMany

Parameters

layers: Layer[]

Optional index: number

Returns void

destroy

Returns void

findLayerById

Parameters

layerId: string

Returns Layer

findTableById

Parameters

tableId: string

Returns Layer

get

Type Parameters

T

Parameters

propertyName: string

Returns T

Parameters

propertyName: string

Returns any

hasHandles

Type Parameters

T

Parameters

Optional groupKey: Exclude<T, IHandle>

`Optional` properties: MapProperties

`Readonly` allLayers

`Readonly` allTables

`Readonly` editableLayers

`Protected` _get

`Protected` _set

`Optional` index: number

`Optional` groupKey: Exclude<T, IHandle>

`Optional` index: number

`Optional` groupKey: Exclude<T, IHandle>

`Protected` notifyChange

`Optional` groupKey: Exclude<T, IHandle>

`Optional` sync: boolean