dymaptic.GeoBlazor.Core

dymaptic.GeoBlazor.Core.Components

BasemapLayerListViewModel Class

Provides logic for the BasemapLayerList widget.
ArcGIS Maps SDK for JavaScript

public class BasemapLayerListViewModel : dymaptic.GeoBlazor.Core.Components.MapComponent,
dymaptic.GeoBlazor.Core.Interfaces.IViewModel

Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 BasemapLayerListViewModel

Implements IViewModel

Constructors

BasemapLayerListViewModel() Constructor

Parameterless constructor for use as a Razor Component.

public BasemapLayerListViewModel();

BasemapLayerListViewModel(Func<ListItem,Task>, string, Nullable, 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 BasemapLayerListViewModel(System.Func<dymaptic.GeoBlazor.Core.Components.ListItem,System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.ListItem>>? baseListItemCreatedFunction=null, string? basemapTitle=null, System.Nullable<bool> checkPublishStatusEnabled=null, System.Nullable<bool> listModeDisabled=null, System.Func<dymaptic.GeoBlazor.Core.Components.ListItem,System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.ListItem>>? referenceListItemCreatedFunction=null);

Parameters

baseListItemCreatedFunction System.Func<ListItem,System.Threading.Tasks.Task<ListItem>>

Specifies a function that accesses each ListItem.
ArcGIS Maps SDK for JavaScript

basemapTitle System.String

The current basemap’s title.
ArcGIS Maps SDK for JavaScript

checkPublishStatusEnabled System.Nullable<System.Boolean>

Whether to provide an indication if a layer is being published in the BasemapLayerList.
default false
ArcGIS Maps SDK for JavaScript

listModeDisabled System.Nullable<System.Boolean>

Specifies whether to ignore the listMode property of the layers to display all layers.
default false
ArcGIS Maps SDK for JavaScript

referenceListItemCreatedFunction System.Func<ListItem,System.Threading.Tasks.Task<ListItem>>

Specifies a function that accesses each ListItem representing reference layers.
ArcGIS Maps SDK for JavaScript

Properties

BasemapLayerListViewModel.BaseItems Property

A collection of ListItems representing the baseLayers.
ArcGIS Maps SDK for JavaScript

public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.ListItem>? BaseItems { get; set; }

Property Value

System.Collections.Generic.IReadOnlyList<ListItem>

BasemapLayerListViewModel.BasemapTitle Property

The current basemap’s title.
ArcGIS Maps SDK for JavaScript

public string? BasemapTitle { get; set; }

Property Value

System.String

BasemapLayerListViewModel.CheckPublishStatusEnabled Property

Whether to provide an indication if a layer is being published in the
BasemapLayerList.
default false
ArcGIS Maps SDK for JavaScript

public System.Nullable<bool> CheckPublishStatusEnabled { get; set; }

Property Value

System.Nullable<System.Boolean>

BasemapLayerListViewModel.HasCustomBaseListHandler Property

A convenience property that signifies whether a custom OnBaseListItemCreatedHandler was registered.

public bool HasCustomBaseListHandler { get; }

Property Value

System.Boolean

BasemapLayerListViewModel.HasCustomReferenceListHandler Property

A convenience property that signifies whether a custom OnReferenceListItemCreatedHandler was registered.

public bool HasCustomReferenceListHandler { get; }

Property Value

System.Boolean

BasemapLayerListViewModel.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>

BasemapLayerListViewModel.OnBaseListItemCreatedHandler Property

A delegate to implement a custom handler for setting up a base type ofListItem.
Function must take in a ListItem and return a Task with the designated base type of item.

public System.Func<dymaptic.GeoBlazor.Core.Components.ListItem,System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.ListItem>>? OnBaseListItemCreatedHandler { get; set; }

Property Value

System.Func<ListItem,System.Threading.Tasks.Task<ListItem>>

BasemapLayerListViewModel.OnReferenceListItemCreatedHandler Property

A delegate to implement a custom handler for setting up a reference type ofListItem.
Function must take in a ListItem and return a Task with the designated reference type of item.

public System.Func<dymaptic.GeoBlazor.Core.Components.ListItem,System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.ListItem>>? OnReferenceListItemCreatedHandler { get; set; }

Property Value

System.Func<ListItem,System.Threading.Tasks.Task<ListItem>>

BasemapLayerListViewModel.ReferenceItems Property

A collection of ListItems representing the referenceLayers.
ArcGIS Maps SDK for JavaScript

public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.ListItem>? ReferenceItems { get; set; }

Property Value

System.Collections.Generic.IReadOnlyList<ListItem>

BasemapLayerListViewModel.State Property

The view model’s state.
default “disabled”
ArcGIS Maps SDK for JavaScript

public System.Nullable<dymaptic.GeoBlazor.Core.Enums.ViewModelState> State { get; set; }

Property Value

System.Nullable<ViewModelState>

Methods

BasemapLayerListViewModel.GetBaseItems() Method

Asynchronously retrieve the current value of the BaseItems property.

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.ListItem>?> GetBaseItems();

Returns

System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<ListItem>>

BasemapLayerListViewModel.GetBasemapTitle() Method

Asynchronously retrieve the current value of the BasemapTitle property.

public System.Threading.Tasks.Task<string?> GetBasemapTitle();

Returns

System.Threading.Tasks.Task<System.String>

BasemapLayerListViewModel.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>>

BasemapLayerListViewModel.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>>

BasemapLayerListViewModel.GetReferenceItems() Method

Asynchronously retrieve the current value of the ReferenceItems property.

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.ListItem>?> GetReferenceItems();

Returns

System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<ListItem>>

BasemapLayerListViewModel.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>>

BasemapLayerListViewModel.OnBaseListItemCreated(ListItem) Method

A JavaScript invokable method that is triggered whenever a base type ListItem is created and a handler is attached.

public System.Threading.Tasks.Task<object> OnBaseListItemCreated(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 base ListItem

Remarks

For internal use only. This returns an object simply for JavaScript serialization purposes.

BasemapLayerListViewModel.OnReferenceListItemCreated(ListItem) Method

A JavaScript invokable method that is triggered whenever a reference type ListItem is created and a handler is attached.

public System.Threading.Tasks.Task<object> OnReferenceListItemCreated(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 reference ListItem

BasemapLayerListViewModel.SetBasemapTitle(string) Method

Asynchronously set the value of the BasemapTitle property after render.

public System.Threading.Tasks.Task SetBasemapTitle(string? value);

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

BasemapLayerListViewModel.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

System.Threading.Tasks.Task

BasemapLayerListViewModel.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

System.Threading.Tasks.Task

BasemapLayerListViewModel.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

System.Threading.Tasks.Task