GeoBlazor Pro
dymaptic.GeoBlazor.Pro
dymaptic.GeoBlazor.Pro.Components.Widgets
TableListWidget Class
The TableList widget provides a way to display a list of tables associated with a Map. ArcGIS Maps SDK for JavaScript
public class TableListWidget : dymaptic.GeoBlazor.Pro.Components.Widgets.ProWidget, dymaptic.GeoBlazor.Core.Interfaces.ITableListWidget, dymaptic.GeoBlazor.Core.Interfaces.IMapComponent
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 Widget 🡒 ProWidget 🡒 TableListWidget
Implements ITableListWidget, IMapComponent
Constructors
TableListWidget() Constructor
Parameterless constructor for use as a Razor Component.
public TableListWidget();
TableListWidget(Nullable, Nullable, string, string, Nullable, string, string, Func<ListItem,Task>, Nullable, Nullable, IReadOnlyList, Nullable, TableListViewModel, TableListVisibleElements, string) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public TableListWidget(System.Nullable<bool> collapsed=null, System.Nullable<bool> dragEnabled=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> minDragEnabledItems=null, System.Nullable<double> minFilterItems=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Components.TableListListItem>? selectedItems=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.SelectionMode> selectionMode=null, dymaptic.GeoBlazor.Pro.Components.TableListViewModel? viewModel=null, dymaptic.GeoBlazor.Pro.Components.TableListVisibleElements? visibleElements=null, string? widgetId=null);
Parameters
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 text string if visibleElements.filter is true. default “” ArcGIS Maps SDK for JavaScript
headingLevel System.Nullable<System.Double>
Indicates the heading level to use for the title 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<ListItem,System.Threading.Tasks.Task<ListItem>>
Specifies a function that accesses each ListItem. 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<TableListListItem>
A collection of selected ListItems representing table list items 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 TableListViewModel
The view model for this widget. ArcGIS Maps SDK for JavaScript
visibleElements TableListVisibleElements
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
TableListWidget.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>
TableListWidget.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>
TableListWidget.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
TableListWidget.FilterPredicate Property
Specifies a function to handle filtering list items. default null ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Pro.Functions.TableListFilterPredicate? FilterPredicate { get; set; }
Property Value
TableListFilterPredicate(TableListListItem)
TableListWidget.FilterText Property
The value of the filter input text string if visibleElements.filter is true. default “” ArcGIS Maps SDK for JavaScript
public string? FilterText { get; set; }
Property Value
TableListWidget.HasCustomHandler Property
A convenience property that signifies whether a custom OnListItemCreatedHandler was registered.
public bool HasCustomHandler { get; }
Property Value
TableListWidget.HasFilterPredicate Property
A convenience property that signifies whether a custom FilterPredicate function was registered.
public bool HasFilterPredicate { get; }
Property Value
TableListWidget.HeadingLevel Property
Indicates the heading level to use for the title of the widget. default 2 ArcGIS Maps SDK for JavaScript
public System.Nullable<double> HeadingLevel { get; set; }
Property Value
System.Nullable<System.Double>
TableListWidget.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>
TableListWidget.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>
TableListWidget.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>>
TableListWidget.OnTriggerAction Property
Event Listener for TriggerAction.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Pro.Events.TableListTriggerActionEvent> OnTriggerAction { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<TableListTriggerActionEvent>
TableListWidget.SelectedItems Property
A collection of selected ListItems representing table list items selected by the user. ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Components.TableListListItem>? SelectedItems { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<TableListListItem>
TableListWidget.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>
TableListWidget.TableItems Property
The collection of table ListItems displayed within the widget. ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Components.TableListListItem>? TableItems { get; }
Property Value
System.Collections.Generic.IReadOnlyList<TableListListItem>
TableListWidget.Type Property
The type of widget
public override dymaptic.GeoBlazor.Core.Enums.WidgetType Type { get; }
Property Value
TableListWidget.ViewModel Property
The view model for this widget. ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Pro.Components.TableListViewModel? ViewModel { get; set; }
Property Value
TableListWidget.VisibleElements Property
The visible elements that are displayed within the widget. ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Pro.Components.TableListVisibleElements? VisibleElements { get; set; }
Property Value
Methods
TableListWidget.AddToSelectedItems(TableListListItem[]) Method
Asynchronously adds elements to the SelectedItems property.
public System.Threading.Tasks.Task AddToSelectedItems(params dymaptic.GeoBlazor.Pro.Components.TableListListItem[] values);
Parameters
values TableListListItem[]
The elements to add.
Returns
TableListWidget.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>>
TableListWidget.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>>
TableListWidget.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>
TableListWidget.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>
TableListWidget.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>>
TableListWidget.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>>
TableListWidget.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>>
TableListWidget.GetSelectedItems() Method
Asynchronously retrieve the current value of the SelectedItems property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Components.TableListListItem>?> GetSelectedItems();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<TableListListItem>>
TableListWidget.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>>
TableListWidget.GetTableItems() Method
Asynchronously retrieve the current value of the TableItems property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Components.TableListListItem>?> GetTableItems();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<TableListListItem>>
TableListWidget.GetViewModel() Method
Asynchronously retrieve the current value of the ViewModel property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Components.TableListViewModel?> GetViewModel();
Returns
System.Threading.Tasks.Task<TableListViewModel>
TableListWidget.GetVisibleElements() Method
Asynchronously retrieve the current value of the VisibleElements property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Components.TableListVisibleElements?> GetVisibleElements();
Returns
System.Threading.Tasks.Task<TableListVisibleElements>
TableListWidget.OnJsFilterPredicate(TableListListItem) Method
JS-invokable method that triggers the FilterPredicate function. Should not be called by consuming code.
public System.Threading.Tasks.Task OnJsFilterPredicate(dymaptic.GeoBlazor.Pro.Components.TableListListItem item);
Parameters
item TableListListItem
Returns
TableListWidget.OnJsTriggerAction(TableListTriggerActionEvent) Method
JavaScript-Invokable Method for internal use only.
public System.Threading.Tasks.Task OnJsTriggerAction(dymaptic.GeoBlazor.Pro.Events.TableListTriggerActionEvent triggerActionEvent);
Parameters
triggerActionEvent TableListTriggerActionEvent
Returns
TableListWidget.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
TableListWidget.RemoveFromSelectedItems(TableListListItem[]) Method
Asynchronously remove an element from the SelectedItems property.
public System.Threading.Tasks.Task RemoveFromSelectedItems(params dymaptic.GeoBlazor.Pro.Components.TableListListItem[] values);
Parameters
values TableListListItem[]
The elements to remove.
Returns
TableListWidget.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
TableListWidget.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
TableListWidget.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
TableListWidget.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
TableListWidget.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
TableListWidget.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
TableListWidget.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
TableListWidget.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.Pro.Components.TableListListItem>? value);
Parameters
value System.Collections.Generic.IReadOnlyList<TableListListItem>
The value to set.
Returns
TableListWidget.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
TableListWidget.SetViewModel(TableListViewModel) Method
Asynchronously set the value of the ViewModel property after render.
public System.Threading.Tasks.Task SetViewModel(dymaptic.GeoBlazor.Pro.Components.TableListViewModel? value);
Parameters
value TableListViewModel
The value to set.
Returns
TableListWidget.SetVisibleElements(TableListVisibleElements) Method
Asynchronously set the value of the VisibleElements property after render.
public System.Threading.Tasks.Task SetVisibleElements(dymaptic.GeoBlazor.Pro.Components.TableListVisibleElements? value);
Parameters
value TableListVisibleElements
The value to set.
Returns
TableListWidget.TriggerAction(ActionBase, TableListListItem) 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.Pro.Components.TableListListItem item);
Parameters
action ActionBase
The action to execute.
item TableListListItem
An item associated with the action.
Returns
TableListWidget.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()