Class MapExtension

Extends the capabilities of an Esri Map object.

Hierarchy (view full)

Constructors

constructor

Properties

_deserializedMapPromise _deserializedViewMode _deserializedViewModePromise _handles _id _isSwitchingMap _itemType _map _scene @eventTypes allLayerExtensions constraints formatSettings onClick? onHover? onHoverEnd? onInitialized? onViewpointChanged? tableExtensions

Accessors

_spatialReference basemapExtension basemapOptions bookmarks contextMenu failureMode groundExtension id initialBasemapExtension initialLayerPreset initialViewMode isDestroyed isInitialized isSwitchingMap itemType layerExtensions map requestHelper title viewMode webMap webMapItemTitle webScene webSceneItemTitle

Methods

_applyMapProperties _createFormatSettings _createLayerExtensionCollection _createMap _createScene _createTableExtensionCollection _getSerializableProperties _initializableChildCollections _initializeChildren _onDestroy _onInitialize _postInitialize _toPropertyDef assignProperties assignPropertiesAsync destroy finishAssignProperties getAllFeatureSources getDefault getDefaults getSerializableProperties initialize isSupportedViewMode setWebMap setWebScene switchMap switchViewMode toItemUri toJSON

Constructors

constructor

Properties

Protected_deserializedMapPromise

_deserializedMapPromise: Promise<void>

The Promise created when the 'map' property is deserialized.

Protected_deserializedViewMode

_deserializedViewMode: ViewMode

The viewMode value deserialized from a saved project.

Protected_deserializedViewModePromise

_deserializedViewModePromise: Promise<void>

The Promise created to switch viewModes when a saved project is loaded.

Protected Readonly_handles

_handles: Handles<unknown, ResourceHandle>

Protected_id

_id: string

The unique ID for this entity. Once set, this should never change.

Protected_isSwitchingMap

_isSwitchingMap: boolean = false

Indicates that the extension is in the process of switching maps.

Protected Readonly_itemType

_itemType: string = ItemType.MAP_EXTENSION

The item type for this entity when it participates in an App.

Protected_map

_map: Map

The underlying WebMap instance created from mapping/MapExtension!MapExtension.webMap.

Protected_scene

_scene: WebScene

The underlying WebScene instance created from mapping/MapExtension!MapExtension.webScene.

@eventTypes

@eventTypes: MapExtensionEvents

Deprecated

Do not directly reference this property. Use EventNames and EventTypes helpers from @arcgis/core/Evented.

ReadonlyallLayerExtensions

allLayerExtensions: LayerExtensionCollection<LayerExtensionProperties>

A flat collection of all the layers extensions in the map. This collection contains extensions for basemap layers, operational layers and ground layers. Extensions for group layers and their children are also part of this collection. This collection is read-only.

Readonlyconstraints

constraints: MapConstraints

Configured constraints for the map. Note that it is the caller's responsibility to set these constraints on any MapView or SceneView instances that are created.

ReadonlyformatSettings

formatSettings: FormatSettings

Settings that affect how values in this mapping/MapExtension!MapExtension are formatted.

OptionalonClick

onClick?: Action

An action that will be performed when the user clicks on the map.

OptionalonHover

onHover?: Action

An action that will be performed when the user hovers over the map.

OptionalonHoverEnd

onHoverEnd?: Action

An action that will be performed when the user stops hovering over the map.

OptionalonInitialized

onInitialized?: Action

An action that will be performed when the map initializes.

OptionalonViewpointChanged

onViewpointChanged?: Action

An action that will be performed when the viewpoint changes.

ReadonlytableExtensions

tableExtensions: TableExtensionCollection

The table extensions associated with each table in the map.

Accessors

Protected_spatialReference

  • get _spatialReference(): SpatialReference

  • Gets the spatial reference of the map.

    Returns SpatialReference

basemapExtension

basemapOptions

bookmarks

  • get bookmarks(): Collection<Bookmark>

  • Bookmarked locations on this map.

    Returns Collection<Bookmark>

contextMenu

failureMode

groundExtension

id

  • get id(): string

  • The unique ID for this entity.

    Returns string

initialBasemapExtension

initialLayerPreset

initialViewMode

  • get initialViewMode(): ViewMode

  • The initial view mode for the map (2D or 3D).

    Returns ViewMode

  • set initialViewMode(viewMode): void

  • Parameters

    Returns void

isDestroyed

isInitialized

isSwitchingMap

  • get isSwitchingMap(): boolean

  • Indicates that the extension is in the process of switching maps.

    Returns boolean

itemType

  • get itemType(): string

  • The item type for this entity when it participates in an App.

    Returns string

layerExtensions

map

  • get map(): Map

  • The Esri Map object being extended.

    Returns Map

requestHelper

title

  • get title(): string

  • A human-readable title for the map.

    Returns string

  • set title(value): void

  • Parameters

    • value: string

    Returns void

viewMode

  • get viewMode(): ViewMode

  • The current view mode for the map (2D or 3D).

    Returns ViewMode

webMap

webMapItemTitle

  • get webMapItemTitle(): string

  • The title of the web map portal item.

    Returns string

webScene

webSceneItemTitle

  • get webSceneItemTitle(): string

  • The title of the web scene portal item.

    Returns string

Methods

Protected_applyMapProperties

  • _applyMapProperties(mapProperties, map, portalItem?): Promise<void>

  • Invoked when web map/web scene json needs to be applied to the Map object.

    Parameters

    • mapProperties: MapProperties

      The properties to apply.

    • map: Map

      The map/scene to apply the properties to.

    • OptionalportalItem: PortalItem

      Portal item that the properties came from, if applicable.

    Returns Promise<void>

Protected_createFormatSettings

Protected_createLayerExtensionCollection

Protected_createMap

  • _createMap(): Promise<void>

  • Creates the 2D map from the webMap if it's not already created.

    Returns Promise<void>

Protected_createScene

  • _createScene(): Promise<void>

  • Creates the 3D scene from the webScene if it's not already created.

    Returns Promise<void>

Protected_createTableExtensionCollection

Protected_getSerializableProperties

Protected_initializableChildCollections

Protected_initializeChildren

Protected_onDestroy

  • _onDestroy(): Promise<void>

  • Called to perform cleanup. Subclasses should override this method rather than destroy() to perform custom cleanup.

    Returns Promise<void>

Protected_onInitialize

Protected_postInitialize

  • _postInitialize(): Promise<void>

  • Called after normal initialization. Note: Child items are initialized before this is called.

    Returns Promise<void>

Protected_toPropertyDef

assignProperties

assignPropertiesAsync

destroy

  • destroy(): Promise<void>

  • A clean-up function that should get called whenever the item is disposed of.

    Returns Promise<void>

finishAssignProperties

getAllFeatureSources

  • getAllFeatureSources(predicate?): FeatureSource[]

  • Gets a flattened list of all feature sources for the associated map.

    Parameters

    • predicate: FeatureSourcePredicate = ...

      If specified, only sources that match the given predicate will be returned.

    Returns FeatureSource[]

getDefault

getDefaults

getSerializableProperties

initialize

  • initialize(): Promise<void>

  • Initializes the item.

    Returns Promise<void>

isSupportedViewMode

  • isSupportedViewMode(viewMode): boolean

  • Determines whether this map extension supports the given view mode.

    Parameters

    • viewMode: ViewMode

      The view mode to check.

    Returns boolean

setWebMap

  • setWebMap(webMap): Promise<void>

  • Updates the map that will load when the view mode is switched to MAP.

    Parameters

    Returns Promise<void>

setWebScene

  • setWebScene(webScene): Promise<void>

  • Updates the map that will load when the view mode is switched to SCENE.

    Parameters

    Returns Promise<void>

switchMap

  • switchMap(newMap): Promise<void>

  • Switches the current map for a new one. This operation will reconfigure existing layer, sublayer, and table extensions to extend the equivalent ones in the new map, if possible.

    The primary use case is for switching between maps that have a similar configuration, for example when going between a map and a scene with similar layers.

    Parameters

    • newMap: Map

      The new map.

    Returns Promise<void>

switchViewMode

  • switchViewMode(viewMode): Promise<void>

  • Switches the map extension's view mode.

    Parameters

    • viewMode: ViewMode

      The view mode to switch to.

    Returns Promise<void>

toItemUri

  • toItemUri(): string

  • Creates an item:// URI reference to this entity.

    Returns string

toJSON

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods