layout: default title: BasemapLayerListWidget parent: Core Classes —
dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components.Widgets
BasemapLayerListWidget Class
The Basemap ListItem class represents two of the operational Items in the LayerList ViewModel. In the Basemap
LayerList widget UI, the list items represent any base or reference layers displayed in the view. To display the
ListItems as separate types, a developer will need to specify a base or reference. It provides access to the
associated layer’s properties, allows the developer to configure actions related to the layer, and allows the
developer to add content to the item related to the layer.
ArcGIS Maps SDK for JavaScript
public class BasemapLayerListWidget : dymaptic.GeoBlazor.Core.Components.Widgets.Widget
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 Widget 🡒 BasemapLayerListWidget
Properties
BasemapLayerListWidget.BaseLayerListWidgetObjectReference Property
The .Net object reference to this class for calling from JavaScript.
public Microsoft.JSInterop.DotNetObjectReference<dymaptic.GeoBlazor.Core.Components.Widgets.BasemapLayerListWidget> BaseLayerListWidgetObjectReference { get; }
Property Value
Microsoft.JSInterop.DotNetObjectReference<BasemapLayerListWidget>
BasemapLayerListWidget.BasemapTitle Property
The current basemap’s title.
public string? BasemapTitle { get; set; }
Property Value
BasemapLayerListWidget.EditingEnabled Property
Indicates whether the basemap’s title, layer order and layer grouping can be edited by the user. Any edits made will only be shown locally and will not be saved.
Default Value:false
public System.Nullable<bool> EditingEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
BasemapLayerListWidget.HasCustomBaseListHandler Property
A convenience property that signifies whether a custom OnBaseListItemCreatedHandler was registered.
public bool HasCustomBaseListHandler { get; }
Property Value
BasemapLayerListWidget.HasCustomReferenceListHandler Property
A convenience property that signifies whether a custom OnReferenceListItemCreatedHandler was
registered.
public bool HasCustomReferenceListHandler { get; }
Property Value
BasemapLayerListWidget.HeadingLevel Property
Indicates the heading level to use for the widget title (i.e. “Basemap”). By default, this is rendered as a level 2 heading (e.g. <h2>Basemap</h2>). Depending on the widget’s placement in your app, you may need to adjust this heading for proper semantics. This is important for meeting accessibility standards.
Default Value:2
public System.Nullable<int> HeadingLevel { get; set; }
Property Value
BasemapLayerListWidget.Label Property
The widget’s default label.
public string? Label { get; set; }
Property Value
BasemapLayerListWidget.MultipleSelectionEnabled Property
Indicates whether more than one list item may be selected by the user at a single time. Selected items are available in the selectedItems property.
Default Value:false
public System.Nullable<bool> MultipleSelectionEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
BasemapLayerListWidget.OnBaseListItemCreatedHandler Property
A delegate to implement a custom handler for setting up a base type ofListItem.
Function must take in a ListItem and return a Task with the designated base type of item.
public System.Func<dymaptic.GeoBlazor.Core.Components.Widgets.ListItem,System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Widgets.ListItem>>? OnBaseListItemCreatedHandler { get; set; }
Property Value
System.Func<ListItem,System.Threading.Tasks.Task<ListItem>>
BasemapLayerListWidget.OnReferenceListItemCreatedHandler Property
A delegate to implement a custom handler for setting up a reference type ofListItem.
Function must take in a ListItem and return a Task with the designated reference type of item.
public System.Func<dymaptic.GeoBlazor.Core.Components.Widgets.ListItem,System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Widgets.ListItem>>? OnReferenceListItemCreatedHandler { get; set; }
Property Value
System.Func<ListItem,System.Threading.Tasks.Task<ListItem>>
BasemapLayerListWidget.VisibleElements Property
The visible elements that are displayed within the widget. This property provides the ability to turn individual elements of the widget’s display on/off.
public dymaptic.GeoBlazor.Core.Components.Widgets.BasemapLayerListWidgetVisibleElements? VisibleElements { get; set; }
Property Value
BasemapLayerListWidgetVisibleElements
BasemapLayerListWidget.WidgetType Property
The type of widget
public override string WidgetType { get; }
Property Value
Methods
BasemapLayerListWidget.OnBaseListItemCreated(ListItem) Method
A JavaScript invokable method that is triggered whenever a base type ListItem is created and a handler is attached.
public System.Threading.Tasks.Task<object> OnBaseListItemCreated(dymaptic.GeoBlazor.Core.Components.Widgets.ListItem item);
Parameters
item ListItem
The ListItem from the original source.
Returns
System.Threading.Tasks.Task<System.Object>
Returns the modified base ListItem
Remarks
For internal use only. This returns an object simply for JavaScript serialization purposes.
BasemapLayerListWidget.OnReferenceListItemCreated(ListItem) Method
A JavaScript invokable method that is triggered whenever a reference type ListItem is created and a handler is
attached.
public System.Threading.Tasks.Task<object> OnReferenceListItemCreated(dymaptic.GeoBlazor.Core.Components.Widgets.ListItem item);
Parameters
item ListItem
The ListItem from the original source.
Returns
System.Threading.Tasks.Task<System.Object>
Returns the modified reference ListItem
BasemapLayerListWidget.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
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.
BasemapLayerListWidget.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.