arcgis-basemap-gallery | References | ArcGIS Maps SDK for JavaScript

ESM

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

Inheritance: ArcgisBasemapGallery→PublicLitElement

Since: ArcGIS Maps SDK for JavaScript 4.28

The Basemap Gallery 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 Basemap Gallery, 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	active-basemap	BasemapProperties \| string \| undefined
autoDestroyDisabled	auto-destroy-disabled	boolean
disabled reflected	disabled	boolean
headingLevel	heading-level	HeadingLevel
icon	icon	string
label	label	string
messageOverrides		Record<string, unknown> \| undefined
referenceElement	reference-element	ArcgisReferenceElement \| string \| undefined
source		LocalBasemapsSource \| PortalBasemapsSource
state readonly		BasemapGalleryViewModelState
view		MapViewOrSceneView \| null \| undefined

activeBasemap

Property

Type: BasemapProperties | string | undefined

The map's current basemap.

Attribute: active-basemap

autoDestroyDisabled

Property

Type: 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

reflected Property

Type: boolean

When true, the component is visually withdrawn and cannot receive user interaction.

Attribute: disabled
Default value: false

headingLevel

Property

Type: HeadingLevel

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

Attribute: heading-level
Default value: 2

icon

Property

Type: string

Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).

See also

Calcite Icons

Attribute: icon
Default value: "basemap"

label

Property

Type: string

The component's default label.

Attribute: label
Default value: ""

messageOverrides

Property

Type: Record<string, unknown> | undefined

Replace localized message strings with your own strings.

Note: Individual message keys may change between releases.

referenceElement

Property

Type: ArcgisReferenceElement | string | undefined

By assigning the id attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.

See also

Associate components with a Map or Scene component

Attribute: reference-element

source

Property

Type: LocalBasemapsSource | PortalBasemapsSource

The source for basemaps that the component will display.

Examples

Set the source from a local basemap collection.

<arcgis-map basemap="gray">
  <arcgis-basemap-gallery slot="top-right"></arcgis-basemap-gallery>
</arcgis-map>

<script type="module">
  const [Basemap, LocalBasemapsSource] = await $arcgis.import([
    "@arcgis/core/Basemap.js",
    "@arcgis/core/widgets/BasemapGallery/support/LocalBasemapsSource.js",
  ]);
  // get the basemap gallery element
  const basemapGallery = document.querySelector("arcgis-basemap-gallery");

  // set the source from a local collection of basemaps
  basemapGallery.source = new LocalBasemapsSource({
    basemaps: [Basemap.fromId("topo-vector"), Basemap.fromId("hybrid")],
  });
</script>

Set the source from a Portal group

<arcgis-map item-id="8d91bd39e873417ea21673e0fee87604">
  <arcgis-basemap-gallery slot="top-right"></arcgis-basemap-gallery>
</arcgis-map>

<script type="module">
  const PortalBasemapsSource = await $arcgis.import("@arcgis/core/widgets/BasemapGallery/support/PortalBasemapsSource.js");
  // get the basemap gallery element
  const basemapGallery = document.querySelector("arcgis-basemap-gallery");

  // set the source from a portal group containing basemaps with different projections
  basemapGallery.source = new PortalBasemapsSource({
    // portal: new Portal(...) // default is ArcGIS Online
    query: { id: "bdb9d65e0b5c480c8dcc6916e7f4e099" }
  });
</script>

state

readonly Property

Type: BasemapGalleryViewModelState

The current state of the component.

Default value: "disabled"

view

Property

Type: MapViewOrSceneView | null | undefined

The view associated with the component.

Note: The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this view property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-basemap-gallery component will be associated with a map or scene component rather than using the view property.

Methods

Method	Signature
componentOnReady inherited	componentOnReady(): Promise<this>
destroy	destroy(): Promise<void>

componentOnReady

inherited Method

Signature: componentOnReady (): Promise<this>

Inherited from: PublicLitElement

Creates a promise that resolves once the component is fully loaded.

Returns: Promise<this>

Example

const arcgisBasemapGallery = document.querySelector("arcgis-basemap-gallery");
document.body.append(arcgisBasemapGallery);
await arcgisBasemapGallery.componentOnReady();
console.log("arcgis-basemap-gallery is ready to go!");

destroy

Method

Signature: destroy (): Promise<void>

Permanently destroy the component.

Returns: Promise<void>

Events

Name	Type
arcgisPropertyChange	CustomEvent<{ name: "activeBasemap" \| "state"; }>
arcgisReady	CustomEvent<void>

arcgisPropertyChange

Event

arcgisPropertyChange: CustomEvent<{ name: "activeBasemap" | "state"; }>

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

arcgisReady

Event

arcgisReady: CustomEvent<void>

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