require(["esri/webmap/Bookmark"], (Bookmark) => { /* code goes here */ });
import Bookmark from "@arcgis/core/webmap/Bookmark.js";
esri/webmap/Bookmark
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.
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
| String | The name of the class. | Accessor | |
| String | The name of the bookmark item. | Bookmark | |
| Object | The URL for a thumbnail image. | Bookmark | |
| TimeExtent | The time extent of the bookmark item. | Bookmark | |
| Viewpoint | The viewpoint of the bookmark item. | Bookmark |
Property Details
-
timeExtent
PropertytimeExtent TimeExtentSince: ArcGIS Maps SDK for JavaScript 4.22Bookmark since 4.8, timeExtent added at 4.22. -
The time extent of the bookmark item.
Example// create a bookmark with a time extent starting December 10, 1996 // and ending December 25, 1996 const bookmark = new Bookmark({ timeExtent: { start: new Date(1996, 11, 10), end: new Date(1996, 11, 25) } })
-
viewpoint
Propertyviewpoint ViewpointSince: ArcGIS Maps SDK for JavaScript 4.17Bookmark since 4.8, viewpoint added at 4.17. -
The viewpoint of the bookmark item. Defines the rotation, scale, and target geometry of the bookmark.
Bookmarks can only be saved to the WebMap when their
viewpoint.targetGeometryis an Extent. When defined manually on the Bookmarks widget, thetargetGeometrycan be a Point, butscalemust also be defined.
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
| * | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | Bookmark | |
| Boolean | Returns true if a named group of handles exist. | Accessor | |
Removes a group of handles owned by the object. | Accessor | ||
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. | Bookmark |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, addHandles added at 4.25. -
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input
jsonparameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.Parameterjson ObjectA JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.
ReturnsType Description * Returns a new instance of this class.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON
MethodtoJSON(){Object} -
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.