GeoBlazor Pro
dymaptic.GeoBlazor.Pro
dymaptic.GeoBlazor.Pro.Components.Widgets
CoordinateConversionWidget Class
The CoordinateConversion widget provides a way to display user cursor position either as map coordinates or
as any of several popular coordinate notations.
ArcGIS Maps SDK for JavaScript
public class CoordinateConversionWidget : dymaptic.GeoBlazor.Pro.Components.Widgets.ProWidget,
dymaptic.GeoBlazor.Core.Interfaces.IGoTo
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 dymaptic.GeoBlazor.Core.Components.MapComponent 🡒 dymaptic.GeoBlazor.Core.Components.Widgets.Widget 🡒 ProWidget 🡒 CoordinateConversionWidget
Implements dymaptic.GeoBlazor.Core.Interfaces.IGoTo
Constructors
CoordinateConversionWidget() Constructor
Parameterless constructor for use as a Razor Component.
public CoordinateConversionWidget();
CoordinateConversionWidget(string, IReadOnlyList, IReadOnlyList, GoToOverride, Nullable, string, string, Symbol, MapView, Nullable, Nullable, Orientation, Nullable, Nullable, Nullable, CoordinateConversionViewModel, Nullable, CoordinateConversionVisibleElements, string) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public CoordinateConversionWidget(string? containerId=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Components.Conversion>? conversions=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Components.ConversionFormat>? formats=null, dymaptic.GeoBlazor.Core.Functions.GoToOverride? goToOverride=null, System.Nullable<double> headingLevel=null, string? icon=null, string? label=null, dymaptic.GeoBlazor.Core.Components.Symbols.Symbol? locationSymbol=null, dymaptic.GeoBlazor.Core.Components.Views.MapView? mapView=null, System.Nullable<dymaptic.GeoBlazor.Pro.Enums.CoordinateConversionMode> mode=null, System.Nullable<bool> multipleConversions=null, dymaptic.GeoBlazor.Core.Components.Orientation? orientation=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.OverlayPosition> position=null, System.Nullable<bool> storageEnabled=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.StorageType> storageType=null, dymaptic.GeoBlazor.Pro.Model.CoordinateConversionViewModel? viewModel=null, System.Nullable<bool> visible=null, dymaptic.GeoBlazor.Pro.Components.CoordinateConversionVisibleElements? 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.
conversions System.Collections.Generic.IReadOnlyList<Conversion>
A Collection containing every Conversion
that the widget is currently displaying.
ArcGIS Maps SDK for JavaScript
formats System.Collections.Generic.IReadOnlyList<ConversionFormat>
A Collection containing every Format
that the widget is capable of displaying.
ArcGIS Maps SDK for JavaScript
goToOverride dymaptic.GeoBlazor.Core.Functions.GoToOverride
This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.
ArcGIS Maps SDK for JavaScript
headingLevel System.Nullable<System.Double>
Indicates the heading level to use for the coordinate input and coordinate settings headings.
default 4
ArcGIS Maps SDK for JavaScript
icon System.String
Icon which represents the widget.
default “coordinate-system”
ArcGIS Maps SDK for JavaScript
label System.String
The widget’s default label.
ArcGIS Maps SDK for JavaScript
locationSymbol dymaptic.GeoBlazor.Core.Components.Symbols.Symbol
This symbol is used to visualize the location currently described by the widget when capture mode
is active.
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.
mode System.Nullable<CoordinateConversionMode>
Describes the current mode of the widget.
default “live”
ArcGIS Maps SDK for JavaScript
multipleConversions System.Nullable<System.Boolean>
If this property is set to true, multiple conversions can be displayed.
default true
ArcGIS Maps SDK for JavaScript
orientation dymaptic.GeoBlazor.Core.Components.Orientation
Determines whether the widget should expand up or down.
default “auto”
ArcGIS Maps SDK for JavaScript
position System.Nullable<dymaptic.GeoBlazor.Core.Enums.OverlayPosition>
The position of the widget in relation to the map view.
storageEnabled System.Nullable<System.Boolean>
If this property is set to true, sessionStorage or localStorage (depending on storageType)
will be used to hydrate and persist the CoordinateConversion widget’s state.
default true
ArcGIS Maps SDK for JavaScript
storageType System.Nullable<dymaptic.GeoBlazor.Core.Enums.StorageType>
This property determines whether sessionStorage or localStorage will be used to store widget state.
default “session”
ArcGIS Maps SDK for JavaScript
viewModel CoordinateConversionViewModel
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 CoordinateConversionVisibleElements
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
CoordinateConversionWidget.Conversions Property
A Collection containing every Conversion
that the widget is currently displaying.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Components.Conversion>? Conversions { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<Conversion>
CoordinateConversionWidget.CurrentLocation Property
Describes the location of the coordinates currently displayed by the widget as a Point.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.Geometries.Point? CurrentLocation { get; set; }
Property Value
dymaptic.GeoBlazor.Core.Components.Geometries.Point
CoordinateConversionWidget.Formats Property
A Collection containing every Format
that the widget is capable of displaying.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Components.ConversionFormat>? Formats { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<ConversionFormat>
CoordinateConversionWidget.GoToOverride Property
This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Functions.GoToOverride? GoToOverride { get; set; }
Implements GoToOverride
Property Value
dymaptic.GeoBlazor.Core.Functions.GoToOverride
CoordinateConversionWidget.HasGoToOverride Property
A convenience property that signifies whether a custom GoToOverride function was registered.
public bool HasGoToOverride { get; }
Implements HasGoToOverride
Property Value
CoordinateConversionWidget.HeadingLevel Property
Indicates the heading level to use for the coordinate input and coordinate settings headings.
default 4
ArcGIS Maps SDK for JavaScript
public System.Nullable<double> HeadingLevel { get; set; }
Property Value
System.Nullable<System.Double>
CoordinateConversionWidget.LocationSymbol Property
This symbol is used to visualize the location currently described by the widget when capture mode
is active.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.Symbols.Symbol? LocationSymbol { get; set; }
Property Value
dymaptic.GeoBlazor.Core.Components.Symbols.Symbol
CoordinateConversionWidget.Mode Property
Describes the current mode of the widget.
default “live”
ArcGIS Maps SDK for JavaScript
public System.Nullable<dymaptic.GeoBlazor.Pro.Enums.CoordinateConversionMode> Mode { get; set; }
Property Value
System.Nullable<CoordinateConversionMode>
CoordinateConversionWidget.MultipleConversions Property
If this property is set to true, multiple conversions can be displayed.
default true
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> MultipleConversions { get; set; }
Property Value
System.Nullable<System.Boolean>
CoordinateConversionWidget.Orientation Property
Determines whether the widget should expand up or down.
default “auto”
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.Orientation? Orientation { get; set; }
Property Value
dymaptic.GeoBlazor.Core.Components.Orientation
CoordinateConversionWidget.StorageEnabled Property
If this property is set to true, sessionStorage or localStorage (depending on storageType)
will be used to hydrate and persist the CoordinateConversion widget’s state.
default true
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> StorageEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
CoordinateConversionWidget.StorageType Property
This property determines whether sessionStorage or localStorage will be used to store widget state.
default “session”
ArcGIS Maps SDK for JavaScript
public System.Nullable<dymaptic.GeoBlazor.Core.Enums.StorageType> StorageType { get; set; }
Property Value
System.Nullable<dymaptic.GeoBlazor.Core.Enums.StorageType>
CoordinateConversionWidget.Type Property
The type of widget
public override dymaptic.GeoBlazor.Core.Enums.WidgetType Type { get; }
Property Value
dymaptic.GeoBlazor.Core.Enums.WidgetType
CoordinateConversionWidget.ViewModel Property
The view model for this widget.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Pro.Model.CoordinateConversionViewModel? ViewModel { get; set; }
Property Value
CoordinateConversionWidget.VisibleElements Property
The visible elements that are displayed within the widget.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Pro.Components.CoordinateConversionVisibleElements? VisibleElements { get; set; }
Property Value
CoordinateConversionVisibleElements
Methods
CoordinateConversionWidget.AddToConversions(Conversion[]) Method
Asynchronously adds elements to the Conversions property.
public System.Threading.Tasks.Task AddToConversions(params dymaptic.GeoBlazor.Pro.Components.Conversion[] values);
Parameters
values Conversion[]
The elements to add.
Returns
CoordinateConversionWidget.AddToFormats(ConversionFormat[]) Method
Asynchronously adds elements to the Formats property.
public System.Threading.Tasks.Task AddToFormats(params dymaptic.GeoBlazor.Pro.Components.ConversionFormat[] values);
Parameters
values ConversionFormat[]
The elements to add.
Returns
CoordinateConversionWidget.GetConversions() Method
Asynchronously retrieve the current value of the Conversions property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Components.Conversion>?> GetConversions();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Conversion>>
CoordinateConversionWidget.GetCurrentLocation() Method
Asynchronously retrieve the current value of the CurrentLocation property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Geometries.Point?> GetCurrentLocation();
Returns
System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Geometries.Point>
CoordinateConversionWidget.GetFormats() Method
Asynchronously retrieve the current value of the Formats property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Components.ConversionFormat>?> GetFormats();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<ConversionFormat>>
CoordinateConversionWidget.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>>
CoordinateConversionWidget.GetLocationSymbol() Method
Asynchronously retrieve the current value of the LocationSymbol property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Symbols.Symbol?> GetLocationSymbol();
Returns
System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Symbols.Symbol>
CoordinateConversionWidget.GetMode() Method
Asynchronously retrieve the current value of the Mode property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Pro.Enums.CoordinateConversionMode>> GetMode();
Returns
System.Threading.Tasks.Task<System.Nullable<CoordinateConversionMode>>
CoordinateConversionWidget.GetMultipleConversions() Method
Asynchronously retrieve the current value of the MultipleConversions property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetMultipleConversions();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
CoordinateConversionWidget.GetOrientation() Method
Asynchronously retrieve the current value of the Orientation property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Orientation?> GetOrientation();
Returns
System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Orientation>
CoordinateConversionWidget.GetStorageEnabled() Method
Asynchronously retrieve the current value of the StorageEnabled property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetStorageEnabled();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
CoordinateConversionWidget.GetStorageType() Method
Asynchronously retrieve the current value of the StorageType property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.StorageType>> GetStorageType();
Returns
System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.StorageType>>
CoordinateConversionWidget.GetViewModel() Method
Asynchronously retrieve the current value of the ViewModel property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Model.CoordinateConversionViewModel?> GetViewModel();
Returns
System.Threading.Tasks.Task<CoordinateConversionViewModel>
CoordinateConversionWidget.GetVisibleElements() Method
Asynchronously retrieve the current value of the VisibleElements property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Components.CoordinateConversionVisibleElements?> GetVisibleElements();
Returns
System.Threading.Tasks.Task<CoordinateConversionVisibleElements>
CoordinateConversionWidget.OnJsGoToOverride(IJSStreamReference) Method
JS-invokable method that triggers the GoToOverride function.
Should not be called by consuming code.
public System.Threading.Tasks.Task OnJsGoToOverride(Microsoft.JSInterop.IJSStreamReference jsStreamRef);
Parameters
jsStreamRef Microsoft.JSInterop.IJSStreamReference
Implements OnJsGoToOverride(IJSStreamReference)
Returns
CoordinateConversionWidget.RemoveFromConversions(Conversion[]) Method
Asynchronously remove an element from the Conversions property.
public System.Threading.Tasks.Task RemoveFromConversions(params dymaptic.GeoBlazor.Pro.Components.Conversion[] values);
Parameters
values Conversion[]
The elements to remove.
Returns
CoordinateConversionWidget.RemoveFromFormats(ConversionFormat[]) Method
Asynchronously remove an element from the Formats property.
public System.Threading.Tasks.Task RemoveFromFormats(params dymaptic.GeoBlazor.Pro.Components.ConversionFormat[] values);
Parameters
values ConversionFormat[]
The elements to remove.
Returns
CoordinateConversionWidget.ReverseConvert(string, ConversionFormat) Method
Attempt to convert a string into a Point.
param format Specifies the format of the input coordinate.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Geometries.Point?> ReverseConvert(string coordinate, dymaptic.GeoBlazor.Pro.Components.ConversionFormat ConversionFormat);
Parameters
coordinate System.String
The coordinate string.
ConversionFormat ConversionFormat
Returns
System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Geometries.Point>
CoordinateConversionWidget.SetConversions(IReadOnlyList) Method
Asynchronously set the value of the Conversions property after render.
public System.Threading.Tasks.Task SetConversions(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Components.Conversion>? value);
Parameters
value System.Collections.Generic.IReadOnlyList<Conversion>
The value to set.
Returns
CoordinateConversionWidget.SetFormats(IReadOnlyList) Method
Asynchronously set the value of the Formats property after render.
public System.Threading.Tasks.Task SetFormats(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Components.ConversionFormat>? value);
Parameters
value System.Collections.Generic.IReadOnlyList<ConversionFormat>
The value to set.
Returns
CoordinateConversionWidget.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
CoordinateConversionWidget.SetLocationSymbol(Symbol) Method
Asynchronously set the value of the LocationSymbol property after render.
public System.Threading.Tasks.Task SetLocationSymbol(dymaptic.GeoBlazor.Core.Components.Symbols.Symbol? value);
Parameters
value dymaptic.GeoBlazor.Core.Components.Symbols.Symbol
The value to set.
Returns
CoordinateConversionWidget.SetMode(Nullable) Method
Asynchronously set the value of the Mode property after render.
public System.Threading.Tasks.Task SetMode(System.Nullable<dymaptic.GeoBlazor.Pro.Enums.CoordinateConversionMode> value);
Parameters
value System.Nullable<CoordinateConversionMode>
The value to set.
Returns
CoordinateConversionWidget.SetMultipleConversions(Nullable) Method
Asynchronously set the value of the MultipleConversions property after render.
public System.Threading.Tasks.Task SetMultipleConversions(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
CoordinateConversionWidget.SetOrientation(Orientation) Method
Asynchronously set the value of the Orientation property after render.
public System.Threading.Tasks.Task SetOrientation(dymaptic.GeoBlazor.Core.Components.Orientation? value);
Parameters
value dymaptic.GeoBlazor.Core.Components.Orientation
The value to set.
Returns
CoordinateConversionWidget.SetStorageEnabled(Nullable) Method
Asynchronously set the value of the StorageEnabled property after render.
public System.Threading.Tasks.Task SetStorageEnabled(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
CoordinateConversionWidget.SetStorageType(Nullable) Method
Asynchronously set the value of the StorageType property after render.
public System.Threading.Tasks.Task SetStorageType(System.Nullable<dymaptic.GeoBlazor.Core.Enums.StorageType> value);
Parameters
value System.Nullable<dymaptic.GeoBlazor.Core.Enums.StorageType>
The value to set.
Returns
CoordinateConversionWidget.SetViewModel(CoordinateConversionViewModel) Method
Asynchronously set the value of the ViewModel property after render.
public System.Threading.Tasks.Task SetViewModel(dymaptic.GeoBlazor.Pro.Model.CoordinateConversionViewModel? value);
Parameters
value CoordinateConversionViewModel
The value to set.
Returns
CoordinateConversionWidget.SetVisibleElements(CoordinateConversionVisibleElements) Method
Asynchronously set the value of the VisibleElements property after render.
public System.Threading.Tasks.Task SetVisibleElements(dymaptic.GeoBlazor.Pro.Components.CoordinateConversionVisibleElements? value);
Parameters
value CoordinateConversionVisibleElements
The value to set.
Returns
CoordinateConversionWidget.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()