Basemap Gallery

Use dark colors for code blocksCopy
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

Property	Attribute	Type
`activeBasemap`		`Basemap`
`autoDestroyDisabled`	`auto-destroy-disabled`	`boolean`
`disabled`	`disabled`	`boolean`
`headingLevel`	`heading-level`	`1 \| 2 \| 3 \| 4 \| 5 \| 6`
`icon`	`icon`	`string`
`label`	`label`	`string`
`position`	`position`	`"bottom-leading" \| "bottom-left" \| "bottom-right" \| "bottom-trailing" \| "manual" \| "top-leading" \| "top-left" \| "top-right" \| "top-trailing"`
`referenceElement`	`reference-element`	`ArcgisLinkChart \| ArcgisMap \| ArcgisScene \| string`
`source`		`LocalBasemapsSource \| PortalBasemapsSource`
`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

source: LocalBasemapsSource | PortalBasemapsSource

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

Method	Signature
`componentOnReady`	`componentOnReady(): Promise<void>`
`destroy`	`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

Event	Type
`arcgisPropertyChange`	`{ name: "state" \| "activeBasemap"; }`
`arcgisReady`	`undefined`

arcgisPropertyChange

Event

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

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

arcgisReady

Event

arcgisReady: undefined

Emitted when the component associated with a map view is is ready to be interacted with.