Basemap Gallery

The map's current basemap.

Attribute

active-basemap

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

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

Attribute

disabled

Default value

false

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 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"

The component's default label.

Attribute

label

Default value

""

Replace localized message strings with your own strings.

Note: Individual message keys may change between releases.

Attribute

position

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

The source for basemaps that the component will display.

Examples

Set the source from a local basemap collection.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
<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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<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>

The current state of the component.

Attribute

state

Default value

"disabled"

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 Basemap Gallery component will be associated with a map or scene component rather than using the view property.

Create a promise that resolves once component is fully loaded.

Example

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

Returns

Promise<void>

Permanently destroy the component.

Returns

Promise<void>

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

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