GeoBlazor Pro
dymaptic.GeoBlazor.Pro
dymaptic.GeoBlazor.Pro.Components.Widgets
FeatureWidget Class
The Feature widget displays a graphic according to its PopupTemplate.
ArcGIS Maps SDK for JavaScript
public class FeatureWidget : dymaptic.GeoBlazor.Pro.Components.Widgets.ProWidget,
dymaptic.GeoBlazor.Core.Interfaces.IFeatureWidget,
dymaptic.GeoBlazor.Core.Interfaces.IMapComponent
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 dymaptic.GeoBlazor.Core.Components.MapComponent 🡒 dymaptic.GeoBlazor.Core.Components.Widgets.Widget 🡒 ProWidget 🡒 FeatureWidget
Implements dymaptic.GeoBlazor.Core.Interfaces.IFeatureWidget, dymaptic.GeoBlazor.Core.Interfaces.IMapComponent
Constructors
FeatureWidget() Constructor
Parameterless constructor for use as a Razor Component.
public FeatureWidget();
FeatureWidget(string, Nullable, Graphic, Nullable, string, string, Point, MapView, Nullable, SpatialReference, string, FeatureViewModel, Nullable, FeatureVisibleElements, string) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public FeatureWidget(string? containerId=null, System.Nullable<bool> defaultPopupTemplateEnabled=null, dymaptic.GeoBlazor.Core.Components.Graphic? graphic=null, System.Nullable<double> headingLevel=null, string? icon=null, string? label=null, dymaptic.GeoBlazor.Core.Components.Geometries.Point? location=null, dymaptic.GeoBlazor.Core.Components.Views.MapView? mapView=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.OverlayPosition> position=null, dymaptic.GeoBlazor.Core.Components.SpatialReference? spatialReference=null, string? timeZone=null, dymaptic.GeoBlazor.Pro.Components.FeatureViewModel? viewModel=null, System.Nullable<bool> visible=null, dymaptic.GeoBlazor.Pro.Components.FeatureVisibleElements? 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.
defaultPopupTemplateEnabled System.Nullable<System.Boolean>
Enables automatic creation of a popup template for layers that have popups enabled but no
popupTemplate defined.
default false
ArcGIS Maps SDK for JavaScript
graphic dymaptic.GeoBlazor.Core.Components.Graphic
The Graphic used to represent the feature.
default null
ArcGIS Maps SDK for JavaScript
headingLevel System.Nullable<System.Double>
Indicates the heading level to use for the title of the feature widget.
default 2
ArcGIS Maps SDK for JavaScript
icon System.String
Icon which represents the widget.
default “polygon”
ArcGIS Maps SDK for JavaScript
label System.String
The widget’s default label.
ArcGIS Maps SDK for JavaScript
location dymaptic.GeoBlazor.Core.Components.Geometries.Point
The location of the graphic to be displayed.
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.
spatialReference dymaptic.GeoBlazor.Core.Components.SpatialReference
The spatial reference used for Arcade operations.
default null
ArcGIS Maps SDK for JavaScript
timeZone System.String
Dates and times displayed in the widget will be displayed in this time zone.
ArcGIS Maps SDK for JavaScript
viewModel FeatureViewModel
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 FeatureVisibleElements
The visible elements that are displayed within the widget’s graphic.popupTemplate.content.
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
FeatureWidget.DefaultPopupTemplateEnabled Property
Enables automatic creation of a popup template for layers that have popups enabled but no
popupTemplate defined.
default false
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> DefaultPopupTemplateEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
FeatureWidget.Graphic Property
The Graphic used to represent the feature.
default null
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.Graphic? Graphic { get; set; }
Property Value
dymaptic.GeoBlazor.Core.Components.Graphic
FeatureWidget.HeadingLevel Property
Indicates the heading level to use for the title of the feature widget.
default 2
ArcGIS Maps SDK for JavaScript
public System.Nullable<double> HeadingLevel { get; set; }
Property Value
System.Nullable<System.Double>
FeatureWidget.Location Property
The location of the graphic to be displayed.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.Geometries.Point? Location { get; set; }
Property Value
dymaptic.GeoBlazor.Core.Components.Geometries.Point
FeatureWidget.SpatialReference Property
The spatial reference used for Arcade operations.
default null
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.SpatialReference? SpatialReference { get; set; }
Property Value
dymaptic.GeoBlazor.Core.Components.SpatialReference
FeatureWidget.TimeZone Property
Dates and times displayed in the widget will be displayed in this time zone.
ArcGIS Maps SDK for JavaScript
public string? TimeZone { get; set; }
Property Value
FeatureWidget.Title Property
The title for the feature.
default null
ArcGIS Maps SDK for JavaScript
public string? Title { get; set; }
Property Value
FeatureWidget.Type Property
The type of widget
public override dymaptic.GeoBlazor.Core.Enums.WidgetType Type { get; }
Property Value
dymaptic.GeoBlazor.Core.Enums.WidgetType
FeatureWidget.ViewModel Property
The view model for this widget.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Pro.Components.FeatureViewModel? ViewModel { get; set; }
Property Value
FeatureWidget.VisibleElements Property
The visible elements that are displayed within the widget’s graphic.popupTemplate.content.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Pro.Components.FeatureVisibleElements? VisibleElements { get; set; }
Property Value
Methods
FeatureWidget.GetDefaultPopupTemplateEnabled() Method
Asynchronously retrieve the current value of the DefaultPopupTemplateEnabled property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetDefaultPopupTemplateEnabled();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
FeatureWidget.GetGraphic() Method
Asynchronously retrieve the current value of the Graphic property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Graphic?> GetGraphic();
Returns
System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Graphic>
FeatureWidget.GetHeadingLevel() Method
Asynchronously retrieve the current value of the HeadingLevel property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetHeadingLevel();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
FeatureWidget.GetLocation() Method
Asynchronously retrieve the current value of the Location property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Geometries.Point?> GetLocation();
Returns
System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Geometries.Point>
FeatureWidget.GetSpatialReference() Method
Asynchronously retrieve the current value of the SpatialReference property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.SpatialReference?> GetSpatialReference();
Returns
System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.SpatialReference>
FeatureWidget.GetTimeZone() Method
Asynchronously retrieve the current value of the TimeZone property.
public System.Threading.Tasks.Task<string?> GetTimeZone();
Returns
System.Threading.Tasks.Task<System.String>
FeatureWidget.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>
FeatureWidget.GetViewModel() Method
Asynchronously retrieve the current value of the ViewModel property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Components.FeatureViewModel?> GetViewModel();
Returns
System.Threading.Tasks.Task<FeatureViewModel>
FeatureWidget.GetVisibleElements() Method
Asynchronously retrieve the current value of the VisibleElements property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Components.FeatureVisibleElements?> GetVisibleElements();
Returns
System.Threading.Tasks.Task<FeatureVisibleElements>
FeatureWidget.NextMedia(int) Method
Paginates to the next media info.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task NextMedia(int contentElementIndex);
Parameters
contentElementIndex System.Int32
The index position of the media content element.
Returns
FeatureWidget.PreviousMedia(int) Method
Paginates to the previous media info in the specified
media content element.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task PreviousMedia(int contentElementIndex);
Parameters
contentElementIndex System.Int32
The index position of the media content element.
Returns
FeatureWidget.SetActiveMedia(int, int) Method
Paginates to a specified media info object.
param mediaInfoIndex The index position of the media info object you wish to display.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task SetActiveMedia(int contentElementIndex, int mediaInfoIndex);
Parameters
contentElementIndex System.Int32
The index position of the media content element to be updated.
mediaInfoIndex System.Int32
Returns
FeatureWidget.SetDefaultPopupTemplateEnabled(Nullable) Method
Asynchronously set the value of the DefaultPopupTemplateEnabled property after render.
public System.Threading.Tasks.Task SetDefaultPopupTemplateEnabled(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
FeatureWidget.SetGraphic(Graphic) Method
Asynchronously set the value of the Graphic property after render.
public System.Threading.Tasks.Task SetGraphic(dymaptic.GeoBlazor.Core.Components.Graphic? value);
Parameters
value dymaptic.GeoBlazor.Core.Components.Graphic
The value to set.
Returns
FeatureWidget.SetHeadingLevel(Nullable) Method
Asynchronously set the value of the HeadingLevel property after render.
public System.Threading.Tasks.Task SetHeadingLevel(System.Nullable<double> value);
Parameters
value System.Nullable<System.Double>
The value to set.
Returns
FeatureWidget.SetLocation(Point) Method
Asynchronously set the value of the Location property after render.
public System.Threading.Tasks.Task SetLocation(dymaptic.GeoBlazor.Core.Components.Geometries.Point? value);
Parameters
value dymaptic.GeoBlazor.Core.Components.Geometries.Point
The value to set.
Returns
FeatureWidget.SetSpatialReference(SpatialReference) Method
Asynchronously set the value of the SpatialReference property after render.
public System.Threading.Tasks.Task SetSpatialReference(dymaptic.GeoBlazor.Core.Components.SpatialReference? value);
Parameters
value dymaptic.GeoBlazor.Core.Components.SpatialReference
The value to set.
Returns
FeatureWidget.SetTimeZone(string) Method
Asynchronously set the value of the TimeZone property after render.
public System.Threading.Tasks.Task SetTimeZone(string? value);
Parameters
value System.String
The value to set.
Returns
FeatureWidget.SetViewModel(FeatureViewModel) Method
Asynchronously set the value of the ViewModel property after render.
public System.Threading.Tasks.Task SetViewModel(dymaptic.GeoBlazor.Pro.Components.FeatureViewModel? value);
Parameters
value FeatureViewModel
The value to set.
Returns
FeatureWidget.SetVisibleElements(FeatureVisibleElements) Method
Asynchronously set the value of the VisibleElements property after render.
public System.Threading.Tasks.Task SetVisibleElements(dymaptic.GeoBlazor.Pro.Components.FeatureVisibleElements? value);
Parameters
value FeatureVisibleElements
The value to set.
Returns
FeatureWidget.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()