GeoBlazor Pro
dymaptic.GeoBlazor.Pro
dymaptic.GeoBlazor.Pro.Components.Widgets
FeatureTemplatesWidget Class
The FeatureTemplates widget is part of the overall editing workflow.
ArcGIS Maps SDK for JavaScript
public class FeatureTemplatesWidget : dymaptic.GeoBlazor.Pro.Components.Widgets.ProWidget
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 dymaptic.GeoBlazor.Core.Components.MapComponent 🡒 dymaptic.GeoBlazor.Core.Components.Widgets.Widget 🡒 ProWidget 🡒 FeatureTemplatesWidget
Constructors
FeatureTemplatesWidget() Constructor
Parameterless constructor for use as a Razor Component.
public FeatureTemplatesWidget();
FeatureTemplatesWidget(string, Nullable, Nullable, FilterFunction, string, GroupByFunction, Nullable, string, string, IReadOnlyList, MapView, Nullable, Nullable, string, FeatureTemplatesViewModel, Nullable, FeatureTemplatesVisibleElements, string) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public FeatureTemplatesWidget(string? containerId=null, System.Nullable<bool> disabled=null, System.Nullable<bool> enableListScroll=null, dymaptic.GeoBlazor.Core.Functions.FilterFunction? filterFunction=null, string? filterText=null, dymaptic.GeoBlazor.Core.Functions.GroupByFunction? groupByFunctionGroupBy=null, System.Nullable<int> headingLevel=null, string? icon=null, string? label=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Interfaces.IFeatureTemplatesWidgetLayers>? layers=null, dymaptic.GeoBlazor.Core.Components.Views.MapView? mapView=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.OverlayPosition> position=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.SelectionMode> selectionMode=null, string? stringGroupBy=null, dymaptic.GeoBlazor.Pro.Components.FeatureTemplatesViewModel? viewModel=null, System.Nullable<bool> visible=null, dymaptic.GeoBlazor.Pro.Components.FeatureTemplatesVisibleElements? visibleElements=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.
disabled System.Nullable<System.Boolean>
Used to disable the widget user interface.
default false
ArcGIS Maps SDK for JavaScript
enableListScroll System.Nullable<System.Boolean>
Indicates whether the list of available feature template items should scroll within its containing element.
default true
ArcGIS Maps SDK for JavaScript
filterFunction dymaptic.GeoBlazor.Core.Functions.FilterFunction
Function can be defined to help filter
template items within the widget.
ArcGIS Maps SDK for JavaScript
filterText System.String
Text used to filter items.
ArcGIS Maps SDK for JavaScript
groupByFunctionGroupBy dymaptic.GeoBlazor.Core.Functions.GroupByFunction
It is possible to group template items.
default “layer”
ArcGIS Maps SDK for JavaScript
headingLevel System.Nullable<System.Int32>
Indicates the heading level to use for the labels of grouped feature templates.
default 4
ArcGIS Maps SDK for JavaScript
icon System.String
Icon displayed in the widget’s button.
default “list-rectangle”
ArcGIS Maps SDK for JavaScript
label System.String
The widget’s default label.
ArcGIS Maps SDK for JavaScript
layers System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Interfaces.IFeatureTemplatesWidgetLayers>
An array of FeatureLayers
to display within the widget.
ArcGIS Maps SDK for JavaScript
mapView dymaptic.GeoBlazor.Core.Components.Views.MapView
If the Widget is defined outside of the MapView, this link is required to connect them together.
position System.Nullable<dymaptic.GeoBlazor.Core.Enums.OverlayPosition>
The position of the widget in relation to the map view.
selectionMode System.Nullable<dymaptic.GeoBlazor.Core.Enums.SelectionMode>
Specifies the selection behavior of list items.
ArcGIS Maps SDK for JavaScript
stringGroupBy System.String
It is possible to group template items.
default “layer”
ArcGIS Maps SDK for JavaScript
viewModel FeatureTemplatesViewModel
The view model for this widget.
ArcGIS Maps SDK for JavaScript
visible System.Nullable<System.Boolean>
Indicates whether the widget is visible.
default true
ArcGIS Maps SDK for JavaScript
visibleElements FeatureTemplatesVisibleElements
The visible elements that are displayed within the widget.
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
FeatureTemplatesWidget.Disabled Property
Used to disable the widget user interface.
default false
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> Disabled { get; set; }
Property Value
System.Nullable<System.Boolean>
FeatureTemplatesWidget.EnableListScroll Property
Indicates whether the list of available feature template items should scroll within its containing element.
default true
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> EnableListScroll { get; set; }
Property Value
System.Nullable<System.Boolean>
FeatureTemplatesWidget.FilterFunction Property
GeoBlazor DocsFunction can be defined to help filter
template items within the widget.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Functions.FilterFunction? FilterFunction { get; set; }
Property Value
dymaptic.GeoBlazor.Core.Functions.FilterFunction
FeatureTemplatesWidget.FilterText Property
Text used to filter items.
ArcGIS Maps SDK for JavaScript
public string? FilterText { get; set; }
Property Value
FeatureTemplatesWidget.GroupByFunctionGroupBy Property
It is possible to group template items.
default “layer”
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Functions.GroupByFunction? GroupByFunctionGroupBy { get; set; }
Property Value
dymaptic.GeoBlazor.Core.Functions.GroupByFunction
FeatureTemplatesWidget.HasFilterFunction Property
A convenience property that signifies whether a custom FilterFunction function was registered.
public bool HasFilterFunction { get; }
Property Value
FeatureTemplatesWidget.HasGroupByFunctionGroupBy Property
A convenience property that signifies whether a custom GroupByFunctionGroupBy function was registered.
public bool HasGroupByFunctionGroupBy { get; }
Property Value
FeatureTemplatesWidget.HasSelectListener Property
Used in JavaScript layer to determine if the event listener is registered.
public bool HasSelectListener { get; }
Property Value
FeatureTemplatesWidget.HeadingLevel Property
Indicates the heading level to use for the labels of grouped feature templates.
default 4
ArcGIS Maps SDK for JavaScript
public System.Nullable<int> HeadingLevel { get; set; }
Property Value
FeatureTemplatesWidget.LayerIds Property
An array of Ids for dymaptic.GeoBlazor.Core.Components.Layers.FeatureLayers to display within the widget. The order in which these layers are set in the array dictates how they display within the widget.
public System.Collections.Generic.IReadOnlyList<System.Guid>? LayerIds { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<System.Guid>
Remarks
Use either Layers or LayerIds
FeatureTemplatesWidget.Layers Property
An array of FeatureLayers to display within the widget.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Interfaces.IFeatureTemplatesWidgetLayers>? Layers { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Interfaces.IFeatureTemplatesWidgetLayers>
Remarks
Use either Layers or LayerIds
FeatureTemplatesWidget.OnSelect Property
Event Listener for Select.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Pro.Events.FeatureTemplatesSelectEvent> OnSelect { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<FeatureTemplatesSelectEvent>
FeatureTemplatesWidget.SelectionMode Property
Specifies the selection behavior of list items.
ArcGIS Maps SDK for JavaScript
public System.Nullable<dymaptic.GeoBlazor.Core.Enums.SelectionMode> SelectionMode { get; set; }
Property Value
System.Nullable<dymaptic.GeoBlazor.Core.Enums.SelectionMode>
FeatureTemplatesWidget.StringGroupBy Property
It is possible to group template items.
default “layer”
ArcGIS Maps SDK for JavaScript
public string? StringGroupBy { get; set; }
Property Value
FeatureTemplatesWidget.Type Property
The type of widget
public override dymaptic.GeoBlazor.Core.Enums.WidgetType Type { get; }
Property Value
dymaptic.GeoBlazor.Core.Enums.WidgetType
FeatureTemplatesWidget.ViewModel Property
The view model for this widget.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Pro.Components.FeatureTemplatesViewModel? ViewModel { get; set; }
Property Value
FeatureTemplatesWidget.VisibleElements Property
The visible elements that are displayed within the widget.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Pro.Components.FeatureTemplatesVisibleElements? VisibleElements { get; set; }
Property Value
FeatureTemplatesVisibleElements
Methods
FeatureTemplatesWidget.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>>
FeatureTemplatesWidget.GetEnableListScroll() Method
Asynchronously retrieve the current value of the EnableListScroll property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetEnableListScroll();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
FeatureTemplatesWidget.GetFilterText() Method
Asynchronously retrieve the current value of the FilterText property.
public System.Threading.Tasks.Task<string?> GetFilterText();
Returns
System.Threading.Tasks.Task<System.String>
FeatureTemplatesWidget.GetHeadingLevel() Method
Asynchronously retrieve the current value of the HeadingLevel property.
public System.Threading.Tasks.Task<System.Nullable<int>> GetHeadingLevel();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Int32>>
FeatureTemplatesWidget.GetSelectionMode() Method
Asynchronously retrieve the current value of the SelectionMode property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.SelectionMode>> GetSelectionMode();
Returns
System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.SelectionMode>>
FeatureTemplatesWidget.GetStringGroupBy() Method
Asynchronously retrieve the current value of the StringGroupBy property.
public System.Threading.Tasks.Task<string?> GetStringGroupBy();
Returns
System.Threading.Tasks.Task<System.String>
FeatureTemplatesWidget.GetViewModel() Method
Asynchronously retrieve the current value of the ViewModel property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Components.FeatureTemplatesViewModel?> GetViewModel();
Returns
System.Threading.Tasks.Task<FeatureTemplatesViewModel>
FeatureTemplatesWidget.GetVisibleElements() Method
Asynchronously retrieve the current value of the VisibleElements property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Components.FeatureTemplatesVisibleElements?> GetVisibleElements();
Returns
System.Threading.Tasks.Task<FeatureTemplatesVisibleElements>
FeatureTemplatesWidget.OnJsSelect(IJSStreamReference) Method
JavaScript-Invokable Method for internal use only.
public System.Threading.Tasks.Task OnJsSelect(Microsoft.JSInterop.IJSStreamReference jsStreamRef);
Parameters
jsStreamRef Microsoft.JSInterop.IJSStreamReference
Returns
FeatureTemplatesWidget.Select(TemplateItem) Method
Selects the template item to use.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task Select(dymaptic.GeoBlazor.Pro.Model.TemplateItem item);
Parameters
item TemplateItem
The template item to select.
Returns
FeatureTemplatesWidget.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
FeatureTemplatesWidget.SetEnableListScroll(Nullable) Method
Asynchronously set the value of the EnableListScroll property after render.
public System.Threading.Tasks.Task SetEnableListScroll(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
FeatureTemplatesWidget.SetFilterText(string) Method
Asynchronously set the value of the FilterText property after render.
public System.Threading.Tasks.Task SetFilterText(string? value);
Parameters
value System.String
The value to set.
Returns
FeatureTemplatesWidget.SetHeadingLevel(Nullable) Method
Asynchronously set the value of the HeadingLevel property after render.
public System.Threading.Tasks.Task SetHeadingLevel(System.Nullable<int> value);
Parameters
value System.Nullable<System.Int32>
The value to set.
Returns
FeatureTemplatesWidget.SetSelectionMode(Nullable) Method
Asynchronously set the value of the SelectionMode property after render.
public System.Threading.Tasks.Task SetSelectionMode(System.Nullable<dymaptic.GeoBlazor.Core.Enums.SelectionMode> value);
Parameters
value System.Nullable<dymaptic.GeoBlazor.Core.Enums.SelectionMode>
The value to set.
Returns
FeatureTemplatesWidget.SetStringGroupBy(string) Method
Asynchronously set the value of the StringGroupBy property after render.
public System.Threading.Tasks.Task SetStringGroupBy(string? value);
Parameters
value System.String
The value to set.
Returns
FeatureTemplatesWidget.SetViewModel(FeatureTemplatesViewModel) Method
Asynchronously set the value of the ViewModel property after render.
public System.Threading.Tasks.Task SetViewModel(dymaptic.GeoBlazor.Pro.Components.FeatureTemplatesViewModel? value);
Parameters
value FeatureTemplatesViewModel
The value to set.
Returns
FeatureTemplatesWidget.SetVisibleElements(FeatureTemplatesVisibleElements) Method
Asynchronously set the value of the VisibleElements property after render.
public System.Threading.Tasks.Task SetVisibleElements(dymaptic.GeoBlazor.Pro.Components.FeatureTemplatesVisibleElements? value);
Parameters
value FeatureTemplatesVisibleElements
The value to set.
Returns
FeatureTemplatesWidget.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()