GeoBlazor Pro
dymaptic.GeoBlazor.Pro
dymaptic.GeoBlazor.Pro.Components
CatalogLayerListViewModel Class
Provides the logic for the CatalogLayerList widget. ArcGIS Maps SDK for JavaScript
public class CatalogLayerListViewModel : dymaptic.GeoBlazor.Core.Components.MapComponent, dymaptic.GeoBlazor.Core.Interfaces.IViewModel
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 CatalogLayerListViewModel
Implements IViewModel
Constructors
CatalogLayerListViewModel() Constructor
Parameterless constructor for use as a Razor Component.
public CatalogLayerListViewModel();
CatalogLayerListViewModel(CatalogLayer, Nullable, Func<ListItem,Task>) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public CatalogLayerListViewModel(dymaptic.GeoBlazor.Pro.Components.Layers.CatalogLayer? catalogLayer=null, System.Nullable<bool> checkPublishStatusEnabled=null, System.Func<dymaptic.GeoBlazor.Core.Components.ListItem,System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.ListItem>>? listItemCreatedFunction=null);
Parameters
catalogLayer CatalogLayer
The CatalogLayer to display in the widget. default null ArcGIS Maps SDK for JavaScript
checkPublishStatusEnabled System.Nullable<System.Boolean>
Whether to provide an indication if a layer is being published in the CatalogLayerList. default false 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
Properties
CatalogLayerListViewModel.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; }
Property Value
System.Collections.Generic.IReadOnlyList<ListItem>
CatalogLayerListViewModel.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
CatalogLayerListViewModel.CheckPublishStatusEnabled Property
Whether to provide an indication if a layer is being published in the CatalogLayerList. default false ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> CheckPublishStatusEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
CatalogLayerListViewModel.HasCustomHandler Property
A convenience property that signifies whether a custom OnListItemCreatedHandler was registered.
public bool HasCustomHandler { get; }
Property Value
CatalogLayerListViewModel.HasTriggerActionListener Property
Used in JavaScript layer to determine if the event listener is registered.
public bool HasTriggerActionListener { get; }
Property Value
CatalogLayerListViewModel.ListModeDisabled Property
Specifies whether to ignore the listMode property of the layers to display all layers. default false ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> ListModeDisabled { get; set; }
Property Value
System.Nullable<System.Boolean>
CatalogLayerListViewModel.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>>
CatalogLayerListViewModel.OnTriggerAction Property
Fires after the user clicks on an action or action toggle inside the CatalogLayerListViewModel. This event may be used to define a custom function to execute when particular actions are clicked.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Pro.Events.CatalogLayerListViewModelTriggerActionEvent> OnTriggerAction { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<CatalogLayerListViewModelTriggerActionEvent>
CatalogLayerListViewModel.State Property
The view model’s state. default “disabled” ArcGIS Maps SDK for JavaScript
public System.Nullable<dymaptic.GeoBlazor.Core.Enums.ViewModelState> State { get; }
Property Value
System.Nullable<ViewModelState>
Methods
CatalogLayerListViewModel.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<ListItem>>
CatalogLayerListViewModel.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>
CatalogLayerListViewModel.GetCheckPublishStatusEnabled() Method
Asynchronously retrieve the current value of the CheckPublishStatusEnabled property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetCheckPublishStatusEnabled();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
CatalogLayerListViewModel.GetListModeDisabled() Method
Asynchronously retrieve the current value of the ListModeDisabled property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetListModeDisabled();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
CatalogLayerListViewModel.GetState() Method
Asynchronously retrieve the current value of the State property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.ViewModelState>> GetState();
Returns
System.Threading.Tasks.Task<System.Nullable<ViewModelState>>
CatalogLayerListViewModel.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
CatalogLayerListViewModel.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
CatalogLayerListViewModel.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
CatalogLayerListViewModel.SetCheckPublishStatusEnabled(Nullable) Method
Asynchronously set the value of the CheckPublishStatusEnabled property after render.
public System.Threading.Tasks.Task SetCheckPublishStatusEnabled(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
CatalogLayerListViewModel.SetListModeDisabled(Nullable) Method
Asynchronously set the value of the ListModeDisabled property after render.
public System.Threading.Tasks.Task SetListModeDisabled(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
CatalogLayerListViewModel.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 ActionBase
The action to execute.
__1 ListItem
Returns
CatalogLayerListViewModel.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()