dymaptic.GeoBlazor.Core

dymaptic.GeoBlazor.Core.Components

BookmarksViewModel Class

Provides the logic for the Bookmarks widget.
ArcGIS Maps SDK for JavaScript

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

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

Implements IViewModel, IGoTo

Constructors

BookmarksViewModel() Constructor

Parameterless constructor for use as a Razor Component.

public BookmarksViewModel();

BookmarksViewModel(IReadOnlyList, BookmarksCapabilities, BookmarkOptions, BookmarkOptions, GoToOverride) Constructor

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

public BookmarksViewModel(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Bookmark>? bookmarks=null, dymaptic.GeoBlazor.Core.Components.BookmarksCapabilities? capabilities=null, dymaptic.GeoBlazor.Core.Options.BookmarkOptions? defaultCreateOptions=null, dymaptic.GeoBlazor.Core.Options.BookmarkOptions? defaultEditOptions=null, dymaptic.GeoBlazor.Core.Functions.GoToOverride? goToOverride=null);

Parameters

bookmarks System.Collections.Generic.IReadOnlyList<Bookmark>

A collection of Bookmarks.
ArcGIS Maps SDK for JavaScript

capabilities BookmarksCapabilities

Defines the capabilities of the widget.
ArcGIS Maps SDK for JavaScript

defaultCreateOptions BookmarkOptions

Specifies how new bookmarks will be created.
ArcGIS Maps SDK for JavaScript

defaultEditOptions BookmarkOptions

Specifies how bookmarks will be edited.
ArcGIS Maps SDK for JavaScript

goToOverride GoToOverride(GoToOverrideParameters)

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

Properties

BookmarksViewModel.ActiveBookmark Property

The Bookmark that is being navigated to.
ArcGIS Maps SDK for JavaScript

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

Property Value

Bookmark

BookmarksViewModel.Bookmarks Property

A collection of Bookmarks.
ArcGIS Maps SDK for JavaScript

public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Bookmark>? Bookmarks { get; set; }

Property Value

System.Collections.Generic.IReadOnlyList<Bookmark>

BookmarksViewModel.Capabilities Property

Defines the capabilities of the widget.
ArcGIS Maps SDK for JavaScript

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

Property Value

BookmarksCapabilities

BookmarksViewModel.DefaultCreateOptions Property

Specifies how new bookmarks will be created.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Options.BookmarkOptions? DefaultCreateOptions { get; set; }

Property Value

BookmarkOptions

BookmarksViewModel.DefaultEditOptions Property

Specifies how bookmarks will be edited.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Options.BookmarkOptions? DefaultEditOptions { get; set; }

Property Value

BookmarkOptions

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

BookmarksViewModel.HasGoToOverride Property

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

public bool HasGoToOverride { get; }

Implements HasGoToOverride

Property Value

System.Boolean

BookmarksViewModel.State Property

The view model’s state.
default “ready”
ArcGIS Maps SDK for JavaScript

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

Property Value

System.Nullable<ViewModelState>

Methods

BookmarksViewModel.AddToBookmarks(Bookmark[]) Method

Asynchronously adds elements to the Bookmarks property.

public System.Threading.Tasks.Task AddToBookmarks(params dymaptic.GeoBlazor.Core.Components.Bookmark[] values);

Parameters

values Bookmark[]

The elements to add.

Returns

System.Threading.Tasks.Task

BookmarksViewModel.CreateBookmark(BookmarkOptions) Method

Creates a new bookmark from the defaultCreateOptions, unless otherwise specified.
ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Bookmark?> CreateBookmark(dymaptic.GeoBlazor.Core.Options.BookmarkOptions options);

Parameters

options BookmarkOptions

Specifies how new bookmarks will be created. Can be used to enable/disable taking screenshots or capturing the extent when a new bookmark is added.

Returns

System.Threading.Tasks.Task<Bookmark>

BookmarksViewModel.EditBookmark(Bookmark, BookmarkOptions) Method

Edits the given bookmark.
param options Specifies how bookmarks will be edited. Can be used to enable/disable taking screenshots or capturing the extent when a bookmark is edited. If not specified, the defaultEditOptions will be used.
ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Bookmark?> EditBookmark(dymaptic.GeoBlazor.Core.Components.Bookmark bookmark, dymaptic.GeoBlazor.Core.Options.BookmarkOptions options);

Parameters

bookmark Bookmark

The bookmark to be edited.

options BookmarkOptions

Specifies
how bookmarks will be edited. Can be used to enable/disable taking screenshots or capturing the extent when a bookmark is edited.
If not specified, the defaultEditOptions will be used.

Returns

System.Threading.Tasks.Task<Bookmark>

BookmarksViewModel.GetActiveBookmark() Method

Asynchronously retrieve the current value of the ActiveBookmark property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Bookmark?> GetActiveBookmark();

Returns

System.Threading.Tasks.Task<Bookmark>

BookmarksViewModel.GetBookmarks() Method

Asynchronously retrieve the current value of the Bookmarks property.

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Bookmark>?> GetBookmarks();

Returns

System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Bookmark>>

BookmarksViewModel.GetCapabilities() Method

Asynchronously retrieve the current value of the Capabilities property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.BookmarksCapabilities?> GetCapabilities();

Returns

System.Threading.Tasks.Task<BookmarksCapabilities>

BookmarksViewModel.GetDefaultCreateOptions() Method

Asynchronously retrieve the current value of the DefaultCreateOptions property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Options.BookmarkOptions?> GetDefaultCreateOptions();

Returns

System.Threading.Tasks.Task<BookmarkOptions>

BookmarksViewModel.GetDefaultEditOptions() Method

Asynchronously retrieve the current value of the DefaultEditOptions property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Options.BookmarkOptions?> GetDefaultEditOptions();

Returns

System.Threading.Tasks.Task<BookmarkOptions>

BookmarksViewModel.GetState() Method

Asynchronously retrieve the current value of the State property.

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

Returns

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

BookmarksViewModel.GoTo(Bookmark) Method

Zoom to a specific bookmark.
ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task<string?> GoTo(dymaptic.GeoBlazor.Core.Components.Bookmark bookmark);

Parameters

bookmark Bookmark

The bookmark to zoom to.

Returns

System.Threading.Tasks.Task<System.String>

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

BookmarksViewModel.RemoveFromBookmarks(Bookmark[]) Method

Asynchronously remove an element from the Bookmarks property.

public System.Threading.Tasks.Task RemoveFromBookmarks(params dymaptic.GeoBlazor.Core.Components.Bookmark[] values);

Parameters

values Bookmark[]

The elements to remove.

Returns

System.Threading.Tasks.Task

BookmarksViewModel.SetBookmarks(IReadOnlyList) Method

Asynchronously set the value of the Bookmarks property after render.

public System.Threading.Tasks.Task SetBookmarks(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Bookmark>? value);

Parameters

value System.Collections.Generic.IReadOnlyList<Bookmark>

The value to set.

Returns

System.Threading.Tasks.Task

BookmarksViewModel.SetCapabilities(BookmarksCapabilities) Method

Asynchronously set the value of the Capabilities property after render.

public System.Threading.Tasks.Task SetCapabilities(dymaptic.GeoBlazor.Core.Components.BookmarksCapabilities? value);

Parameters

value BookmarksCapabilities

The value to set.

Returns

System.Threading.Tasks.Task

BookmarksViewModel.SetDefaultCreateOptions(BookmarkOptions) Method

Asynchronously set the value of the DefaultCreateOptions property after render.

public System.Threading.Tasks.Task SetDefaultCreateOptions(dymaptic.GeoBlazor.Core.Options.BookmarkOptions? value);

Parameters

value BookmarkOptions

The value to set.

Returns

System.Threading.Tasks.Task

BookmarksViewModel.SetDefaultEditOptions(BookmarkOptions) Method

Asynchronously set the value of the DefaultEditOptions property after render.

public System.Threading.Tasks.Task SetDefaultEditOptions(dymaptic.GeoBlazor.Core.Options.BookmarkOptions? value);

Parameters

value BookmarkOptions

The value to set.

Returns

System.Threading.Tasks.Task

BookmarksViewModel.ValidateRequiredGeneratedChildren() Method

Validates source-generated child components.

public override void ValidateRequiredGeneratedChildren();

Implements ValidateRequiredGeneratedChildren()