dymaptic.GeoBlazor.Core

dymaptic.GeoBlazor.Core.Components

ListItem Class

The ListItem class represents one of the operationalItems
in the LayerListViewModel.
ArcGIS Maps SDK for JavaScript

public class ListItem : dymaptic.GeoBlazor.Core.Components.MapComponent

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

Constructors

ListItem() Constructor

Parameterless constructor for use as a Razor Component.

public ListItem();

ListItem(Nullable, Nullable, ActionBase[][], Nullable, Nullable, Nullable, Nullable, Nullable, string) Constructor

Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.

public ListItem(System.Nullable<System.Guid> layerId, System.Nullable<bool> actionsOpen=null, dymaptic.GeoBlazor.Core.Components.ActionBase[][]? actionsSections=null, System.Nullable<bool> childrenSortable=null, System.Nullable<bool> hidden=null, System.Nullable<bool> listModeDisabled=null, System.Nullable<bool> open=null, System.Nullable<bool> sortable=null, string? title=null);

Parameters

layerId System.Nullable<System.Guid>

The id for the layer associated with the triggered action.
default null
ArcGIS Maps SDK for JavaScript

actionsOpen System.Nullable<System.Boolean>

Whether the actions panel is open in the LayerList.
default false
ArcGIS Maps SDK for JavaScript

actionsSections ActionBase[][]

A nested 2-dimensional collection of actions that could be triggered on the item.
ArcGIS Maps SDK for JavaScript

childrenSortable System.Nullable<System.Boolean>

Indicates if the children of a list item (or sublayers in a GroupLayer) can be sorted or moved/reordered.
default true
ArcGIS Maps SDK for JavaScript

hidden System.Nullable<System.Boolean>

When true, hides the layer from the LayerList instance.
default false
ArcGIS Maps SDK for JavaScript

listModeDisabled System.Nullable<System.Boolean>

Specifies whether to ignore the listMode property of the child layers in the list item.
default false
ArcGIS Maps SDK for JavaScript

open System.Nullable<System.Boolean>

Whether the layer is open in the LayerList.
default false
ArcGIS Maps SDK for JavaScript

sortable System.Nullable<System.Boolean>

Indicates if the list item (or layer in the map) can be sorted or moved/reordered.
default true
ArcGIS Maps SDK for JavaScript

title System.String

The title of the layer.
ArcGIS Maps SDK for JavaScript

Properties

ListItem.ActionsOpen Property

Whether the actions panel is open in the LayerList.
default false
ArcGIS Maps SDK for JavaScript

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

Property Value

System.Nullable<System.Boolean>

ListItem.ActionsSections Property

A nested 2-dimensional collection of actions that could be triggered on the item.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Components.ActionBase[][]? ActionsSections { get; set; }

Property Value

ActionBase[][]

ListItem.Children Property

When a layer contains sublayers, this property is a Collection of ListItem objects belonging to the given layer.
ArcGIS Maps SDK for JavaScript

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

Property Value

System.Collections.Generic.IReadOnlyList<ListItem>

ListItem.ChildrenSortable Property

Indicates if the children of a list item (or sublayers in a GroupLayer) can be sorted or moved/reordered.
default true
ArcGIS Maps SDK for JavaScript

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

Property Value

System.Nullable<System.Boolean>

ListItem.ConnectionStatus Property

Only valid when the list item represents a StreamLayer.
ArcGIS Maps SDK for JavaScript

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

Property Value

System.Nullable<ConnectionStatus>

ListItem.Error Property

The Error object returned if an error occurred.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Model.Error? Error { get; set; }

Property Value

Error

ListItem.Hidden Property

When true, hides the layer from the LayerList instance.
default false
ArcGIS Maps SDK for JavaScript

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

Property Value

System.Nullable<System.Boolean>

ListItem.Incompatible Property

Whether the layer is unsupported by the view.
default false
ArcGIS Maps SDK for JavaScript

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

Property Value

System.Nullable<System.Boolean>

ListItem.LayerView Property

The LayerView displaying data for the
associated layer.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Components.LayerView? LayerView { get; set; }

Property Value

LayerView

ListItem.ListModeDisabled Property

Specifies whether to ignore the listMode property of the child layers in the list item.
default false
ArcGIS Maps SDK for JavaScript

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

Property Value

System.Nullable<System.Boolean>

ListItem.Open Property

Whether the layer is open in the LayerList.
default false
ArcGIS Maps SDK for JavaScript

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

Property Value

System.Nullable<System.Boolean>

ListItem.Panel Property

Allows you to display custom content for each ListItem
in the LayerList widget.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Components.Widgets.ListItemPanelWidget? Panel { get; set; }

Property Value

ListItemPanelWidget

ListItem.Publishing Property

Value is true when the layer is being published.
default false
ArcGIS Maps SDK for JavaScript

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

Property Value

System.Nullable<System.Boolean>

ListItem.Sortable Property

Indicates if the list item (or layer in the map) can be sorted or moved/reordered.
default true
ArcGIS Maps SDK for JavaScript

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

Property Value

System.Nullable<System.Boolean>

ListItem.Title Property

The title of the layer.
ArcGIS Maps SDK for JavaScript

public string? Title { get; set; }

Property Value

System.String

ListItem.Updating Property

Value is true when the layer is updating; for example, if it is in the process of fetching data.
default false
ArcGIS Maps SDK for JavaScript

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

Property Value

System.Nullable<System.Boolean>

ListItem.VisibilityMode Property

Indicates how to manage the visibility of the children layers.
ArcGIS Maps SDK for JavaScript

public string? VisibilityMode { get; set; }

Property Value

System.String

ListItem.VisibleAtCurrentScale Property

Whether the layer is visible at the current scale or not.
default true
ArcGIS Maps SDK for JavaScript

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

Property Value

System.Nullable<System.Boolean>

ListItem.VisibleAtCurrentTimeExtent Property

Whether the layer is visible at the current time extent or not.
default true
ArcGIS Maps SDK for JavaScript

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

Property Value

System.Nullable<System.Boolean>

Methods

ListItem.AddToActionsSections(ActionBase[]) Method

Asynchronously adds elements to the ActionsSections property.

public System.Threading.Tasks.Task AddToActionsSections(params dymaptic.GeoBlazor.Core.Components.ActionBase[] values);

Parameters

values ActionBase[]

The elements to add.

Returns

System.Threading.Tasks.Task

ListItem.GetActionsOpen() Method

Asynchronously retrieve the current value of the ActionsOpen property.

public System.Threading.Tasks.Task<System.Nullable<bool>> GetActionsOpen();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Boolean>>

ListItem.GetActionsSections() Method

Asynchronously retrieve the current value of the ActionsSections property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.ActionBase[][]?> GetActionsSections();

Returns

System.Threading.Tasks.Task<ActionBase[][]>

ListItem.GetChildrenSortable() Method

Asynchronously retrieve the current value of the ChildrenSortable property.

public System.Threading.Tasks.Task<System.Nullable<bool>> GetChildrenSortable();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Boolean>>

ListItem.GetConnectionStatus() Method

Asynchronously retrieve the current value of the ConnectionStatus property.

public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.ConnectionStatus>> GetConnectionStatus();

Returns

System.Threading.Tasks.Task<System.Nullable<ConnectionStatus>>

ListItem.GetError() Method

Asynchronously retrieve the current value of the Error property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.Error?> GetError();

Returns

System.Threading.Tasks.Task<Error>

ListItem.GetHidden() Method

Asynchronously retrieve the current value of the Hidden property.

public System.Threading.Tasks.Task<System.Nullable<bool>> GetHidden();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Boolean>>

ListItem.GetIncompatible() Method

Asynchronously retrieve the current value of the Incompatible property.

public System.Threading.Tasks.Task<System.Nullable<bool>> GetIncompatible();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Boolean>>

ListItem.GetLayer() Method

Asynchronously retrieve the current value of the Layer property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Layers.Layer?> GetLayer();

Returns

System.Threading.Tasks.Task<Layer>

ListItem.GetLayerView() Method

Asynchronously retrieve the current value of the LayerView property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.LayerView?> GetLayerView();

Returns

System.Threading.Tasks.Task<LayerView>

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

ListItem.GetOpen() Method

Asynchronously retrieve the current value of the Open property.

public System.Threading.Tasks.Task<System.Nullable<bool>> GetOpen();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Boolean>>

ListItem.GetPublishing() Method

Asynchronously retrieve the current value of the Publishing property.

public System.Threading.Tasks.Task<System.Nullable<bool>> GetPublishing();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Boolean>>

ListItem.GetSortable() Method

Asynchronously retrieve the current value of the Sortable property.

public System.Threading.Tasks.Task<System.Nullable<bool>> GetSortable();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Boolean>>

ListItem.GetTitle() Method

Asynchronously retrieve the current value of the Title property.

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

Returns

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

ListItem.GetUpdating() Method

Asynchronously retrieve the current value of the Updating property.

public System.Threading.Tasks.Task<System.Nullable<bool>> GetUpdating();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Boolean>>

ListItem.GetVisibilityMode() Method

Asynchronously retrieve the current value of the VisibilityMode property.

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

Returns

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

ListItem.GetVisibleAtCurrentScale() Method

Asynchronously retrieve the current value of the VisibleAtCurrentScale property.

public System.Threading.Tasks.Task<System.Nullable<bool>> GetVisibleAtCurrentScale();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Boolean>>

ListItem.GetVisibleAtCurrentTimeExtent() Method

Asynchronously retrieve the current value of the VisibleAtCurrentTimeExtent property.

public System.Threading.Tasks.Task<System.Nullable<bool>> GetVisibleAtCurrentTimeExtent();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Boolean>>

ListItem.RemoveFromActionsSections(ActionBase[]) Method

Asynchronously remove an element from the ActionsSections property.

public System.Threading.Tasks.Task RemoveFromActionsSections(params dymaptic.GeoBlazor.Core.Components.ActionBase[] values);

Parameters

values ActionBase[]

The elements to remove.

Returns

System.Threading.Tasks.Task

ListItem.SetActionsOpen(Nullable) Method

Asynchronously set the value of the ActionsOpen property after render.

public System.Threading.Tasks.Task SetActionsOpen(System.Nullable<bool> value);

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

ListItem.SetActionsSections(ActionBase[][]) Method

Asynchronously set the value of the ActionsSections property after render.

public System.Threading.Tasks.Task SetActionsSections(dymaptic.GeoBlazor.Core.Components.ActionBase[][]? value);

Parameters

value ActionBase[][]

The value to set.

Returns

System.Threading.Tasks.Task

ListItem.SetChildrenSortable(Nullable) Method

Asynchronously set the value of the ChildrenSortable property after render.

public System.Threading.Tasks.Task SetChildrenSortable(System.Nullable<bool> value);

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

ListItem.SetHidden(Nullable) Method

Asynchronously set the value of the Hidden property after render.

public System.Threading.Tasks.Task SetHidden(System.Nullable<bool> value);

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

ListItem.SetLayer(Layer) Method

Asynchronously set the value of the Layer property after render.

public System.Threading.Tasks.Task SetLayer(dymaptic.GeoBlazor.Core.Components.Layers.Layer? value);

Parameters

value Layer

The value to set.

Returns

System.Threading.Tasks.Task

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

ListItem.SetOpen(Nullable) Method

Asynchronously set the value of the Open property after render.

public System.Threading.Tasks.Task SetOpen(System.Nullable<bool> value);

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

ListItem.SetPanel(ListItemPanelWidget) Method

Asynchronously set the value of the Panel property after render.

public System.Threading.Tasks.Task SetPanel(dymaptic.GeoBlazor.Core.Components.Widgets.ListItemPanelWidget? value);

Parameters

value ListItemPanelWidget

The value to set.

Returns

System.Threading.Tasks.Task

ListItem.SetSortable(Nullable) Method

Asynchronously set the value of the Sortable property after render.

public System.Threading.Tasks.Task SetSortable(System.Nullable<bool> value);

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

ListItem.SetTitle(string) Method

Asynchronously set the value of the Title property after render.

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

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

ListItem.ValidateRequiredGeneratedChildren() Method

Validates source-generated child components.

public override void ValidateRequiredGeneratedChildren();

Implements ValidateRequiredGeneratedChildren()