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:

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
Stringmore details

The name of the class.

more detailsAccessor
Extentmore details

The extent of the specified bookmark item.

more detailsBookmark
Stringmore details

The name of the bookmark item.

more detailsBookmark
Objectmore details

The URL for a thumbnail image.

more detailsBookmark
Viewpointmore details

The viewpoint of the bookmark item.

more detailsBookmark

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.

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.

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