dymaptic.GeoBlazor.Core

dymaptic.GeoBlazor.Core.Components.Widgets

ListItemPanelWidget Class

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

public class ListItemPanelWidget : dymaptic.GeoBlazor.Core.Components.Widgets.Widget

Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 Widget 🡒 ListItemPanelWidget

Constructors

ListItemPanelWidget() Constructor

Parameterless constructor for use as a Razor Component.

public ListItemPanelWidget();

ListItemPanelWidget(string, IReadOnlyList, Nullable, Nullable, string, string, string, MapView, Nullable, Nullable, string, 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 ListItemPanelWidget(string? containerId=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Model.ListItemPanelContent>? content=null, System.Nullable<bool> disabled=null, System.Nullable<bool> flowEnabled=null, string? icon=null, string? image=null, string? label=null, dymaptic.GeoBlazor.Core.Components.Views.MapView? mapView=null, System.Nullable<bool> open=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.OverlayPosition> position=null, string? title=null, System.Nullable<bool> visible=null, string? widgetId=null);

Parameters

containerId System.String

The id of an external HTML Element (div). If provided, the widget will be placed inside that element, instead of on the map.

content System.Collections.Generic.IReadOnlyList<ListItemPanelContent>

The content displayed in the ListItem panel.
ArcGIS Maps SDK for JavaScript

disabled System.Nullable<System.Boolean>

If true, disables the ListItem’s panel so the user cannot open or interact with it.
ArcGIS Maps SDK for JavaScript

flowEnabled System.Nullable<System.Boolean>

Indicates whether the panel’s content should be rendered as a Calcite Flow Item.
default false
ArcGIS Maps SDK for JavaScript

icon System.String

Icon which represents the widget.
default null
ArcGIS Maps SDK for JavaScript

image System.String

The URL or data URI of an image used to represent the panel.
ArcGIS Maps SDK for JavaScript

label System.String

The widget’s label.
ArcGIS Maps SDK for JavaScript

mapView MapView

If the Widget is defined outside of the MapView, this link is required to connect them together.

open System.Nullable<System.Boolean>

Indicates if the panel’s content is open and visible to the user.
default false
ArcGIS Maps SDK for JavaScript

position System.Nullable<OverlayPosition>

The position of the widget in relation to the map view.

title System.String

The title of the panel.
ArcGIS Maps SDK for JavaScript

visible System.Nullable<System.Boolean>

Indicates whether the widget is visible.
default true
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

ListItemPanelWidget.Content Property

The content displayed in the ListItem panel.
ArcGIS Maps SDK for JavaScript

public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Model.ListItemPanelContent>? Content { get; set; }

Property Value

System.Collections.Generic.IReadOnlyList<ListItemPanelContent>

ListItemPanelWidget.Disabled Property

If true, disables the ListItem’s panel so the user cannot open or interact with it.
ArcGIS Maps SDK for JavaScript

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

Property Value

System.Nullable<System.Boolean>

ListItemPanelWidget.FlowEnabled Property

Indicates whether the panel’s content should be rendered as a Calcite Flow Item.
default false
ArcGIS Maps SDK for JavaScript

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

Property Value

System.Nullable<System.Boolean>

ListItemPanelWidget.Image Property

The URL or data URI of an image used to represent the panel.
ArcGIS Maps SDK for JavaScript

public string? Image { get; set; }

Property Value

System.String

ListItemPanelWidget.ListItem Property

The panel’s parent ListItem that represents a layer in the map.
ArcGIS Maps SDK for JavaScript

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

Property Value

ListItem

ListItemPanelWidget.Open Property

Indicates if the panel’s content is open and visible to the user.
default false
ArcGIS Maps SDK for JavaScript

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

Property Value

System.Nullable<System.Boolean>

ListItemPanelWidget.Title Property

The title of the panel.
ArcGIS Maps SDK for JavaScript

public string? Title { get; set; }

Property Value

System.String

ListItemPanelWidget.Type Property

The type of widget

public override dymaptic.GeoBlazor.Core.Enums.WidgetType Type { get; }

Property Value

WidgetType

Methods

ListItemPanelWidget.AddToContent(ListItemPanelContent[]) Method

Asynchronously adds elements to the Content property.

public System.Threading.Tasks.Task AddToContent(params dymaptic.GeoBlazor.Core.Model.ListItemPanelContent[] values);

Parameters

values ListItemPanelContent[]

The elements to add.

Returns

System.Threading.Tasks.Task

ListItemPanelWidget.GetContent() Method

Asynchronously retrieve the current value of the Content property.

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Model.ListItemPanelContent>?> GetContent();

Returns

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

ListItemPanelWidget.GetDisabled() Method

Asynchronously retrieve the current value of the Disabled property.

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

Returns

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

ListItemPanelWidget.GetFlowEnabled() Method

Asynchronously retrieve the current value of the FlowEnabled property.

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

Returns

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

ListItemPanelWidget.GetImage() Method

Asynchronously retrieve the current value of the Image property.

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

Returns

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

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

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

ListItemPanelWidget.RemoveFromContent(ListItemPanelContent[]) Method

Asynchronously remove an element from the Content property.

public System.Threading.Tasks.Task RemoveFromContent(params dymaptic.GeoBlazor.Core.Model.ListItemPanelContent[] values);

Parameters

values ListItemPanelContent[]

The elements to remove.

Returns

System.Threading.Tasks.Task

ListItemPanelWidget.SetContent(IReadOnlyList) Method

Asynchronously set the value of the Content property after render.

public System.Threading.Tasks.Task SetContent(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Model.ListItemPanelContent>? value);

Parameters

value System.Collections.Generic.IReadOnlyList<ListItemPanelContent>

The value to set.

Returns

System.Threading.Tasks.Task

ListItemPanelWidget.SetDisabled(Nullable) Method

Asynchronously set the value of the Disabled property after render.

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

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

ListItemPanelWidget.SetFlowEnabled(Nullable) Method

Asynchronously set the value of the FlowEnabled property after render.

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

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

ListItemPanelWidget.SetImage(string) Method

Asynchronously set the value of the Image property after render.

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

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

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

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

ListItemPanelWidget.ValidateRequiredGeneratedChildren() Method

Validates source-generated child components.

public override void ValidateRequiredGeneratedChildren();

Implements ValidateRequiredGeneratedChildren()