dymaptic.GeoBlazor.Core

dymaptic.GeoBlazor.Core.Components

HomeViewModel Class

Provides the logic for the Home component and Home widget that
animates the View to its
initial Viewpoint or a previously defined viewpoint.
ArcGIS Maps SDK for JavaScript

public class HomeViewModel : dymaptic.GeoBlazor.Core.Components.MapComponent,
dymaptic.GeoBlazor.Core.Interfaces.IViewModel,
dymaptic.GeoBlazor.Core.Interfaces.IGoTo

Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 HomeViewModel

Implements IViewModel, IGoTo

Constructors

HomeViewModel() Constructor

Parameterless constructor for use as a Razor Component.

public HomeViewModel();

HomeViewModel(GoToOverride, Viewpoint) Constructor

Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.

public HomeViewModel(dymaptic.GeoBlazor.Core.Functions.GoToOverride? goToOverride=null, dymaptic.GeoBlazor.Core.Components.Viewpoint? viewpoint=null);

Parameters

goToOverride GoToOverride(GoToOverrideParameters)

This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.
ArcGIS Maps SDK for JavaScript

viewpoint Viewpoint

The Viewpoint, or point of view, to zoom to when
going home.
default null
ArcGIS Maps SDK for JavaScript

Properties

HomeViewModel.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)

HomeViewModel.HasGoListener Property

Used in JavaScript layer to determine if the event listener is registered.

public bool HasGoListener { get; }

Property Value

System.Boolean

HomeViewModel.HasGoToOverride Property

A convenience property that signifies whether a custom GoToOverride function was registered.

public bool HasGoToOverride { get; }

Implements HasGoToOverride

Property Value

System.Boolean

HomeViewModel.OnGo Property

Indicates whether there is an event listener on the instance that matches
the provided event name.
param type The name of the event.
ArcGIS Maps SDK for JavaScript

public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Core.Events.HomeViewModelGoEvent> OnGo { get; set; }

Property Value

Microsoft.AspNetCore.Components.EventCallback<HomeViewModelGoEvent>

HomeViewModel.State Property

The current state of the widget.
default “disabled”
ArcGIS Maps SDK for JavaScript

public System.Nullable<dymaptic.GeoBlazor.Core.Enums.HomeViewModelState> State { get; set; }

Property Value

System.Nullable<HomeViewModelState>

HomeViewModel.Viewpoint Property

The Viewpoint, or point of view, to zoom to when
going home.
default null
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Components.Viewpoint? Viewpoint { get; set; }

Property Value

Viewpoint

Methods

HomeViewModel.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

System.Threading.Tasks.Task

HomeViewModel.GetState() Method

Asynchronously retrieve the current value of the State property.

public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.HomeViewModelState>> GetState();

Returns

System.Threading.Tasks.Task<System.Nullable<HomeViewModelState>>

HomeViewModel.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>

HomeViewModel.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

System.Threading.Tasks.Task

HomeViewModel.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

System.Threading.Tasks.Task

HomeViewModel.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

System.Threading.Tasks.Task

HomeViewModel.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

System.Threading.Tasks.Task

HomeViewModel.ValidateRequiredGeneratedChildren() Method

Validates source-generated child components.

public override void ValidateRequiredGeneratedChildren();

Implements ValidateRequiredGeneratedChildren()