layout: default title: BookmarksWidget parent: Core Classes —
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. It displays a list of bookmarks, which are typically defined inside the WebMap.
ArcGIS Maps SDK for JavaScript
public class BookmarksWidget : dymaptic.GeoBlazor.Core.Components.Widgets.Widget
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 Widget 🡒 BookmarksWidget
Properties
BookmarksWidget.Bookmarks Property
A collection of Bookmarks.
public System.Collections.Generic.List<dymaptic.GeoBlazor.Core.Components.Widgets.Bookmark>? Bookmarks { get; set; }
Property Value
System.Collections.Generic.List<Bookmark>
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.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.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
BookmarksWidget.OnBookmarkSelect Property
Handler delegate for click events on the view.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Core.Events.BookmarkSelectEvent> OnBookmarkSelect { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<BookmarkSelectEvent>
BookmarksWidget.WidgetType Property
The type of widget
public override string WidgetType { get; }
Property Value
Methods
BookmarksWidget.OnJavascriptBookmarkSelect(BookmarkSelectEvent) Method
JS-Invokable method to return a selected bookmark
public System.Threading.Tasks.Task OnJavascriptBookmarkSelect(dymaptic.GeoBlazor.Core.Events.BookmarkSelectEvent bookmarkSelectEvent);
Parameters
bookmarkSelectEvent BookmarkSelectEvent
The BookmarkSelectEvent return meta object.
Returns
Remarks
Fires after a user clicks on a bookmark.
BookmarksWidget.RegisterChildComponent(MapComponent) Method
Called from dymaptic.GeoBlazor.Core.Components.MapComponent.OnInitializedAsync to “Register” the current component with it’s parent.
public override System.Threading.Tasks.Task RegisterChildComponent(dymaptic.GeoBlazor.Core.Components.MapComponent child);
Parameters
child MapComponent
The calling, child component to register
Returns
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.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
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.