Bookmark

Bookmark

AMD: require(["esri/webmap/Bookmark"], (Bookmark) => { /* code goes here */ });

ESM: import Bookmark from "@arcgis/core/webmap/Bookmark";

Class: esri/webmap/Bookmark

Inheritance: Bookmark Accessor

Since: ArcGIS API 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:

Bookmarks widget
Bookmarks in the Web Map specification

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

Type	Summary	Class
String	more details The name of the class.	more details	Accessor
Extent	more details The extent of the specified bookmark item.	more details	Bookmark
String	more details The name of the bookmark item.	more details	Bookmark
Object	more details The URL for a thumbnail image.	more details	Bookmark
TimeExtent	more details The time extent of the bookmark item.	more details	Bookmark
Viewpoint	more details The viewpoint of the bookmark item.	more details	Bookmark

Property Details

declaredClass Stringreadonly inherited

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

extent Extent Deprecated since 4.17. Use viewpoint instead.

The extent of the specified bookmark item.

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 API 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 Viewpoint Since: ArcGIS API 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, the targetGeometry can be a Point, but scale must also be defined.

ArcGIS API for JavaScriptAPI Reference

Was this page helpful?

Was this page helpful?