BasemapGallery

BasemapGallery displays a collection of basemaps from ArcGIS Online, a user-defined portal, or a custom collection. When a basemap is selected from the gallery, the basemap used in the connected GeoModel is replaced.

NOTE: BasemapGallery uses metered ArcGIS basemaps by default, so you will need to configure an API key. See Security and authentication documentation for more information.

Features

BasemapGallery:

• Can be configured to use a list, grid, or automatic layout. When using an automatic layout, list or grid presentation is chosen based on a defined width threshold.
  • Note: Grid layout is not supported on MAUI WinUI. Regardless of settings, the list layout will always be used.
• Shows basemaps from a portal, and allows manually adding and removing basemaps from the collection.
• Shows a representation of the map or scene's current basemap if that basemap exists in the gallery.
• Shows a name and thumbnail for each basemap.
• Shows a tooltip on hover on WPF and UWP.
• Supports templating.

Key properties

BasemapGallery exposes the following properties:

• GeoModel - References the connected Map or Scene (optional).
• Portal - Controls which portal is used to find basemaps. Setting the portal will reset the basemap collection.
• AvailableBasemaps - Collection of basemaps being shown.

The following properties enable customization of the gallery's appearance:

• GalleryViewStyle - Controls whether the gallery is displayed as a list or a grid.
• GridItemTemplate - Template used to display basemaps when using a grid presentation.
• ListItemTemplate - Template used to display basemaps when using a list presentation.
• ListItemContainerStyle - Container style used when displaying items as a list. Does not apply to MAUI.
• GridItemContainerStyle - Container style used when displaying items as a grid. Does not apply to MAUI.

Usage

Ensure that your GeoModel is not null before selecting a basemap with the BasemapGallery.

.NET MAUI:

<Grid xmlns:esri="http://schemas.esri.com/arcgis/runtime/2013"
      ColumnDefinitions="*,300">
    <esri:MapView x:Name="MyMapView" />
    <esri:BasemapGallery Grid.Column="1" 
                         GeoModel="{Binding Source={x:Reference MyMapView}, Path=Map}" />
</Grid>

UWP/WinUI:

<Grid xmlns:esri="using:Esri.ArcGISRuntime.UI.Controls"
      xmlns:toolkit="using:Esri.ArcGISRuntime.Toolkit.UI.Controls">
    <Grid.ColumnDefinitions>
        <ColumnDefinition Width="*" />
        <ColumnDefinition Width="300" />
    </Grid.ColumnDefinitions>
    <esri:MapView x:Name="MyMapView" />
    <toolkit:BasemapGallery Grid.Column="1"
                            GeoModel="{Binding ElementName=MyMapView, Path=Map}" />
</Grid>

WPF:

<Grid xmlns:esri="http://schemas.esri.com/arcgis/runtime/2013">
    <Grid.ColumnDefinitions>
        <ColumnDefinition Width="*" />
        <ColumnDefinition Width="300" />
    </Grid.ColumnDefinitions>
    <esri:MapView x:Name="MyMapView" />
    <esri:BasemapGallery Grid.Column="1"
                         GeoModel="{Binding ElementName=MyMapView, Path=Map}" />
</Grid>