dymaptic.GeoBlazor.Core

dymaptic.GeoBlazor.Core.Components.Widgets

BookmarksWidget Class

The Bookmarks widget allows end users to quickly navigate to a particular area of interest.
ArcGIS Maps SDK for JavaScript

public class BookmarksWidget : dymaptic.GeoBlazor.Core.Components.Widgets.Widget,
dymaptic.GeoBlazor.Core.Interfaces.IGoTo

Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 Widget 🡒 BookmarksWidget

Implements IGoTo

Constructors

BookmarksWidget() Constructor

Parameterless constructor for use as a Razor Component.

public BookmarksWidget();

BookmarksWidget(IReadOnlyList, string, BookmarkOptions, BookmarkOptions, Nullable, Nullable, string, string, GoToOverride, Nullable, string, string, MapView, Nullable, BookmarksViewModel, Nullable, BookmarksVisibleElements, string) Constructor

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

public BookmarksWidget(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Bookmark>? bookmarks=null, string? containerId=null, dymaptic.GeoBlazor.Core.Options.BookmarkOptions? defaultCreateOptions=null, dymaptic.GeoBlazor.Core.Options.BookmarkOptions? defaultEditOptions=null, System.Nullable<bool> disabled=null, System.Nullable<bool> dragEnabled=null, string? filterPlaceholder=null, string? filterText=null, dymaptic.GeoBlazor.Core.Functions.GoToOverride? goToOverride=null, System.Nullable<int> headingLevel=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.BookmarksViewModel? viewModel=null, System.Nullable<bool> visible=null, dymaptic.GeoBlazor.Core.Components.BookmarksVisibleElements? visibleElements=null, string? widgetId=null);

Parameters

bookmarks System.Collections.Generic.IReadOnlyList<Bookmark>

A collection of Bookmarks.
ArcGIS Maps SDK for JavaScript

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.

defaultCreateOptions BookmarkOptions

Specifies how new bookmarks will be created if visibleElements.addBookmarkButton is set to true.
ArcGIS Maps SDK for JavaScript

defaultEditOptions BookmarkOptions

Specifies how bookmarks will be edited, if visibleElements.editBookmarkButton is set to true.
ArcGIS Maps SDK for JavaScript

disabled System.Nullable<System.Boolean>

When true, the widget is visually withdrawn and cannot be interacted with.
default false
ArcGIS Maps SDK for JavaScript

dragEnabled System.Nullable<System.Boolean>

Indicates if a Bookmark is able to be dragged in order to update its position in the list.
default false
ArcGIS Maps SDK for JavaScript

filterPlaceholder System.String

Defines the text used as a placeholder when visibleElements.filter is set to true.
ArcGIS Maps SDK for JavaScript

filterText System.String

Defines the text used to filter the bookmarks when visibleElements.filter is set to true.
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

headingLevel System.Nullable<System.Int32>

Indicates the heading level to use for the message “No bookmarks” when no bookmarks
are available in this widget.
default 2
ArcGIS Maps SDK for JavaScript

icon System.String

Icon which represents the widget.
default “bookmark”
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.

viewModel BookmarksViewModel

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 BookmarksVisibleElements

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

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

BookmarksWidget.DefaultCreateOptions Property

Specifies how new bookmarks will be created if visibleElements.addBookmarkButton is set to true.
ArcGIS Maps SDK for JavaScript

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

Property Value

BookmarkOptions

BookmarksWidget.DefaultEditOptions Property

Specifies how bookmarks will be edited, if visibleElements.editBookmarkButton is set to true.
ArcGIS Maps SDK for JavaScript

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

Property Value

BookmarkOptions

BookmarksWidget.Disabled Property

When true, the widget is visually withdrawn and cannot be interacted with.

public System.Nullable<bool> Disabled { get; set; }

Property Value

System.Nullable<System.Boolean>

BookmarksWidget.DragEnabled Property

Indicates if a Bookmark is able to be dragged in order to update its position in the list.
default false
ArcGIS Maps SDK for JavaScript

public System.Nullable<bool> DragEnabled { get; set; }

Property Value

System.Nullable<System.Boolean>

BookmarksWidget.EditingEnabled Property

Indicates whether the bookmarks are able to be edited.

public System.Nullable<bool> EditingEnabled { get; set; }

Property Value

System.Nullable<System.Boolean>

BookmarksWidget.FilterPlaceholder Property

Defines the text used as a placeholder when visibleElements.filter is set to true.
ArcGIS Maps SDK for JavaScript

public string? FilterPlaceholder { get; set; }

Property Value

System.String

BookmarksWidget.FilterText Property

Defines the text used to filter the bookmarks when visibleElements.filter is set to true.
ArcGIS Maps SDK for JavaScript

public string? FilterText { get; set; }

Property Value

System.String

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

BookmarksWidget.HasBookmarkEditListener Property

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

public bool HasBookmarkEditListener { get; }

Property Value

System.Boolean

BookmarksWidget.HasBookmarkSelectListener Property

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

public bool HasBookmarkSelectListener { get; }

Property Value

System.Boolean

BookmarksWidget.HasGoToOverride Property

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

public bool HasGoToOverride { get; }

Implements HasGoToOverride

Property Value

System.Boolean

BookmarksWidget.HeadingLevel Property

Indicates the heading level to use for the message “No bookmarks” when no bookmarks are available in this widget.

public System.Nullable<int> HeadingLevel { get; set; }

Property Value

System.Nullable<System.Int32>

BookmarksWidget.OnBookmarkEdit Property

Event Listener for BookmarkEdit.

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

Property Value

Microsoft.AspNetCore.Components.EventCallback<BookmarksBookmarkEditEvent>

BookmarksWidget.OnBookmarkSelect Property

Event Listener for BookmarkSelect.

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

Property Value

Microsoft.AspNetCore.Components.EventCallback<BookmarkSelectEvent>

BookmarksWidget.Type Property

The type of widget

public override dymaptic.GeoBlazor.Core.Enums.WidgetType Type { get; }

Property Value

WidgetType

BookmarksWidget.ViewModel Property

The view model for this widget.
ArcGIS Maps SDK for JavaScript

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

Property Value

BookmarksViewModel

BookmarksWidget.VisibleElements Property

The visible elements that are displayed within the widget.
ArcGIS Maps SDK for JavaScript

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

Property Value

BookmarksVisibleElements

Methods

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

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

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

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

BookmarksWidget.GetDisabled() Method

Asynchronously retrieve the current value of the Disabled property.

public System.Threading.Tasks.Task<System.Nullable<bool>> GetDisabled();

Returns

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

BookmarksWidget.GetDragEnabled() Method

Asynchronously retrieve the current value of the DragEnabled property.

public System.Threading.Tasks.Task<System.Nullable<bool>> GetDragEnabled();

Returns

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

BookmarksWidget.GetFilterPlaceholder() Method

Asynchronously retrieve the current value of the FilterPlaceholder property.

public System.Threading.Tasks.Task<string?> GetFilterPlaceholder();

Returns

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

BookmarksWidget.GetFilterText() Method

Asynchronously retrieve the current value of the FilterText property.

public System.Threading.Tasks.Task<string?> GetFilterText();

Returns

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

BookmarksWidget.GetHeadingLevel() Method

Asynchronously retrieve the current value of the HeadingLevel property.

public System.Threading.Tasks.Task<System.Nullable<int>> GetHeadingLevel();

Returns

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

BookmarksWidget.GetViewModel() Method

Asynchronously retrieve the current value of the ViewModel property.

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

Returns

System.Threading.Tasks.Task<BookmarksViewModel>

BookmarksWidget.GetVisibleElements() Method

Asynchronously retrieve the current value of the VisibleElements property.

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

Returns

System.Threading.Tasks.Task<BookmarksVisibleElements>

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

BookmarksWidget.OnJsBookmarkEdit(IJSStreamReference) Method

JavaScript-Invokable Method for internal use only.

public System.Threading.Tasks.Task OnJsBookmarkEdit(Microsoft.JSInterop.IJSStreamReference jsStreamRef);

Parameters

jsStreamRef Microsoft.JSInterop.IJSStreamReference

Returns

System.Threading.Tasks.Task

BookmarksWidget.OnJsBookmarkSelect(IJSStreamReference) Method

JavaScript-Invokable Method for internal use only.

public System.Threading.Tasks.Task OnJsBookmarkSelect(Microsoft.JSInterop.IJSStreamReference jsStreamRef);

Parameters

jsStreamRef Microsoft.JSInterop.IJSStreamReference

Returns

System.Threading.Tasks.Task

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

BookmarksWidget.RegisterChildComponent(MapComponent) Method

Called from dymaptic.GeoBlazor.Core.Components.MapComponent.OnInitializedAsync to “Register” the current component with its parent.

public override System.Threading.Tasks.Task RegisterChildComponent(dymaptic.GeoBlazor.Core.Components.MapComponent child);

Parameters

child MapComponent

The calling, child component to register

Returns

System.Threading.Tasks.Task

Exceptions

InvalidChildElementException
Throws if the current child is not a valid sub-component to the parent.

Remarks

This method is an implementation detail and should not be called directly by consumers. In future versions, this may be changed to an internal method. If you see no other way to register a child component, please open an issue on GitHub.

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

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

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

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

BookmarksWidget.SetDisabled(Nullable) Method

Asynchronously set the value of the Disabled property after render.

public System.Threading.Tasks.Task SetDisabled(System.Nullable<bool> value);

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

BookmarksWidget.SetDragEnabled(Nullable) Method

Asynchronously set the value of the DragEnabled property after render.

public System.Threading.Tasks.Task SetDragEnabled(System.Nullable<bool> value);

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

BookmarksWidget.SetFilterPlaceholder(string) Method

Asynchronously set the value of the FilterPlaceholder property after render.

public System.Threading.Tasks.Task SetFilterPlaceholder(string? value);

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

BookmarksWidget.SetFilterText(string) Method

Asynchronously set the value of the FilterText property after render.

public System.Threading.Tasks.Task SetFilterText(string? value);

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

BookmarksWidget.SetHeadingLevel(Nullable) Method

Asynchronously set the value of the HeadingLevel property after render.

public System.Threading.Tasks.Task SetHeadingLevel(System.Nullable<int> value);

Parameters

value System.Nullable<System.Int32>

The value to set.

Returns

System.Threading.Tasks.Task

BookmarksWidget.SetViewModel(BookmarksViewModel) Method

Asynchronously set the value of the ViewModel property after render.

public System.Threading.Tasks.Task SetViewModel(dymaptic.GeoBlazor.Core.Components.BookmarksViewModel? value);

Parameters

value BookmarksViewModel

The value to set.

Returns

System.Threading.Tasks.Task

BookmarksWidget.SetVisibleElements(BookmarksVisibleElements) Method

Asynchronously set the value of the VisibleElements property after render.

public System.Threading.Tasks.Task SetVisibleElements(dymaptic.GeoBlazor.Core.Components.BookmarksVisibleElements? value);

Parameters

value BookmarksVisibleElements

The value to set.

Returns

System.Threading.Tasks.Task

BookmarksWidget.UnregisterChildComponent(MapComponent) Method

Undoes the “Registration” of a child with its parent.

public override System.Threading.Tasks.Task UnregisterChildComponent(dymaptic.GeoBlazor.Core.Components.MapComponent child);

Parameters

child MapComponent

The child to unregister

Returns

System.Threading.Tasks.Task

Remarks

This method is an implementation detail and should not be called directly by consumers. In future versions, this may be changed to an internal method.

BookmarksWidget.ValidateRequiredGeneratedChildren() Method

Validates source-generated child components.

public override void ValidateRequiredGeneratedChildren();

Implements ValidateRequiredGeneratedChildren()