Bookmark

AMD: require(["esri/webmap/Bookmark"], (Bookmark) => { /* code goes here */ });
ESM: import Bookmark from "@arcgis/core/webmap/Bookmark.js";
Class: esri/webmap/Bookmark
Inheritance: Bookmark Accessor
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.

See also

Constructors

new Bookmark(properties)

Parameter
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
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

declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

name String

The name of the bookmark item. Used as a label in the Bookmarks widget.

thumbnail Object

The URL for a thumbnail image.

Property
url String
optional

URL to a thumbnail to display.

timeExtent TimeExtent

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)
   }
})

viewpoint Viewpoint

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.

Method Overview

Show inherited methods Hide inherited methods
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

addHandles(handleOrHandles, groupKey)inherited

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
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key 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.

fromJSON(json){*}static

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.

Parameter
json Object

A 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.

Returns
Type Description
* Returns a new instance of this class.

hasHandles(groupKey){Boolean}inherited

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 *
optional

A group key.

Returns
Type 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)inherited

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 *
optional

A 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");

toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.