Skip to main content Link Menu Expand (external link) Document Search Copy Copied

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
  
JS API

</a>

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.OnAfterRenderAsync(System.Boolean) 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.

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

BasemapGalleryWidget.ValidateRequiredChildren() Method

When a MapView is prepared to render, this will check to make sure that all properties with the
RequiredPropertyAttribute are provided.

public override void ValidateRequiredChildren();

Exceptions

MissingRequiredChildElementException
The consumer needs to provide the missing child component

MissingRequiredOptionsChildElementException
The consumer needs to provide ONE of the options of child components