Basemap Gallery

1
import "@arcgis/map-components/components/arcgis-basemap-gallery";

BasemapGallery component displays a collection images representing basemaps from ArcGIS.com or a user-defined set of map or image services. When a new basemap is selected from the BasemapGallery, the map's basemap layers are removed and replaced with the basemap layers of the associated basemap selected in the gallery.

Demo

Properties

PropertyAttributeType
auto-destroy-disabled
boolean
disabled
boolean
heading-level
1 | 2 | 3 | 4 | 5 | 6
icon
string
label
string
position
"bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"
reference-element
ArcgisLinkChart | ArcgisMap | ArcgisScene | string
state
readonly
state
"disabled" | "loading" | "ready" | "unsupported"

activeBasemap

Property
activeBasemap: Basemap

The map's current basemap.

autoDestroyDisabled

Property
autoDestroyDisabled: boolean

If true, the component will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the component to a different place on the page, or temporarily hide it. If this is set, make sure to call the `destroy` method when you are done to prevent memory leaks.

Attribute
auto-destroy-disabled
Default value
false

disabled

Property
disabled: boolean

When true, sets the component to a disabled state so the user cannot interact with it.

Attribute
disabled
Default value
false

headingLevel

Property
headingLevel: 1 | 2 | 3 | 4 | 5 | 6

Indicates the heading level to use for the message "No basemaps available" when no basemaps are available in the BasemapGallery.

Attribute
heading-level
Default value
2

icon

Property
icon: string

Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component). Search Calcite Icons for possible values.

Attribute
icon
Default value
"basemap"

label

Property
label: string

The component's default label.

Attribute
label
Default value
""

position

Property
position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"
Attribute
position
Default value
"bottom-left"

referenceElement

Property
referenceElement: ArcgisLinkChart | ArcgisMap | ArcgisScene | string
Attribute
reference-element

source

Property

The source for basemaps that the component will display.

state

readonly
Property
state: "disabled" | "loading" | "ready" | "unsupported"

The current state of the component.

Attribute
state
Default value
"disabled"

Methods

MethodSignature
componentOnReady(): Promise<void>
destroy(): Promise<void>

componentOnReady

Method
componentOnReady(): Promise<void>

Create a promise that resolves once component is fully loaded.

Returns
Promise<void>

destroy

Method
destroy(): Promise<void>

Permanently destroy the component

Returns
Promise<void>

Events

EventType
{ name: "state" | "activeBasemap"; }
undefined

arcgisPropertyChange

Event
arcgisPropertyChange: { name: "state" | "activeBasemap"; }

Fired when the value of a property is changed. Use this to listen to changes to properties.

arcgisReady

Event
arcgisReady: undefined

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