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)
-
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. more details | Accessor | |
String | The name of the bookmark item. more details | Bookmark | |
Object | The URL for a thumbnail image. more details | Bookmark | |
TimeExtent | The time extent of the bookmark item. more details | Bookmark | |
Viewpoint | The viewpoint of the bookmark item. more details | Bookmark |
Property Details
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
thumbnail Object
-
The URL for a thumbnail image.
- Property
-
url String
URL to a thumbnail to display.
-
timeExtent TimeExtentSince: ArcGIS Maps SDK for JavaScript 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 ViewpointSince: ArcGIS Maps SDK for JavaScript 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, thetargetGeometry
can be a Point, butscale
must 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. more details | Accessor | ||
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Removes a group of handles owned by the object. more details | Accessor |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 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 } ); // Handle gets removed when the object is destroyed. this.addHandles(handle);
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.
-
Since: ArcGIS Maps SDK for JavaScript 4.25
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns true
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"); }
-
removeHandles(groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 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");