GeoBlazor Pro
dymaptic.GeoBlazor.Pro
dymaptic.GeoBlazor.Pro.Components.Widgets
TableListItemPanelWidget Class
This class allows you to display custom content for each ListItem in the TableList widget. ArcGIS Maps SDK for JavaScript
public class TableListItemPanelWidget : dymaptic.GeoBlazor.Pro.Components.Widgets.ProWidget
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 Widget 🡒 ProWidget 🡒 TableListItemPanelWidget
Constructors
TableListItemPanelWidget() Constructor
Parameterless constructor for use as a Razor Component.
public TableListItemPanelWidget();
TableListItemPanelWidget(string, string, Widget, Nullable, Nullable, Nullable, string, string, string, TableListListItem, 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 TableListItemPanelWidget(string? containerId=null, string? stringContent=null, dymaptic.GeoBlazor.Core.Components.Widgets.Widget? widgetContent=null, System.Nullable<Microsoft.AspNetCore.Components.ElementReference> htmlElementContent=null, System.Nullable<bool> disabled=null, System.Nullable<bool> flowEnabled=null, string? icon=null, string? image=null, string? label=null, dymaptic.GeoBlazor.Pro.Components.TableListListItem? listItem=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.
stringContent System.String
The content displayed in the ListItem panel as a string. ArcGIS Maps SDK for JavaScript
widgetContent Widget
The content displayed in the ListItem panel as a widget. ArcGIS Maps SDK for JavaScript
htmlElementContent System.Nullable<Microsoft.AspNetCore.Components.ElementReference>
The content displayed in the ListItem panel as an HTML Element. 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
listItem TableListListItem
The panel’s parent ListItem that represents a table in the map. 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
TableListItemPanelWidget.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>
TableListItemPanelWidget.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>
TableListItemPanelWidget.HtmlElementContent Property
The content of the panel as an HTMLElement.
public System.Nullable<Microsoft.AspNetCore.Components.ElementReference> HtmlElementContent { get; set; }
Property Value
System.Nullable<Microsoft.AspNetCore.Components.ElementReference>
TableListItemPanelWidget.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
TableListItemPanelWidget.ListItem Property
The panel’s parent ListItem that represents a table in the map. ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Pro.Components.TableListListItem? ListItem { get; set; }
Property Value
TableListItemPanelWidget.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>
TableListItemPanelWidget.StringContent Property
The content of the panel as a string.
public string? StringContent { get; set; }
Property Value
TableListItemPanelWidget.Title Property
The title of the panel. ArcGIS Maps SDK for JavaScript
public string? Title { get; set; }
Property Value
TableListItemPanelWidget.Type Property
The type of widget
public override dymaptic.GeoBlazor.Core.Enums.WidgetType Type { get; }
Property Value
TableListItemPanelWidget.WidgetContent Property
The content of the panel as a Widget.
public dymaptic.GeoBlazor.Core.Components.Widgets.Widget? WidgetContent { get; set; }
Property Value
Methods
TableListItemPanelWidget.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>>
TableListItemPanelWidget.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>>
TableListItemPanelWidget.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>
TableListItemPanelWidget.GetListItem() Method
Asynchronously retrieve the current value of the ListItem property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Components.TableListListItem?> GetListItem();
Returns
System.Threading.Tasks.Task<TableListListItem>
TableListItemPanelWidget.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>>
TableListItemPanelWidget.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>
TableListItemPanelWidget.RegisterChildComponent(MapComponent) Method
Called from dymaptic.GeoBlazor.Core.Components.MapComponent.OnInitializedAsync to “Register” the current component with its parent.
public override System.Threading.Tasks.Task RegisterChildComponent(dymaptic.GeoBlazor.Core.Components.MapComponent child);
Parameters
child MapComponent
The calling, child component to register
Returns
Exceptions
InvalidChildElementException
Throws if the current child is not a valid sub-component to the parent.
Remarks
This method is an implementation detail and should not be called directly by consumers. In future versions, this may be changed to an internal method. If you see no other way to register a child component, please open an issue on GitHub.
TableListItemPanelWidget.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
TableListItemPanelWidget.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
TableListItemPanelWidget.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
TableListItemPanelWidget.SetListItem(TableListListItem) Method
Asynchronously set the value of the ListItem property after render.
public System.Threading.Tasks.Task SetListItem(dymaptic.GeoBlazor.Pro.Components.TableListListItem? value);
Parameters
value TableListListItem
The value to set.
Returns
TableListItemPanelWidget.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
TableListItemPanelWidget.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
TableListItemPanelWidget.UnregisterChildComponent(MapComponent) Method
Undoes the “Registration” of a child with its parent.
public override System.Threading.Tasks.Task UnregisterChildComponent(dymaptic.GeoBlazor.Core.Components.MapComponent child);
Parameters
child MapComponent
The child to unregister
Returns
Remarks
This method is an implementation detail and should not be called directly by consumers. In future versions, this may be changed to an internal method.
TableListItemPanelWidget.ValidateRequiredChildren() Method
When a MapView is prepared to render, this will check to make sure that all properties with the RequiredPropertyAttribute are provided.
public override void ValidateRequiredChildren();
Implements ValidateRequiredChildren()
Exceptions
MissingRequiredChildElementException
The consumer needs to provide the missing child component
MissingRequiredOptionsChildElementException
The consumer needs to provide ONE of the options of child components