dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components.Widgets
LayerListWidget Class
The LayerList widget provides a way to display a list of layers, and switch on/off their visibility.
ArcGIS Maps SDK for JavaScript
public class LayerListWidget : dymaptic.GeoBlazor.Core.Components.Widgets.Widget
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 Widget 🡒 LayerListWidget
Constructors
LayerListWidget() Constructor
Parameterless constructor for use as a Razor Component.
public LayerListWidget();
LayerListWidget(LayerListCatalogOptions, Nullable, Nullable, string, string, Nullable, string, LayerListKnowledgeGraphOptions, string, Func<ListItem,Task>, Nullable, Nullable, IReadOnlyList, Nullable, LayerListViewModel, Nullable, LayerListVisibleElements, string) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public LayerListWidget(dymaptic.GeoBlazor.Core.Options.LayerListCatalogOptions? catalogOptions=null, System.Nullable<bool> collapsed=null, System.Nullable<bool> dragEnabled=null, string? filterPlaceholder=null, string? filterText=null, System.Nullable<double> headingLevel=null, string? icon=null, dymaptic.GeoBlazor.Core.Options.LayerListKnowledgeGraphOptions? knowledgeGraphOptions=null, string? label=null, System.Func<dymaptic.GeoBlazor.Core.Components.ListItem,System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.ListItem>>? listItemCreatedFunction=null, System.Nullable<double> minDragEnabledItems=null, System.Nullable<double> minFilterItems=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.ListItem>? selectedItems=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.SelectionMode> selectionMode=null, dymaptic.GeoBlazor.Core.Components.LayerListViewModel? viewModel=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.VisibilityAppearance> visibilityAppearance=null, dymaptic.GeoBlazor.Core.Components.LayerListVisibleElements? visibleElements=null, string? widgetId=null);
Parameters
catalogOptions LayerListCatalogOptions
CatalogLayer specific properties.
default null
ArcGIS Maps SDK for JavaScript
collapsed System.Nullable<System.Boolean>
Indicates whether the widget is collapsed.
default false
ArcGIS Maps SDK for JavaScript
dragEnabled System.Nullable<System.Boolean>
Indicates whether list items may be reordered within the list by dragging and dropping.
default false
ArcGIS Maps SDK for JavaScript
filterPlaceholder System.String
Placeholder text used in the filter input if visibleElements.filter is true.
default “”
ArcGIS Maps SDK for JavaScript
filterText System.String
The value of the filter input if visibleElements.filter is true.
default “”
ArcGIS Maps SDK for JavaScript
headingLevel System.Nullable<System.Double>
Indicates the heading level to use for the heading of the widget.
default 2
ArcGIS Maps SDK for JavaScript
icon System.String
Icon which represents the widget.
default null
ArcGIS Maps SDK for JavaScript
knowledgeGraphOptions LayerListKnowledgeGraphOptions
KnowledgeGraphLayer specific properties.
default null
ArcGIS Maps SDK for JavaScript
label System.String
The widget’s label.
ArcGIS Maps SDK for JavaScript
listItemCreatedFunction System.Func<ListItem,System.Threading.Tasks.Task<ListItem>>
A function that executes each time a ListItem is created.
default null
ArcGIS Maps SDK for JavaScript
minDragEnabledItems System.Nullable<System.Double>
The minimum number of list items required to enable drag and drop reordering with dragEnabled.
default 2
ArcGIS Maps SDK for JavaScript
minFilterItems System.Nullable<System.Double>
The minimum number of list items required to display the visibleElements.filter input box.
default 10
ArcGIS Maps SDK for JavaScript
selectedItems System.Collections.Generic.IReadOnlyList<ListItem>
A collection of selected ListItems representing operational layers selected by the user.
ArcGIS Maps SDK for JavaScript
selectionMode System.Nullable<SelectionMode>
Specifies the selection mode.
default “none”
ArcGIS Maps SDK for JavaScript
viewModel LayerListViewModel
The view model for this widget.
ArcGIS Maps SDK for JavaScript
visibilityAppearance System.Nullable<VisibilityAppearance>
Determines the icons used to indicate visibility.
default “default”
ArcGIS Maps SDK for JavaScript
visibleElements LayerListVisibleElements
The visible elements that are displayed within the widget.
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
LayerListWidget.CatalogLayerList Property
The CatalogLayerList widget instance that displays a catalog layer’s dynamic group layer.
default null
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Interfaces.ICatalogLayerListWidget? CatalogLayerList { get; set; }
Property Value
LayerListWidget.CatalogOptions Property
GeoBlazor DocsCatalogLayer specific properties.
default null
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Options.LayerListCatalogOptions? CatalogOptions { get; set; }
Property Value
LayerListWidget.Collapsed Property
Indicates whether the widget is collapsed.
default false
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> Collapsed { get; set; }
Property Value
System.Nullable<System.Boolean>
LayerListWidget.DragEnabled Property
Indicates whether list items may be reordered within the list by dragging and dropping.
default false
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> DragEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
LayerListWidget.FilterPlaceholder Property
Placeholder text used in the filter input if visibleElements.filter is true.
default “”
ArcGIS Maps SDK for JavaScript
public string? FilterPlaceholder { get; set; }
Property Value
LayerListWidget.FilterPredicate Property
Specifies a function to handle filtering list items.
default null
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Functions.LayerListFilterPredicate? FilterPredicate { get; set; }
Property Value
LayerListFilterPredicate(ListItem)
LayerListWidget.FilterText Property
The value of the filter input if visibleElements.filter is true.
default “”
ArcGIS Maps SDK for JavaScript
public string? FilterText { get; set; }
Property Value
LayerListWidget.HasCustomHandler Property
A convenience property that signifies whether a custom OnListItemCreatedHandler was registered.
public bool HasCustomHandler { get; }
Property Value
LayerListWidget.HasFilterPredicate Property
A convenience property that signifies whether a custom FilterPredicate function was registered.
public bool HasFilterPredicate { get; }
Property Value
LayerListWidget.HeadingLevel Property
Indicates the heading level to use for the heading of the widget.
default 2
ArcGIS Maps SDK for JavaScript
public System.Nullable<double> HeadingLevel { get; set; }
Property Value
System.Nullable<System.Double>
LayerListWidget.KnowledgeGraphOptions Property
GeoBlazor DocsKnowledgeGraphLayer specific properties.
default null
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Options.LayerListKnowledgeGraphOptions? KnowledgeGraphOptions { get; set; }
Property Value
LayerListKnowledgeGraphOptions
LayerListWidget.MinDragEnabledItems Property
The minimum number of list items required to enable drag and drop reordering with dragEnabled.
default 2
ArcGIS Maps SDK for JavaScript
public System.Nullable<double> MinDragEnabledItems { get; set; }
Property Value
System.Nullable<System.Double>
LayerListWidget.MinFilterItems Property
The minimum number of list items required to display the visibleElements.filter input box.
default 10
ArcGIS Maps SDK for JavaScript
public System.Nullable<double> MinFilterItems { get; set; }
Property Value
System.Nullable<System.Double>
LayerListWidget.OnListItemCreatedHandler Property
A delegate to implement a custom handler for setting up each ListItem.
Function must take in a ListItem and return a Task with the same (updated) item.
public System.Func<dymaptic.GeoBlazor.Core.Components.ListItem,System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.ListItem>>? OnListItemCreatedHandler { get; set; }
Property Value
System.Func<ListItem,System.Threading.Tasks.Task<ListItem>>
LayerListWidget.OnTriggerAction Property
Event Listener for TriggerAction.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Core.Events.LayerListTriggerActionEvent> OnTriggerAction { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<LayerListTriggerActionEvent>
LayerListWidget.OpenedLayers Property
A collection of Layers that are opened
in a catalogLayerList or tableList flow item.
default []
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Layers.Layer>? OpenedLayers { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<Layer>
LayerListWidget.OperationalItems Property
A collection of ListItems representing operational layers.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.ListItem>? OperationalItems { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<ListItem>
LayerListWidget.SelectedItems Property
A collection of selected ListItems representing operational layers
selected by the user.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.ListItem>? SelectedItems { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<ListItem>
LayerListWidget.SelectionMode Property
Specifies the selection mode.
default “none”
ArcGIS Maps SDK for JavaScript
public System.Nullable<dymaptic.GeoBlazor.Core.Enums.SelectionMode> SelectionMode { get; set; }
Property Value
System.Nullable<SelectionMode>
LayerListWidget.TableList Property
The TableList widget instance that displays the tables associated with a KnowledgeGraphLayer.
default null
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Interfaces.ITableListWidget? TableList { get; set; }
Property Value
LayerListWidget.Type Property
The type of widget
public override dymaptic.GeoBlazor.Core.Enums.WidgetType Type { get; }
Property Value
LayerListWidget.ViewModel Property
The view model for this widget.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.LayerListViewModel? ViewModel { get; set; }
Property Value
LayerListWidget.VisibilityAppearance Property
Determines the icons used to indicate visibility.
default “default”
ArcGIS Maps SDK for JavaScript
public System.Nullable<dymaptic.GeoBlazor.Core.Enums.VisibilityAppearance> VisibilityAppearance { get; set; }
Property Value
System.Nullable<VisibilityAppearance>
LayerListWidget.VisibleElements Property
The visible elements that are displayed within the widget.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.LayerListVisibleElements? VisibleElements { get; set; }
Property Value
Methods
LayerListWidget.AddToSelectedItems(ListItem[]) Method
Asynchronously adds elements to the SelectedItems property.
public System.Threading.Tasks.Task AddToSelectedItems(params dymaptic.GeoBlazor.Core.Components.ListItem[] values);
Parameters
The elements to add.
Returns
LayerListWidget.GetCatalogLayerList() Method
Asynchronously retrieve the current value of the CatalogLayerList property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Interfaces.ICatalogLayerListWidget?> GetCatalogLayerList();
Returns
System.Threading.Tasks.Task<ICatalogLayerListWidget>
LayerListWidget.GetCatalogOptions() Method
Asynchronously retrieve the current value of the CatalogOptions property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Options.LayerListCatalogOptions?> GetCatalogOptions();
Returns
System.Threading.Tasks.Task<LayerListCatalogOptions>
LayerListWidget.GetCollapsed() Method
Asynchronously retrieve the current value of the Collapsed property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetCollapsed();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
LayerListWidget.GetDragEnabled() Method
Asynchronously retrieve the current value of the DragEnabled property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetDragEnabled();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
LayerListWidget.GetFilterPlaceholder() Method
Asynchronously retrieve the current value of the FilterPlaceholder property.
public System.Threading.Tasks.Task<string?> GetFilterPlaceholder();
Returns
System.Threading.Tasks.Task<System.String>
LayerListWidget.GetFilterText() Method
Asynchronously retrieve the current value of the FilterText property.
public System.Threading.Tasks.Task<string?> GetFilterText();
Returns
System.Threading.Tasks.Task<System.String>
LayerListWidget.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>>
LayerListWidget.GetKnowledgeGraphOptions() Method
Asynchronously retrieve the current value of the KnowledgeGraphOptions property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Options.LayerListKnowledgeGraphOptions?> GetKnowledgeGraphOptions();
Returns
System.Threading.Tasks.Task<LayerListKnowledgeGraphOptions>
LayerListWidget.GetMinDragEnabledItems() Method
Asynchronously retrieve the current value of the MinDragEnabledItems property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetMinDragEnabledItems();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
LayerListWidget.GetMinFilterItems() Method
Asynchronously retrieve the current value of the MinFilterItems property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetMinFilterItems();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
LayerListWidget.GetOpenedLayers() Method
Asynchronously retrieve the current value of the OpenedLayers property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Layers.Layer>?> GetOpenedLayers();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Layer>>
LayerListWidget.GetOperationalItems() Method
Asynchronously retrieve the current value of the OperationalItems property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.ListItem>?> GetOperationalItems();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<ListItem>>
LayerListWidget.GetSelectedItems() Method
Asynchronously retrieve the current value of the SelectedItems property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.ListItem>?> GetSelectedItems();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<ListItem>>
LayerListWidget.GetSelectionMode() Method
Asynchronously retrieve the current value of the SelectionMode property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.SelectionMode>> GetSelectionMode();
Returns
System.Threading.Tasks.Task<System.Nullable<SelectionMode>>
LayerListWidget.GetTableList() Method
Asynchronously retrieve the current value of the TableList property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Interfaces.ITableListWidget?> GetTableList();
Returns
System.Threading.Tasks.Task<ITableListWidget>
LayerListWidget.GetViewModel() Method
Asynchronously retrieve the current value of the ViewModel property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.LayerListViewModel?> GetViewModel();
Returns
System.Threading.Tasks.Task<LayerListViewModel>
LayerListWidget.GetVisibilityAppearance() Method
Asynchronously retrieve the current value of the VisibilityAppearance property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.VisibilityAppearance>> GetVisibilityAppearance();
Returns
System.Threading.Tasks.Task<System.Nullable<VisibilityAppearance>>
LayerListWidget.GetVisibleElements() Method
Asynchronously retrieve the current value of the VisibleElements property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.LayerListVisibleElements?> GetVisibleElements();
Returns
System.Threading.Tasks.Task<LayerListVisibleElements>
LayerListWidget.OnJsFilterPredicate(ListItem) Method
JS-invokable method that triggers the FilterPredicate function.
Should not be called by consuming code.
public System.Threading.Tasks.Task OnJsFilterPredicate(dymaptic.GeoBlazor.Core.Components.ListItem item);
Parameters
item ListItem
Returns
LayerListWidget.OnJsTriggerAction(IJSStreamReference) Method
JavaScript-Invokable Method for internal use only.
public System.Threading.Tasks.Task OnJsTriggerAction(Microsoft.JSInterop.IJSStreamReference jsStreamRef);
Parameters
jsStreamRef Microsoft.JSInterop.IJSStreamReference
Returns
LayerListWidget.OnListItemCreated(ListItem) Method
A JavaScript invokable method that is triggered whenever a ListItem is created and a handler is attached.
public System.Threading.Tasks.Task<object?> OnListItemCreated(dymaptic.GeoBlazor.Core.Components.ListItem item);
Parameters
item ListItem
The ListItem from the original source.
Returns
System.Threading.Tasks.Task<System.Object>
Returns the modified ListItem
LayerListWidget.RemoveFromSelectedItems(ListItem[]) Method
Asynchronously remove an element from the SelectedItems property.
public System.Threading.Tasks.Task RemoveFromSelectedItems(params dymaptic.GeoBlazor.Core.Components.ListItem[] values);
Parameters
The elements to remove.
Returns
LayerListWidget.SetCatalogOptions(LayerListCatalogOptions) Method
Asynchronously set the value of the CatalogOptions property after render.
public System.Threading.Tasks.Task SetCatalogOptions(dymaptic.GeoBlazor.Core.Options.LayerListCatalogOptions? value);
Parameters
value LayerListCatalogOptions
The value to set.
Returns
LayerListWidget.SetCollapsed(Nullable) Method
Asynchronously set the value of the Collapsed property after render.
public System.Threading.Tasks.Task SetCollapsed(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
LayerListWidget.SetDragEnabled(Nullable) Method
Asynchronously set the value of the DragEnabled property after render.
public System.Threading.Tasks.Task SetDragEnabled(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
LayerListWidget.SetFilterPlaceholder(string) Method
Asynchronously set the value of the FilterPlaceholder property after render.
public System.Threading.Tasks.Task SetFilterPlaceholder(string? value);
Parameters
value System.String
The value to set.
Returns
LayerListWidget.SetFilterText(string) Method
Asynchronously set the value of the FilterText property after render.
public System.Threading.Tasks.Task SetFilterText(string? value);
Parameters
value System.String
The value to set.
Returns
LayerListWidget.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
LayerListWidget.SetKnowledgeGraphOptions(LayerListKnowledgeGraphOptions) Method
Asynchronously set the value of the KnowledgeGraphOptions property after render.
public System.Threading.Tasks.Task SetKnowledgeGraphOptions(dymaptic.GeoBlazor.Core.Options.LayerListKnowledgeGraphOptions? value);
Parameters
value LayerListKnowledgeGraphOptions
The value to set.
Returns
LayerListWidget.SetMinDragEnabledItems(Nullable) Method
Asynchronously set the value of the MinDragEnabledItems property after render.
public System.Threading.Tasks.Task SetMinDragEnabledItems(System.Nullable<double> value);
Parameters
value System.Nullable<System.Double>
The value to set.
Returns
LayerListWidget.SetMinFilterItems(Nullable) Method
Asynchronously set the value of the MinFilterItems property after render.
public System.Threading.Tasks.Task SetMinFilterItems(System.Nullable<double> value);
Parameters
value System.Nullable<System.Double>
The value to set.
Returns
LayerListWidget.SetSelectedItems(IReadOnlyList) Method
Asynchronously set the value of the SelectedItems property after render.
public System.Threading.Tasks.Task SetSelectedItems(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.ListItem>? value);
Parameters
value System.Collections.Generic.IReadOnlyList<ListItem>
The value to set.
Returns
LayerListWidget.SetSelectionMode(Nullable) Method
Asynchronously set the value of the SelectionMode property after render.
public System.Threading.Tasks.Task SetSelectionMode(System.Nullable<dymaptic.GeoBlazor.Core.Enums.SelectionMode> value);
Parameters
value System.Nullable<SelectionMode>
The value to set.
Returns
LayerListWidget.SetViewModel(LayerListViewModel) Method
Asynchronously set the value of the ViewModel property after render.
public System.Threading.Tasks.Task SetViewModel(dymaptic.GeoBlazor.Core.Components.LayerListViewModel? value);
Parameters
value LayerListViewModel
The value to set.
Returns
LayerListWidget.SetVisibilityAppearance(Nullable) Method
Asynchronously set the value of the VisibilityAppearance property after render.
public System.Threading.Tasks.Task SetVisibilityAppearance(System.Nullable<dymaptic.GeoBlazor.Core.Enums.VisibilityAppearance> value);
Parameters
value System.Nullable<VisibilityAppearance>
The value to set.
Returns
LayerListWidget.SetVisibleElements(LayerListVisibleElements) Method
Asynchronously set the value of the VisibleElements property after render.
public System.Threading.Tasks.Task SetVisibleElements(dymaptic.GeoBlazor.Core.Components.LayerListVisibleElements? value);
Parameters
value LayerListVisibleElements
The value to set.
Returns
LayerListWidget.TriggerAction(ActionBase, ListItem) Method
Triggers the trigger-action event and executes
the given action or action toggle.
param item An item associated with the action.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task TriggerAction(dymaptic.GeoBlazor.Core.Components.ActionBase action, dymaptic.GeoBlazor.Core.Components.ListItem item);
Parameters
action ActionBase
The action to execute.
item ListItem
An item associated with the action.
Returns
LayerListWidget.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()