dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components.Widgets
LayerListWidget Class
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Core.Components.Widgets.LayerListWidget.html”>GeoBlazor Docs</a> The LayerList widget provides a way to display a list of layers, and switch on/off their visibility. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html”>ArcGIS Maps SDK for JavaScript</a>
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<bool>, Nullable<bool>, string, string, Nullable<double>, string, LayerListKnowledgeGraphOptions, string, Func<ListItem,Task<ListItem>>, Nullable<double>, Nullable<double>, IReadOnlyList<ListItem>, Nullable<SelectionMode>, LayerListViewModel, Nullable<VisibilityAppearance>, 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
<a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html”>CatalogLayer</a> specific properties. default null <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#catalogOptions”>ArcGIS Maps SDK for JavaScript</a>
collapsed System.Nullable<System.Boolean>
Indicates whether the widget is collapsed. default false <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#collapsed”>ArcGIS Maps SDK for JavaScript</a>
dragEnabled System.Nullable<System.Boolean>
Indicates whether <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html”>list items</a> may be reordered within the list by dragging and dropping. default false <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#dragEnabled”>ArcGIS Maps SDK for JavaScript</a>
filterPlaceholder System.String
Placeholder text used in the filter input if <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#visibleElements”>visibleElements.filter</a> is true. default “” <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#filterPlaceholder”>ArcGIS Maps SDK for JavaScript</a>
filterText System.String
The value of the filter input if <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#visibleElements”>visibleElements.filter</a> is true. default “” <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#filterText”>ArcGIS Maps SDK for JavaScript</a>
headingLevel System.Nullable<System.Double>
Indicates the heading level to use for the heading of the widget. default 2 <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#headingLevel”>ArcGIS Maps SDK for JavaScript</a>
icon System.String
Icon which represents the widget. default null <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#icon”>ArcGIS Maps SDK for JavaScript</a>
knowledgeGraphOptions LayerListKnowledgeGraphOptions
<a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html”>KnowledgeGraphLayer</a> specific properties. default null <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#knowledgeGraphOptions”>ArcGIS Maps SDK for JavaScript</a>
label System.String
The widget’s label. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label”>ArcGIS Maps SDK for JavaScript</a>
listItemCreatedFunction System.Func<ListItem,System.Threading.Tasks.Task<ListItem>>
A function that executes each time a <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html”>ListItem</a> is created. default null <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#listItemCreatedFunction”>ArcGIS Maps SDK for JavaScript</a>
minDragEnabledItems System.Nullable<System.Double>
The minimum number of list items required to enable drag and drop reordering with <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#dragEnabled”>dragEnabled</a>. default 2 <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#minDragEnabledItems”>ArcGIS Maps SDK for JavaScript</a>
minFilterItems System.Nullable<System.Double>
The minimum number of list items required to display the visibleElements.filter input box. default 10 <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#minFilterItems”>ArcGIS Maps SDK for JavaScript</a>
selectedItems System.Collections.Generic.IReadOnlyList<ListItem>
A collection of selected <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html”>ListItem</a>s representing operational layers selected by the user. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#selectedItems”>ArcGIS Maps SDK for JavaScript</a>
selectionMode System.Nullable<SelectionMode>
Specifies the selection mode. default “none” <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#selectionMode”>ArcGIS Maps SDK for JavaScript</a>
viewModel LayerListViewModel
The view model for this widget. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#viewModel”>ArcGIS Maps SDK for JavaScript</a>
visibilityAppearance System.Nullable<VisibilityAppearance>
Determines the icons used to indicate visibility. default “default” <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#visibilityAppearance”>ArcGIS Maps SDK for JavaScript</a>
visibleElements LayerListVisibleElements
The visible elements that are displayed within the widget. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#visibleElements”>ArcGIS Maps SDK for JavaScript</a>
widgetId System.String
The unique ID assigned to the widget when the widget is created. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#id”>ArcGIS Maps SDK for JavaScript</a>
Properties
LayerListWidget.CatalogLayerList Property
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Core.Components.Widgets.LayerListWidget.html#layerlistwidgetcataloglayerlist-property”>GeoBlazor Docs</a> The <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList.html”>CatalogLayerList</a> widget instance that displays a catalog layer’s <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html#dynamicGroupLayer”>dynamic group layer</a>. default null <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#catalogLayerList”>ArcGIS Maps SDK for JavaScript</a>
public dymaptic.GeoBlazor.Core.Interfaces.ICatalogLayerListWidget? CatalogLayerList { get; }
Property Value
LayerListWidget.CatalogOptions Property
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Core.Components.Widgets.LayerListWidget.html#layerlistwidgetcatalogoptions-property”>GeoBlazor Docs</a><a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html”>CatalogLayer</a> specific properties. default null <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#catalogOptions”>ArcGIS Maps SDK for JavaScript</a>
public dymaptic.GeoBlazor.Core.Options.LayerListCatalogOptions? CatalogOptions { get; set; }
Property Value
LayerListWidget.Collapsed Property
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Core.Components.Widgets.LayerListWidget.html#layerlistwidgetcollapsed-property”>GeoBlazor Docs</a> Indicates whether the widget is collapsed. default false <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#collapsed”>ArcGIS Maps SDK for JavaScript</a>
public System.Nullable<bool> Collapsed { get; set; }
Property Value
System.Nullable<System.Boolean>
LayerListWidget.DragEnabled Property
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Core.Components.Widgets.LayerListWidget.html#layerlistwidgetdragenabled-property”>GeoBlazor Docs</a> Indicates whether <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html”>list items</a> may be reordered within the list by dragging and dropping. default false <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#dragEnabled”>ArcGIS Maps SDK for JavaScript</a>
public System.Nullable<bool> DragEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
LayerListWidget.FilterPlaceholder Property
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Core.Components.Widgets.LayerListWidget.html#layerlistwidgetfilterplaceholder-property”>GeoBlazor Docs</a> Placeholder text used in the filter input if <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#visibleElements”>visibleElements.filter</a> is true. default “” <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#filterPlaceholder”>ArcGIS Maps SDK for JavaScript</a>
public string? FilterPlaceholder { get; set; }
Property Value
LayerListWidget.FilterPredicate Property
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Core.Components.Widgets.LayerListWidget.html#layerlistwidgetfilterpredicate-property”>GeoBlazor Docs</a> Specifies a function to handle filtering <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html”>list items</a>. default null <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#filterPredicate”>ArcGIS Maps SDK for JavaScript</a>
public dymaptic.GeoBlazor.Core.Functions.LayerListFilterPredicate? FilterPredicate { get; set; }
Property Value
LayerListFilterPredicate(ListItem)
LayerListWidget.FilterText Property
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Core.Components.Widgets.LayerListWidget.html#layerlistwidgetfiltertext-property”>GeoBlazor Docs</a> The value of the filter input if <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#visibleElements”>visibleElements.filter</a> is true. default “” <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#filterText”>ArcGIS Maps SDK for JavaScript</a>
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
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Core.Components.Widgets.LayerListWidget.html#layerlistwidgetheadinglevel-property”>GeoBlazor Docs</a> Indicates the heading level to use for the heading of the widget. default 2 <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#headingLevel”>ArcGIS Maps SDK for JavaScript</a>
public System.Nullable<double> HeadingLevel { get; set; }
Property Value
System.Nullable<System.Double>
LayerListWidget.KnowledgeGraphOptions Property
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Core.Components.Widgets.LayerListWidget.html#layerlistwidgetknowledgegraphoptions-property”>GeoBlazor Docs</a><a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html”>KnowledgeGraphLayer</a> specific properties. default null <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#knowledgeGraphOptions”>ArcGIS Maps SDK for JavaScript</a>
public dymaptic.GeoBlazor.Core.Options.LayerListKnowledgeGraphOptions? KnowledgeGraphOptions { get; set; }
Property Value
LayerListKnowledgeGraphOptions
LayerListWidget.MinDragEnabledItems Property
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Core.Components.Widgets.LayerListWidget.html#layerlistwidgetmindragenableditems-property”>GeoBlazor Docs</a> The minimum number of list items required to enable drag and drop reordering with <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#dragEnabled”>dragEnabled</a>. default 2 <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#minDragEnabledItems”>ArcGIS Maps SDK for JavaScript</a>
public System.Nullable<double> MinDragEnabledItems { get; set; }
Property Value
System.Nullable<System.Double>
LayerListWidget.MinFilterItems Property
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Core.Components.Widgets.LayerListWidget.html#layerlistwidgetminfilteritems-property”>GeoBlazor Docs</a> The minimum number of list items required to display the visibleElements.filter input box. default 10 <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#minFilterItems”>ArcGIS Maps SDK for JavaScript</a>
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 target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Core.Components.Widgets.LayerListWidget.html#layerlistwidgetopenedlayers-property”>GeoBlazor Docs</a> A collection of <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html”>Layer</a>s that are opened in a <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#catalogLayerList”>catalogLayerList</a> or <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#tableList”>tableList</a> flow item. default [] <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#openedLayers”>ArcGIS Maps SDK for JavaScript</a>
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Layers.Layer>? OpenedLayers { get; }
Property Value
System.Collections.Generic.IReadOnlyList<Layer>
LayerListWidget.OperationalItems Property
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Core.Components.Widgets.LayerListWidget.html#layerlistwidgetoperationalitems-property”>GeoBlazor Docs</a> A collection of <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html”>ListItem</a>s representing operational layers. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#operationalItems”>ArcGIS Maps SDK for JavaScript</a>
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.ListItem>? OperationalItems { get; }
Property Value
System.Collections.Generic.IReadOnlyList<ListItem>
LayerListWidget.SelectedItems Property
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Core.Components.Widgets.LayerListWidget.html#layerlistwidgetselecteditems-property”>GeoBlazor Docs</a> A collection of selected <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html”>ListItem</a>s representing operational layers selected by the user. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#selectedItems”>ArcGIS Maps SDK for JavaScript</a>
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.ListItem>? SelectedItems { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<ListItem>
LayerListWidget.SelectionMode Property
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Core.Components.Widgets.LayerListWidget.html#layerlistwidgetselectionmode-property”>GeoBlazor Docs</a> Specifies the selection mode. default “none” <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#selectionMode”>ArcGIS Maps SDK for JavaScript</a>
public System.Nullable<dymaptic.GeoBlazor.Core.Enums.SelectionMode> SelectionMode { get; set; }
Property Value
System.Nullable<SelectionMode>
LayerListWidget.TableList Property
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Core.Components.Widgets.LayerListWidget.html#layerlistwidgettablelist-property”>GeoBlazor Docs</a> The <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html”>TableList</a> widget instance that displays the tables associated with a <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html”>KnowledgeGraphLayer</a>. default null <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#tableList”>ArcGIS Maps SDK for JavaScript</a>
public dymaptic.GeoBlazor.Core.Interfaces.ITableListWidget? TableList { get; }
Property Value
LayerListWidget.Type Property
The type of widget
public override dymaptic.GeoBlazor.Core.Enums.WidgetType Type { get; }
Property Value
LayerListWidget.ViewModel Property
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Core.Components.Widgets.LayerListWidget.html#layerlistwidgetviewmodel-property”>GeoBlazor Docs</a> The view model for this widget. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#viewModel”>ArcGIS Maps SDK for JavaScript</a>
public dymaptic.GeoBlazor.Core.Components.LayerListViewModel? ViewModel { get; set; }
Property Value
LayerListWidget.VisibilityAppearance Property
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Core.Components.Widgets.LayerListWidget.html#layerlistwidgetvisibilityappearance-property”>GeoBlazor Docs</a> Determines the icons used to indicate visibility. default “default” <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#visibilityAppearance”>ArcGIS Maps SDK for JavaScript</a>
public System.Nullable<dymaptic.GeoBlazor.Core.Enums.VisibilityAppearance> VisibilityAppearance { get; set; }
Property Value
System.Nullable<VisibilityAppearance>
LayerListWidget.VisibleElements Property
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Core.Components.Widgets.LayerListWidget.html#layerlistwidgetvisibleelements-property”>GeoBlazor Docs</a> The visible elements that are displayed within the widget. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#visibleElements”>ArcGIS Maps SDK for JavaScript</a>
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<bool>) 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<bool>) 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<double>) 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<double>) 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<double>) 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<ListItem>) 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<SelectionMode>) 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<VisibilityAppearance>) 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
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Core.Components.Widgets.LayerListWidget.html#layerlistwidgettriggeraction-method”>GeoBlazor Docs</a> Triggers the <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#event-trigger-action”>trigger-action</a> event and executes the given <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html”>action</a> or <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html”>action toggle</a>. param item An item associated with the action. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#triggerAction”>ArcGIS Maps SDK for JavaScript</a>
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()