Embedded Map

The Embedded Map Component allows users to embed a saved web map with default components (i.e. zoom, legend, bookmarks) pre-configured.

Demo

Properties

PropertyAttributeType
api-key
string
bookmarks-enabled
boolean
center
Array<number> | string
heading-enabled
boolean
host
string
information-enabled
boolean
item-id
string
legend-enabled
boolean
portal-url
string
scale
number | string
share-enabled
boolean
strict-portal
boolean
theme
string

apiKey

Property
apiKey: string

An authorization string used to access a resource or service. API keys are generated and managed in the portal. An API key is tied explicitly to an ArcGIS account; it is also used to monitor service usage.

Attribute
api-key
Default value
""

bookmarksEnabled

Property
bookmarksEnabled: boolean

Indicates whether the bookmarks panel for the WebMap can be viewed.

Attribute
bookmarks-enabled
Default value
false

center

Property
center: Array<number> | string

Represents the view's center point; when setting the center, you may pass an esri/geometry/Point instance or a string representing a longitude/latitude pair ("-100.4593, 36.9014"). Setting the center immediately changes the current view.

Attribute
center

headingEnabled

Property
headingEnabled: boolean

Indicates whether the heading that displays the title of the WebMap is enabled.

Attribute
heading-enabled
Default value
false

host

Property
host: string
Attribute
host
Default value
"js"

informationEnabled

Property
informationEnabled: boolean

Indicates whether the information panel for WebMap is enabled.

Attribute
information-enabled
Default value
false

itemId

Property
itemId: string

The ID of a WebMap from ArcGIS Online or ArcGIS Enterprise portal.

Attribute
item-id

legendEnabled

Property
legendEnabled: boolean

Indicates whether the legend panel for WebMap is enabled.

Attribute
legend-enabled
Default value
false

portalUrl

Property
portalUrl: string

The Portal for the WebMap from ArcGIS Online or ArcGIS Enterprise portal. Default value is https://www.arcgis.com.

Attribute
portal-url
Default value
"https://www.arcgis.com"

scale

Property
scale: number | string

Represents the map scale at the center of the view. Setting the scale immediately changes the view. For animating the view, see this component's goTo() method.

Attribute
scale

shareEnabled

Property
shareEnabled: boolean

Indicates whether the button to open WebMap in Map Viewer is enabled.

Attribute
share-enabled
Default value
false

strictPortal

Property
strictPortal: boolean
Attribute
strict-portal
Default value
false

theme

Property
theme: string

The light or dark theme of the component. Default value is light.

Attribute
theme
Default value
"light"

Methods

MethodSignature
componentOnReady(): Promise<void>

componentOnReady

Method
componentOnReady(): Promise<void>

Create a promise that resolves once component is fully loaded.

Returns
Promise<void>

Events

No events to display.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close