layout: default title: BasemapGalleryWidget parent: Core Classes —

dymaptic.GeoBlazor.Core

dymaptic.GeoBlazor.Core.Components.Widgets

BasemapGalleryWidget Class

The BasemapGallery widget 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.
ArcGIS Maps SDK for JavaScript

public class BasemapGalleryWidget : dymaptic.GeoBlazor.Core.Components.Widgets.Widget

Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 Widget 🡒 BasemapGalleryWidget

Properties

BasemapGalleryWidget.PortalBasemapsSource Property

The source for basemaps that the widget will display.

public dymaptic.GeoBlazor.Core.Components.PortalBasemapsSource? PortalBasemapsSource { get; set; }

Property Value

PortalBasemapsSource

Remarks

Use either Title or PortalBasemapsSource to define the query.

BasemapGalleryWidget.Title Property

The title to query against the source.

public string? Title { get; set; }

Property Value

System.String

Remarks

Use either Title or PortalBasemapsSource to define the query.

BasemapGalleryWidget.WidgetType Property

The type of widget

public override string WidgetType { get; }

Property Value

System.String

Methods

BasemapGalleryWidget.RegisterChildComponent(MapComponent) Method

Called from dymaptic.GeoBlazor.Core.Components.MapComponent.OnInitializedAsync to “Register” the current component with it’s parent.

public override System.Threading.Tasks.Task RegisterChildComponent(dymaptic.GeoBlazor.Core.Components.MapComponent child);

Parameters

child MapComponent

The calling, child component to register

Returns

System.Threading.Tasks.Task

Exceptions

InvalidChildElementException
Throws if the current child is not a valid sub-component to the parent.

Remarks

This method is an implementation detail and should not be called directly by consumers. In future versions, this may be changed to an internal method. If you see no other way to register a child component, please open an issue on GitHub.

BasemapGalleryWidget.UnregisterChildComponent(MapComponent) Method

Undoes the “Registration” of a child with its parent.

public override System.Threading.Tasks.Task UnregisterChildComponent(dymaptic.GeoBlazor.Core.Components.MapComponent child);

Parameters

child MapComponent

The child to unregister

Returns

System.Threading.Tasks.Task

Remarks

This method is an implementation detail and should not be called directly by consumers. In future versions, this may be changed to an internal method.