ESM: import Bookmark from "@arcgis/core/webmap/Bookmark.js";
CDN: const Bookmark = await $arcgis.import("@arcgis/core/webmap/Bookmark.js");
Class: @arcgis/core/webmap/Bookmark
Since: ArcGIS Maps SDK for JavaScript 4.8
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 new Bookmark(properties)
Parameter
optionalSee the properties for a list of all the properties that may be passed into the constructor.
Show inherited properties Hide inherited properties
Property DetailsInherited
Property declaredClass Stringreadonly
The name of the class. The declared class name is formatted as esri.folder.className
.
The name of the bookmark item. Used as a label in the Bookmarks widget.
The URL for a thumbnail image.
URL to a thumbnail to display.
Since: ArcGIS Maps SDK for JavaScript 4.22 Bookmark 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)
}
})
uid Stringreadonly
Since: ArcGIS Maps SDK for JavaScript 4.33 Bookmark since 4.8, uid added at 4.33.
An automatically generated unique identifier assigned to the instance. The unique id is generated each time the application is loaded.
Since: ArcGIS Maps SDK for JavaScript 4.17 Bookmark 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.targetGeometry
is an Extent. When defined manually on the Bookmarks widget, the targetGeometry
can be a Point, but scale
must also be defined.
Show inherited methods Hide inherited methods
Method DetailsInherited
Method addHandles(handleOrHandles, groupKey)
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor 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();
Parameters
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 json
parameter 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.
Returns
Type Description * | null | undefined Returns a new instance of this class.Inherited
Method hasHandles(groupKey){Boolean}
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.
Returns true if a named group of handles exist.
Parameter
groupKey *
optionalA group key.
Returns
Type Description Boolean Returnstrue
if 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
Method removeHandles(groupKey)
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.
Removes a group of handles owned by the object.
Parameter
groupKey *
optionalA group key or an array or collection of group keys to remove.
Example
obj.removeHandles(); // removes handles from default group
obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4