dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components.Widgets
HomeWidget Class
Provides a simple widget that switches the View to its
initial Viewpoint or a previously defined viewpoint.
ArcGIS Maps SDK for JavaScript
public class HomeWidget : dymaptic.GeoBlazor.Core.Components.Widgets.Widget,
dymaptic.GeoBlazor.Core.Interfaces.IGoTo
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 Widget 🡒 HomeWidget
Implements IGoTo
Constructors
HomeWidget() Constructor
Parameterless constructor for use as a Razor Component.
public HomeWidget();
HomeWidget(string, GoToOverride, string, string, MapView, Nullable, string, HomeViewModel, Viewpoint, 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 HomeWidget(string? containerId=null, dymaptic.GeoBlazor.Core.Functions.GoToOverride? goToOverride=null, string? icon=null, string? label=null, dymaptic.GeoBlazor.Core.Components.Views.MapView? mapView=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.OverlayPosition> position=null, string? uiStrings=null, dymaptic.GeoBlazor.Core.Components.HomeViewModel? viewModel=null, dymaptic.GeoBlazor.Core.Components.Viewpoint? viewpoint=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.
goToOverride GoToOverride(GoToOverrideParameters)
This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.
ArcGIS Maps SDK for JavaScript
icon System.String
Icon displayed in the widget’s button.
default “home”
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.
uiStrings System.String
Overwrite localized strings for this widget.
ArcGIS Maps SDK for JavaScript
viewModel HomeViewModel
The view model for this widget.
ArcGIS Maps SDK for JavaScript
viewpoint Viewpoint
The Viewpoint, or point of view, to zoom to when
going home.
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
HomeWidget.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
GoToOverride(GoToOverrideParameters)
HomeWidget.HasGoListener Property
Used in JavaScript layer to determine if the event listener is registered.
public bool HasGoListener { get; }
Property Value
HomeWidget.HasGoToOverride Property
A convenience property that signifies whether a custom GoToOverride function was registered.
public bool HasGoToOverride { get; }
Implements HasGoToOverride
Property Value
HomeWidget.OnGo Property
Event Listener for Go.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Core.Events.HomeGoEvent> OnGo { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<HomeGoEvent>
HomeWidget.Type Property
The type of widget
public override dymaptic.GeoBlazor.Core.Enums.WidgetType Type { get; }
Property Value
HomeWidget.UiStrings Property
Overwrite localized strings for this widget.
ArcGIS Maps SDK for JavaScript
public string? UiStrings { get; set; }
Property Value
HomeWidget.ViewModel Property
The view model for this widget.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.HomeViewModel? ViewModel { get; set; }
Property Value
HomeWidget.Viewpoint Property
The Viewpoint, or point of view, to zoom to when
going home.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.Viewpoint? Viewpoint { get; set; }
Property Value
Methods
HomeWidget.CancelGo() Method
This function provides the ability to interrupt and cancel the process
of navigating the view back to the view’s initial extent.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task CancelGo();
Returns
HomeWidget.GetUiStrings() Method
Asynchronously retrieve the current value of the UiStrings property.
public System.Threading.Tasks.Task<string?> GetUiStrings();
Returns
System.Threading.Tasks.Task<System.String>
HomeWidget.GetViewModel() Method
Asynchronously retrieve the current value of the ViewModel property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.HomeViewModel?> GetViewModel();
Returns
System.Threading.Tasks.Task<HomeViewModel>
HomeWidget.GetViewpoint() Method
Asynchronously retrieve the current value of the Viewpoint property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Viewpoint?> GetViewpoint();
Returns
System.Threading.Tasks.Task<Viewpoint>
HomeWidget.Go() Method
Animates the view to the initial Viewpoint of the view or the
value of viewpoint.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task Go();
Returns
HomeWidget.OnJsGo(IJSStreamReference) Method
JavaScript-Invokable Method for internal use only.
public System.Threading.Tasks.Task OnJsGo(Microsoft.JSInterop.IJSStreamReference jsStreamRef);
Parameters
jsStreamRef Microsoft.JSInterop.IJSStreamReference
Returns
HomeWidget.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
HomeWidget.SetUiStrings(string) Method
Asynchronously set the value of the UiStrings property after render.
public System.Threading.Tasks.Task SetUiStrings(string? value);
Parameters
value System.String
The value to set.
Returns
HomeWidget.SetViewModel(HomeViewModel) Method
Asynchronously set the value of the ViewModel property after render.
public System.Threading.Tasks.Task SetViewModel(dymaptic.GeoBlazor.Core.Components.HomeViewModel? value);
Parameters
value HomeViewModel
The value to set.
Returns
HomeWidget.SetViewpoint(Viewpoint) Method
Asynchronously set the value of the Viewpoint property after render.
public System.Threading.Tasks.Task SetViewpoint(dymaptic.GeoBlazor.Core.Components.Viewpoint? value);
Parameters
value Viewpoint
The value to set.
Returns
HomeWidget.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()