dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components.Widgets
BasemapGalleryWidget Class
The BasemapGallery widget displays a collection of images representing basemaps from ArcGIS.com or a user-defined set
of map or image services.
ArcGIS Maps SDK for JavaScript
public class BasemapGalleryWidget : dymaptic.GeoBlazor.Core.Components.Widgets.Widget
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 Widget 🡒 BasemapGalleryWidget
Constructors
BasemapGalleryWidget() Constructor
Parameterless constructor for use as a Razor Component.
public BasemapGalleryWidget();
BasemapGalleryWidget(Basemap, string, Nullable, Nullable, string, string, MapView, Nullable, IBasemapGalleryWidgetSource, BasemapGalleryViewModel, Nullable, string) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public BasemapGalleryWidget(dymaptic.GeoBlazor.Core.Components.Basemap? activeBasemap=null, string? containerId=null, System.Nullable<bool> disabled=null, System.Nullable<double> headingLevel=null, string? icon=null, string? label=null, dymaptic.GeoBlazor.Core.Components.Views.MapView? mapView=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.OverlayPosition> position=null, dymaptic.GeoBlazor.Core.Interfaces.IBasemapGalleryWidgetSource? source=null, dymaptic.GeoBlazor.Core.Components.BasemapGalleryViewModel? viewModel=null, System.Nullable<bool> visible=null, string? widgetId=null);
Parameters
activeBasemap Basemap
The map’s basemap.
ArcGIS Maps SDK for JavaScript
containerId System.String
The id of an external HTML Element (div). If provided, the widget will be placed inside that element, instead of on the map.
disabled System.Nullable<System.Boolean>
When true, sets the widget to a disabled state so the user cannot interact with it.
default false
ArcGIS Maps SDK for JavaScript
headingLevel System.Nullable<System.Double>
Indicates the heading level to use for the message “No basemaps available” when no basemaps
are available in the BasemapGallery.
default 2
ArcGIS Maps SDK for JavaScript
icon System.String
Icon which represents the widget.
default “basemap”
ArcGIS Maps SDK for JavaScript
label System.String
The widget’s default label.
ArcGIS Maps SDK for JavaScript
mapView MapView
If the Widget is defined outside of the MapView, this link is required to connect them together.
position System.Nullable<OverlayPosition>
The position of the widget in relation to the map view.
source IBasemapGalleryWidgetSource
The source for basemaps that the widget will display.
ArcGIS Maps SDK for JavaScript
viewModel BasemapGalleryViewModel
The view model for this widget.
ArcGIS Maps SDK for JavaScript
visible System.Nullable<System.Boolean>
Indicates whether the widget is visible.
default true
ArcGIS Maps SDK for JavaScript
widgetId System.String
The unique ID assigned to the widget when the widget is created.
ArcGIS Maps SDK for JavaScript
Properties
BasemapGalleryWidget.ActiveBasemap Property
The map’s basemap.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.Basemap? ActiveBasemap { get; set; }
Property Value
BasemapGalleryWidget.Disabled Property
When true, sets the widget to a disabled state so the user cannot interact with it.
default false
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> Disabled { get; set; }
Property Value
System.Nullable<System.Boolean>
BasemapGalleryWidget.HeadingLevel Property
Indicates the heading level to use for the message “No basemaps available” when no basemaps
are available in the BasemapGallery.
default 2
ArcGIS Maps SDK for JavaScript
public System.Nullable<double> HeadingLevel { get; set; }
Property Value
System.Nullable<System.Double>
BasemapGalleryWidget.Source Property
The source for basemaps that the widget will display.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Interfaces.IBasemapGalleryWidgetSource? Source { get; set; }
Property Value
BasemapGalleryWidget.Title Property
The title to query against the source.
public string? Title { get; set; }
Property Value
Remarks
Use either Title or PortalBasemapsSource to define the query.
BasemapGalleryWidget.Type Property
The type of widget
public override dymaptic.GeoBlazor.Core.Enums.WidgetType Type { get; }
Property Value
BasemapGalleryWidget.ViewModel Property
The view model for this widget.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.BasemapGalleryViewModel? ViewModel { get; set; }
Property Value
Methods
BasemapGalleryWidget.GetActiveBasemap() Method
Asynchronously retrieve the current value of the ActiveBasemap property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Basemap?> GetActiveBasemap();
Returns
System.Threading.Tasks.Task<Basemap>
BasemapGalleryWidget.GetDisabled() Method
Asynchronously retrieve the current value of the Disabled property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetDisabled();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
BasemapGalleryWidget.GetHeadingLevel() Method
Asynchronously retrieve the current value of the HeadingLevel property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetHeadingLevel();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
BasemapGalleryWidget.GetSource() Method
Asynchronously retrieve the current value of the Source property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Interfaces.IBasemapGalleryWidgetSource?> GetSource();
Returns
System.Threading.Tasks.Task<IBasemapGalleryWidgetSource>
BasemapGalleryWidget.GetViewModel() Method
Asynchronously retrieve the current value of the ViewModel property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.BasemapGalleryViewModel?> GetViewModel();
Returns
System.Threading.Tasks.Task<BasemapGalleryViewModel>
BasemapGalleryWidget.RegisterChildComponent(MapComponent) Method
Called from dymaptic.GeoBlazor.Core.Components.MapComponent.OnInitializedAsync to “Register” the current component with its parent.
public override System.Threading.Tasks.Task RegisterChildComponent(dymaptic.GeoBlazor.Core.Components.MapComponent child);
Parameters
child MapComponent
The calling, child component to register
Returns
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.SetActiveBasemap(Basemap) Method
Asynchronously set the value of the ActiveBasemap property after render.
public System.Threading.Tasks.Task SetActiveBasemap(dymaptic.GeoBlazor.Core.Components.Basemap? value);
Parameters
value Basemap
The value to set.
Returns
BasemapGalleryWidget.SetDisabled(Nullable) Method
Asynchronously set the value of the Disabled property after render.
public System.Threading.Tasks.Task SetDisabled(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
BasemapGalleryWidget.SetHeadingLevel(Nullable) Method
Asynchronously set the value of the HeadingLevel property after render.
public System.Threading.Tasks.Task SetHeadingLevel(System.Nullable<double> value);
Parameters
value System.Nullable<System.Double>
The value to set.
Returns
BasemapGalleryWidget.SetSource(IBasemapGalleryWidgetSource) Method
Asynchronously set the value of the Source property after render.
public System.Threading.Tasks.Task SetSource(dymaptic.GeoBlazor.Core.Interfaces.IBasemapGalleryWidgetSource? value);
Parameters
value IBasemapGalleryWidgetSource
The value to set.
Returns
BasemapGalleryWidget.SetViewModel(BasemapGalleryViewModel) Method
Asynchronously set the value of the ViewModel property after render.
public System.Threading.Tasks.Task SetViewModel(dymaptic.GeoBlazor.Core.Components.BasemapGalleryViewModel? value);
Parameters
value BasemapGalleryViewModel
The value to set.
Returns
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
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.
BasemapGalleryWidget.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()