dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components.Widgets
AreaMeasurement2DWidget Class
The AreaMeasurement2D widget calculates and displays the area and perimeter of a polygon in a
MapView.
ArcGIS Maps SDK for JavaScript
public class AreaMeasurement2DWidget : dymaptic.GeoBlazor.Core.Components.Widgets.Widget,
dymaptic.GeoBlazor.Core.Interfaces.IMeasurementWidgetActiveWidget,
dymaptic.GeoBlazor.Core.Interfaces.IMapComponent
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 Widget 🡒 AreaMeasurement2DWidget
Implements IMeasurementWidgetActiveWidget, IMapComponent
Constructors
AreaMeasurement2DWidget() Constructor
Parameterless constructor for use as a Razor Component.
public AreaMeasurement2DWidget();
AreaMeasurement2DWidget(string, string, string, MapView, Nullable, SnappingOptions, Nullable, IReadOnlyList, AreaMeasurement2DViewModel, 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 AreaMeasurement2DWidget(string? containerId=null, string? icon=null, string? label=null, dymaptic.GeoBlazor.Core.Components.Views.MapView? mapView=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.OverlayPosition> position=null, dymaptic.GeoBlazor.Core.Components.SnappingOptions? snappingOptions=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.SystemOrAreaUnit> unit=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Enums.SystemOrAreaUnit>? unitOptions=null, dymaptic.GeoBlazor.Core.Components.AreaMeasurement2DViewModel? viewModel=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.
icon System.String
Icon which represents the widget.
default “measure-area”
ArcGIS Maps SDK for JavaScript
label System.String
The widget’s default 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.
position System.Nullable<OverlayPosition>
The position of the widget in relation to the map view.
snappingOptions SnappingOptions
The SnappingOptions for sketching.
ArcGIS Maps SDK for JavaScript
unit System.Nullable<SystemOrAreaUnit>
Unit system (imperial, metric) or specific unit used for displaying the area values.
ArcGIS Maps SDK for JavaScript
unitOptions System.Collections.Generic.IReadOnlyList<SystemOrAreaUnit>
List of available units and unit systems (imperial, metric) for displaying the area values.
ArcGIS Maps SDK for JavaScript
viewModel AreaMeasurement2DViewModel
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
widgetId System.String
The unique ID assigned to the widget when the widget is created.
ArcGIS Maps SDK for JavaScript
Properties
AreaMeasurement2DWidget.SnappingOptions Property
The SnappingOptions for sketching.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.SnappingOptions? SnappingOptions { get; set; }
Property Value
AreaMeasurement2DWidget.Type Property
The type of widget
public override dymaptic.GeoBlazor.Core.Enums.WidgetType Type { get; }
Property Value
AreaMeasurement2DWidget.Unit Property
Unit system (imperial, metric) or specific unit used for displaying the area values.
ArcGIS Maps SDK for JavaScript
public System.Nullable<dymaptic.GeoBlazor.Core.Enums.SystemOrAreaUnit> Unit { get; set; }
Property Value
System.Nullable<SystemOrAreaUnit>
AreaMeasurement2DWidget.UnitOptions Property
List of available units and unit systems (imperial, metric) for displaying the area values.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Enums.SystemOrAreaUnit>? UnitOptions { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<SystemOrAreaUnit>
AreaMeasurement2DWidget.ViewModel Property
The view model for this widget.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.AreaMeasurement2DViewModel? ViewModel { get; set; }
Property Value
Methods
AreaMeasurement2DWidget.AddToUnitOptions(SystemOrAreaUnit[]) Method
Asynchronously adds elements to the UnitOptions property.
public System.Threading.Tasks.Task AddToUnitOptions(params dymaptic.GeoBlazor.Core.Enums.SystemOrAreaUnit[] values);
Parameters
values SystemOrAreaUnit[]
The elements to add.
Returns
AreaMeasurement2DWidget.GetSnappingOptions() Method
Asynchronously retrieve the current value of the SnappingOptions property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.SnappingOptions?> GetSnappingOptions();
Returns
System.Threading.Tasks.Task<SnappingOptions>
AreaMeasurement2DWidget.GetUnit() Method
Asynchronously retrieve the current value of the Unit property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.SystemOrAreaUnit>> GetUnit();
Returns
System.Threading.Tasks.Task<System.Nullable<SystemOrAreaUnit>>
AreaMeasurement2DWidget.GetUnitOptions() Method
Asynchronously retrieve the current value of the UnitOptions property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Enums.SystemOrAreaUnit>?> GetUnitOptions();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<SystemOrAreaUnit>>
AreaMeasurement2DWidget.GetViewModel() Method
Asynchronously retrieve the current value of the ViewModel property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.AreaMeasurement2DViewModel?> GetViewModel();
Returns
System.Threading.Tasks.Task<AreaMeasurement2DViewModel>
AreaMeasurement2DWidget.RemoveFromUnitOptions(SystemOrAreaUnit[]) Method
Asynchronously remove an element from the UnitOptions property.
public System.Threading.Tasks.Task RemoveFromUnitOptions(params dymaptic.GeoBlazor.Core.Enums.SystemOrAreaUnit[] values);
Parameters
values SystemOrAreaUnit[]
The elements to remove.
Returns
AreaMeasurement2DWidget.SetSnappingOptions(SnappingOptions) Method
Asynchronously set the value of the SnappingOptions property after render.
public System.Threading.Tasks.Task SetSnappingOptions(dymaptic.GeoBlazor.Core.Components.SnappingOptions? value);
Parameters
value SnappingOptions
The value to set.
Returns
AreaMeasurement2DWidget.SetUnit(Nullable) Method
Asynchronously set the value of the Unit property after render.
public System.Threading.Tasks.Task SetUnit(System.Nullable<dymaptic.GeoBlazor.Core.Enums.SystemOrAreaUnit> value);
Parameters
value System.Nullable<SystemOrAreaUnit>
The value to set.
Returns
AreaMeasurement2DWidget.SetUnitOptions(IReadOnlyList) Method
Asynchronously set the value of the UnitOptions property after render.
public System.Threading.Tasks.Task SetUnitOptions(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Enums.SystemOrAreaUnit>? value);
Parameters
value System.Collections.Generic.IReadOnlyList<SystemOrAreaUnit>
The value to set.
Returns
AreaMeasurement2DWidget.SetViewModel(AreaMeasurement2DViewModel) Method
Asynchronously set the value of the ViewModel property after render.
public System.Threading.Tasks.Task SetViewModel(dymaptic.GeoBlazor.Core.Components.AreaMeasurement2DViewModel? value);
Parameters
value AreaMeasurement2DViewModel
The value to set.
Returns
AreaMeasurement2DWidget.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()