layout: default title: Bookmark parent: Core Classes —
dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components.Widgets
Bookmark Class
A bookmark is a saved map extent that allows end users to quickly navigate
to a particular area of interest using the Bookmarks widget.
They are usually defined part of the WebMap.
public class Bookmark : dymaptic.GeoBlazor.Core.Components.MapComponent
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 Bookmark
Constructors
Bookmark() Constructor
Parameterless constructor for use as a Blazor component.
public Bookmark();
Bookmark(string, TimeExtent, string, Viewpoint) Constructor
Constructor for building in C#.
public Bookmark(string? name=null, dymaptic.GeoBlazor.Core.Objects.TimeExtent? timeExtent=null, string? thumbnail=null, dymaptic.GeoBlazor.Core.Components.Views.Viewpoint? viewpoint=null);
Parameters
name System.String
The name of the bookmark.
timeExtent TimeExtent
The extent of the specified bookmark.
thumbnail System.String
The URL for a thumbnail image.
viewpoint Viewpoint
The viewpoint of the bookmark item. Defines the rotation, scale, and target geometry of the bookmark.
Properties
Bookmark.Name Property
The name of the bookmark.
public string? Name { get; set; }
Property Value
Bookmark.Thumbnail Property
The URL for a thumbnail image.
public string? Thumbnail { get; set; }
Property Value
Bookmark.TimeExtent Property
The extent of the specified bookmark.
public dymaptic.GeoBlazor.Core.Objects.TimeExtent? TimeExtent { get; set; }
Property Value
Bookmark.Viewpoint Property
The viewpoint of the bookmark item. Defines the rotation, scale, and target geometry of the bookmark.
public dymaptic.GeoBlazor.Core.Components.Views.Viewpoint? Viewpoint { get; set; }
Property Value
Methods
Bookmark.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.
Bookmark.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.