GeoBlazor Pro
dymaptic.GeoBlazor.Pro
dymaptic.GeoBlazor.Pro.Components.Widgets
CatalogLayerListWidget Class
The CatalogLayerList widget provides a way to display and interact with CatalogLayers.
ArcGIS Maps SDK for JavaScript
public class CatalogLayerListWidget : dymaptic.GeoBlazor.Pro.Components.Widgets.ProWidget,
dymaptic.GeoBlazor.Core.Interfaces.ICatalogLayerListWidget,
dymaptic.GeoBlazor.Core.Interfaces.IMapComponent
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 dymaptic.GeoBlazor.Core.Components.MapComponent 🡒 dymaptic.GeoBlazor.Core.Components.Widgets.Widget 🡒 ProWidget 🡒 CatalogLayerListWidget
Implements dymaptic.GeoBlazor.Core.Interfaces.ICatalogLayerListWidget, dymaptic.GeoBlazor.Core.Interfaces.IMapComponent
Constructors
CatalogLayerListWidget() Constructor
Parameterless constructor for use as a Razor Component.
public CatalogLayerListWidget();
CatalogLayerListWidget(CatalogLayer, Nullable, string, string, Nullable, string, string, Func<ListItem,Task>, Nullable, IReadOnlyList, Nullable, CatalogLayerListViewModel, Nullable, CatalogLayerListVisibleElements, string) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public CatalogLayerListWidget(dymaptic.GeoBlazor.Pro.Components.Layers.CatalogLayer? catalogLayer=null, System.Nullable<bool> collapsed=null, string? filterPlaceholder=null, string? filterText=null, System.Nullable<double> headingLevel=null, string? icon=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> minFilterItems=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.ListItem>? selectedItems=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.SelectionMode> selectionMode=null, dymaptic.GeoBlazor.Pro.Components.CatalogLayerListViewModel? viewModel=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.VisibilityAppearance> visibilityAppearance=null, dymaptic.GeoBlazor.Pro.Components.CatalogLayerListVisibleElements? visibleElements=null, string? widgetId=null);
Parameters
catalogLayer CatalogLayer
The CatalogLayer to display in the widget.
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
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
label System.String
The widget’s label.
ArcGIS Maps SDK for JavaScript
listItemCreatedFunction System.Func<dymaptic.GeoBlazor.Core.Components.ListItem,System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.ListItem>>
A function that executes each time a ListItem is created.
default null
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<dymaptic.GeoBlazor.Core.Components.ListItem>
A collection of selected ListItems representing catalogItems selected by the user.
ArcGIS Maps SDK for JavaScript
selectionMode System.Nullable<dymaptic.GeoBlazor.Core.Enums.SelectionMode>
Specifies the selection mode.
default “none”
ArcGIS Maps SDK for JavaScript
viewModel CatalogLayerListViewModel
The view model for this widget.
ArcGIS Maps SDK for JavaScript
visibilityAppearance System.Nullable<dymaptic.GeoBlazor.Core.Enums.VisibilityAppearance>
Determines the icons used to indicate visibility.
default “default”
ArcGIS Maps SDK for JavaScript
visibleElements CatalogLayerListVisibleElements
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
CatalogLayerListWidget.CatalogItems Property
The collection of ListItems representing the catalogLayer’sdynamicGroupLayer.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.ListItem>? CatalogItems { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.ListItem>
CatalogLayerListWidget.CatalogLayer Property
The CatalogLayer to display in the widget.
default null
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Pro.Components.Layers.CatalogLayer? CatalogLayer { get; set; }
Property Value
CatalogLayerListWidget.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>
CatalogLayerListWidget.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
CatalogLayerListWidget.FilterPredicate Property
Specifies a function to handle filtering list items.
default null
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Pro.Functions.FilterPredicate? FilterPredicate { get; set; }
Property Value
CatalogLayerListWidget.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
CatalogLayerListWidget.HasCustomHandler Property
A convenience property that signifies whether a custom OnListItemCreatedHandler was registered.
public bool HasCustomHandler { get; }
Property Value
CatalogLayerListWidget.HasFilterPredicate Property
A convenience property that signifies whether a custom FilterPredicate function was registered.
public bool HasFilterPredicate { get; }
Property Value
CatalogLayerListWidget.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>
CatalogLayerListWidget.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>
CatalogLayerListWidget.OnListItemCreatedHandler Property
A delegate to implement a custom handler for setting up each dymaptic.GeoBlazor.Core.Components.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<dymaptic.GeoBlazor.Core.Components.ListItem,System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.ListItem>>
CatalogLayerListWidget.OnTriggerAction Property
Event Listener for TriggerAction.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Pro.Events.CatalogLayerListTriggerActionEvent> OnTriggerAction { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<CatalogLayerListTriggerActionEvent>
CatalogLayerListWidget.SelectedItems Property
A collection of selected ListItems representing catalogItems
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<dymaptic.GeoBlazor.Core.Components.ListItem>
CatalogLayerListWidget.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<dymaptic.GeoBlazor.Core.Enums.SelectionMode>
CatalogLayerListWidget.Type Property
The type of widget
public override dymaptic.GeoBlazor.Core.Enums.WidgetType Type { get; }
Property Value
dymaptic.GeoBlazor.Core.Enums.WidgetType
CatalogLayerListWidget.ViewModel Property
The view model for this widget.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Pro.Components.CatalogLayerListViewModel? ViewModel { get; set; }
Property Value
CatalogLayerListWidget.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<dymaptic.GeoBlazor.Core.Enums.VisibilityAppearance>
CatalogLayerListWidget.VisibleElements Property
The visible elements that are displayed within the widget.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Pro.Components.CatalogLayerListVisibleElements? VisibleElements { get; set; }
Property Value
CatalogLayerListVisibleElements
Methods
CatalogLayerListWidget.AddToSelectedItems(ListItem[]) Method
Asynchronously adds elements to the SelectedItems property.
public System.Threading.Tasks.Task AddToSelectedItems(params dymaptic.GeoBlazor.Core.Components.ListItem[] values);
Parameters
values dymaptic.GeoBlazor.Core.Components.ListItem[]
The elements to add.
Returns
CatalogLayerListWidget.GetCatalogItems() Method
Asynchronously retrieve the current value of the CatalogItems property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.ListItem>?> GetCatalogItems();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.ListItem>>
CatalogLayerListWidget.GetCatalogLayer() Method
Asynchronously retrieve the current value of the CatalogLayer property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Components.Layers.CatalogLayer?> GetCatalogLayer();
Returns
System.Threading.Tasks.Task<CatalogLayer>
CatalogLayerListWidget.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>>
CatalogLayerListWidget.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>
CatalogLayerListWidget.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>
CatalogLayerListWidget.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>>
CatalogLayerListWidget.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>>
CatalogLayerListWidget.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<dymaptic.GeoBlazor.Core.Components.ListItem>>
CatalogLayerListWidget.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<dymaptic.GeoBlazor.Core.Enums.SelectionMode>>
CatalogLayerListWidget.GetViewModel() Method
Asynchronously retrieve the current value of the ViewModel property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Components.CatalogLayerListViewModel?> GetViewModel();
Returns
System.Threading.Tasks.Task<CatalogLayerListViewModel>
CatalogLayerListWidget.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<dymaptic.GeoBlazor.Core.Enums.VisibilityAppearance>>
CatalogLayerListWidget.GetVisibleElements() Method
Asynchronously retrieve the current value of the VisibleElements property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Components.CatalogLayerListVisibleElements?> GetVisibleElements();
Returns
System.Threading.Tasks.Task<CatalogLayerListVisibleElements>
CatalogLayerListWidget.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 dymaptic.GeoBlazor.Core.Components.ListItem
Returns
CatalogLayerListWidget.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
CatalogLayerListWidget.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 dymaptic.GeoBlazor.Core.Components.ListItem
The dymaptic.GeoBlazor.Core.Components.ListItem from the original source.
Returns
System.Threading.Tasks.Task<System.Object>
Returns the modified dymaptic.GeoBlazor.Core.Components.ListItem
CatalogLayerListWidget.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
values dymaptic.GeoBlazor.Core.Components.ListItem[]
The elements to remove.
Returns
CatalogLayerListWidget.SetCatalogLayer(CatalogLayer) Method
Asynchronously set the value of the CatalogLayer property after render.
public System.Threading.Tasks.Task SetCatalogLayer(dymaptic.GeoBlazor.Pro.Components.Layers.CatalogLayer? value);
Parameters
value CatalogLayer
The value to set.
Returns
CatalogLayerListWidget.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
CatalogLayerListWidget.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
CatalogLayerListWidget.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
CatalogLayerListWidget.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
CatalogLayerListWidget.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
CatalogLayerListWidget.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<dymaptic.GeoBlazor.Core.Components.ListItem>
The value to set.
Returns
CatalogLayerListWidget.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<dymaptic.GeoBlazor.Core.Enums.SelectionMode>
The value to set.
Returns
CatalogLayerListWidget.SetViewModel(CatalogLayerListViewModel) Method
Asynchronously set the value of the ViewModel property after render.
public System.Threading.Tasks.Task SetViewModel(dymaptic.GeoBlazor.Pro.Components.CatalogLayerListViewModel? value);
Parameters
value CatalogLayerListViewModel
The value to set.
Returns
CatalogLayerListWidget.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<dymaptic.GeoBlazor.Core.Enums.VisibilityAppearance>
The value to set.
Returns
CatalogLayerListWidget.SetVisibleElements(CatalogLayerListVisibleElements) Method
Asynchronously set the value of the VisibleElements property after render.
public System.Threading.Tasks.Task SetVisibleElements(dymaptic.GeoBlazor.Pro.Components.CatalogLayerListVisibleElements? value);
Parameters
value CatalogLayerListVisibleElements
The value to set.
Returns
CatalogLayerListWidget.TriggerAction(ActionBase, ListItem) Method
Triggers the trigger-action event and executes
the given action or action toggle.
param __1 An item associated with the action.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task TriggerAction(dymaptic.GeoBlazor.Core.Components.ActionBase __0, dymaptic.GeoBlazor.Core.Components.ListItem __1);
Parameters
__0 dymaptic.GeoBlazor.Core.Components.ActionBase
The action to execute.
__1 dymaptic.GeoBlazor.Core.Components.ListItem
An item associated with the action.
Returns
CatalogLayerListWidget.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()