Bookmarks

The Bookmarks widget allows end users to quickly navigate to a particular area of interest. It displays a list of bookmarks, which are typically defined inside the WebMap.

bookmarks

Each bookmark may contain the following properties: name, thumbnail, viewpoint (defines rotation, scale, and target geometry), and timeExtent. If the timeExtent is defined on a bookmark, it will be displayed in the bookmark widget as shown in the following image.

bookmarks-time

When a bookmark with a timeExtent is selected, the timeExtent of the View will be set to the timeExtent of the selected bookmark. To disable time ability in the Bookmarks widget, set abilities.time in the BookmarksViewModel to false.

Known Limitations

This widget is designed to work in 2D. It shouldn't be used in a SceneView unless you supply the bookmarks manually.

See also:

Constructors

new Bookmarks(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
Collection<Bookmark>	more details A collection of Bookmarks.	more details	Bookmarks
String\|HTMLElement	more details The ID or node representing the DOM element containing the widget.	more details	Widget
String	more details The name of the class.	more details	Accessor
BookmarkOptions	more details Specifies how new bookmarks will be created if editingEnabled is set to `true`.	more details	Bookmarks
BookmarkOptions	more details Specifies how bookmarks will be edited, if editingEnabled is set to `true`.	more details	Bookmarks
Boolean	more details When true, the widget is visually withdrawn and cannot be interacted with.	more details	Bookmarks
Boolean	more details Indicates whether the bookmarks are able to be edited.	more details	Bookmarks
GoToOverride	more details This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.	more details	Bookmarks
Number	more details Indicates the heading level to use for the message "No bookmarks" when no bookmarks are available in this widget.	more details	Bookmarks
String	more details The widget's default CSS icon class.	more details	Bookmarks
String	more details The unique ID assigned to the widget when the widget is created.	more details	Widget
String	more details The widget's default label.	more details	Bookmarks
MapView	more details The view from which the widget will operate.	more details	Bookmarks
BookmarksViewModel	more details The view model for this widget.	more details	Bookmarks
Boolean	more details Indicates whether the widget is visible.	more details	Widget
VisibleElements	more details The visible elements that are displayed within the widget.	more details	Bookmarks

Property Details

bookmarks Collection<Bookmark>

A collection of Bookmarks.

container String|HTMLElement inherited

The ID or node representing the DOM element containing the widget. This property can only be set once. The following examples are all valid use cases when working with widgets.

Examples:

// Create the HTML div element programmatically at runtime and set to the widget's container
const basemapGallery = new BasemapGallery({
  view: view,
  container: document.createElement("div")
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

// Specify an already-defined HTML div element in the widget's container

const basemapGallery = new BasemapGallery({
  view: view,
  container: basemapGalleryDiv
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

// HTML markup
<body>
  <div id="viewDiv"></div>
  <div id="basemapGalleryDiv"></div>
</body>

// Specify the widget while adding to the view's UI
const basemapGallery = new BasemapGallery({
  view: view
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

declaredClass Stringreadonly inherited

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

defaultCreateOptions BookmarkOptions Since: ArcGIS API for JavaScript 4.18

Specifies how new bookmarks will be created if editingEnabled is set to true. Can be used to enable or disable taking screenshots or capturing the bookmark's viewpoint based on the current view when a bookmark is created. See BookmarkOptions for the full list of options.

Example:

const bookmarks = new Bookmarks({
   view: view,
   editingEnabled: true,
   // whenever a new bookmark is created, a 100x100 px
   // screenshot of the view will be taken and the rotation, scale, and extent
   // of the view will not be set as the viewpoint of the new bookmark
   defaultCreateOptions: {
     takeScreenshot: true,
     captureViewpoint: false,
     captureTimeExtent: false, // the time extent of the view will not be saved in the bookmark
     screenshotSettings: {
       width: 100,
       height: 100
     }
   }
});

defaultEditOptions BookmarkOptions Since: ArcGIS API for JavaScript 4.18

Specifies how bookmarks will be edited, if editingEnabled is set to true. Can be used to enable or disable taking screenshots or capturing the bookmark's viewpoint based on the current view when a bookmark is edited. See BookmarkOptions for the full list of options.

disabled Boolean Since: ArcGIS API for JavaScript 4.15

When true, the widget is visually withdrawn and cannot be interacted with.

Default Value:false

editingEnabled Boolean Since: ArcGIS API for JavaScript 4.13

Indicates whether the bookmarks are able to be edited. When true, allows bookmarks to be added, edited, reordered, or deleted from within the widget.

bookmarks-editing1

When the "edit" icon is clicked, the timeExtent, scale, rotation, and extent of the view will update to match the bookmark's timeExtent (if defined) and viewpoint. The following form opens to allow the user to edit the bookmark's title, thumbnail, viewpoint and timeExtent.

bookmarks-editing2

Since 4.17: The thumbnail can be "refreshed" (updated to a screenshot of the view's current extent), added from a URL (HTTPS protocol required), or removed. When the "Save" button is clicked, the bookmark's viewpoint is updated to match the current scale, rotation, and extent of the view.

Since 4.22: When adding a bookmark, the timeExtent will be set based on the View's timeExtent, if defined. When editing a bookmark, use the TimeSlider to update the timeExtent of the View. When the "Save" button is clicked, the bookmark's timeExtent is updated to match the timeExtent of the View. The Include time toggle button will remove the timeExtent from a bookmark when toggled off. When toggled on, the timeExtent of a bookmark will be set to the timeExtent of the View.

Any edits made will only be shown locally and will not be saved. See WebMap.save() or WebMap.saveAs() if you want to save the edits to your webmap.

Default Value:false

goToOverride GoToOverride

This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.

See also:

Example:

// The following snippet uses the Search widget but can be applied to any
// widgets that support the goToOverride property.
search.goToOverride = function(view, goToParams) {
  goToParams.options.duration = updatedDuration;
  return view.goTo(goToParams.target, goToParams.options);
};

headingLevel Number Since: ArcGIS API for JavaScript 4.20

Indicates the heading level to use for the message "No bookmarks" when no bookmarks are available in this widget. By default, this message is rendered as a level 2 heading (e.g. <h2>No bookmarks</h2>). Depending on the widget's placement in your app, you may need to adjust this heading for proper semantics. This is important for meeting accessibility standards.

Default Value:2

See also:

Heading Elements

Example:

// "No bookmarks" will render as an <h3>
bookmarks.headingLevel = 3;

iconClass String

The widget's default CSS icon class.

id String inherited

The unique ID assigned to the widget when the widget is created. If not set by the developer, it will default to the container ID, or if that is not present then it will be automatically generated.

label String

The widget's default label.

view MapView

The view from which the widget will operate.

viewModel BookmarksViewModelautocast

The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the BookmarksViewModel class to access all properties and methods on the widget.

visible Boolean inherited

Indicates whether the widget is visible.

If false, the widget will no longer be rendered in the web document. This may affect the layout of other elements or widgets in the document. For example, if this widget is the first of three widgets associated to the upper right hand corner of the view UI, then the other widgets will reposition when this widget is made invisible. For more information, refer to the CSS display value of "none".

Default Value:true

Example:

// Hides the widget in the view
widget.visible = false;

visibleElements VisibleElementsautocast Since: ArcGIS API for JavaScript 4.13

The visible elements that are displayed within the widget. This property provides the ability to turn individual elements of the widget's display on/off.

Example:

bookmarks.visibleElements = {
  thumbnail: false
};

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
String	more details A utility method used for building the value for a widget's `class` property.	more details	Widget
	more details Destroys the widget instance.	more details	Widget
Boolean	more details Emits an event on the instance.	more details	Widget
Promise	more details Zoom to a specific bookmark.	more details	Bookmarks
Boolean	more details Indicates whether there is an event listener on the instance that matches the provided event name.	more details	Widget
Boolean	more details `isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).	more details	Widget
Boolean	more details `isRejected()` may be used to verify if creating an instance of the class is rejected.	more details	Widget
Boolean	more details `isResolved()` may be used to verify if creating an instance of the class is resolved.	more details	Widget
Object	more details Registers an event handler on the instance.	more details	Widget
	more details Widget teardown helper.	more details	Widget
	more details This method is primarily used by developers when implementing custom widgets.	more details	Widget
Object	more details This method is primarily used by developers when implementing custom widgets.	more details	Widget
	more details Renders widget to the DOM immediately.	more details	Widget
	more details This method is primarily used by developers when implementing custom widgets.	more details	Widget
Promise	more details `when()` may be leveraged once an instance of the class is created.	more details	Widget

Method Details

classes(classNames){String}inherited

A utility method used for building the value for a widget's class property. This aids in simplifying CSS class setup.

Parameter:

classNames String|String []|Object

repeatable

The class names.

Returns:

Type	Description
String	The computed class name.

See also:

Guide - Widget development (rendering)

Example:

// .tsx syntax showing how to set CSS classes while rendering the widget

render() {
  const dynamicIconClasses = {
    [CSS.myIcon]: this.showIcon,
    [CSS.greyIcon]: !this.showIcon
  };

  return (
    <div class={classes(CSS.root, CSS.mixin, dynamicIconClasses)} />
  );
}

destroy()inherited

Destroys the widget instance.

emit(type, event){Boolean}inherited

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters:

type String

The name of the event.

event Object

optional

The event payload.

Returns:

Type	Description
Boolean	`true` if a listener was notified

goTo(Bookmark){Promise}

Zoom to a specific bookmark.

Parameter:

Bookmark Bookmark

The bookmark to zoom to.

Returns:

Type	Description
Promise	Resolves after the animation to specified bookmark finishes.

hasEventListener(type){Boolean}inherited

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter:

type String

The name of the event.

Returns:

Type	Description
Boolean	Returns true if the class supports the input event.

isFulfilled(){Boolean}inherited Since: ArcGIS API for JavaScript 4.19

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.

Returns:

Type	Description
Boolean	Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).

isRejected(){Boolean}inherited Since: ArcGIS API for JavaScript 4.19

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns:

Type	Description
Boolean	Indicates whether creating an instance of the class has been rejected.

isResolved(){Boolean}inherited Since: ArcGIS API for JavaScript 4.19

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns:

Type	Description
Boolean	Indicates whether creating an instance of the class has been resolved.

on(type, listener){Object}inherited

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters:

type String|String []

An event or an array of events to listen for.

listener Function

The function to call when the event fires.

Returns:

Type Description

Object

Returns an event handler with a remove() method that should be called to stop listening for the event(s).

Property	Type	Description
remove	Function	When called, removes the listener from the event.

Example:

view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

own(handles)inherited

Widget teardown helper. Any handles added to it will be automatically removed when the widget is destroyed.

Parameter:

handles WatchHandle|WatchHandle []

Handles marked for removal once the widget is destroyed.

postInitialize()inherited

This method is primarily used by developers when implementing custom widgets. Executes after widget is ready for rendering.

render(){Object}inherited

This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.

Returns:

Type	Description
Object	The rendered virtual node.

renderNow()inherited

Renders widget to the DOM immediately.

scheduleRender()inherited

This method is primarily used by developers when implementing custom widgets. Schedules widget rendering. This method is useful for changes affecting the UI.

when(callback, errback){Promise}inherited Since: ArcGIS API for JavaScript 4.19

when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters:

callback Function

optional

The function to call when the promise resolves.

errback Function

optional

The function to execute when the promise fails.

Returns:

Type	Description
Promise	Returns a new promise for the result of `callback` that may be used to chain additional functions.

Example:

// Although this example uses the BasemapGallery widget, any class instance that is a promise may use when() in the same way
let bmGallery = new BasemapGallery();
bmGallery.when(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});

Type Definitions

VisibleElements

The visible elements that are displayed within the widget. This provides the ability to turn individual elements of the widget's display on/off.

Properties:

addBookmark Boolean

optional

Indicates whether to button to add a new bookmark displays. Default is true.

thumbnail Boolean

optional

Indicates whether the thumbnail associated with the bookmark displays. Default value is true.

time Boolean

optional

Since 4.22 Indicates whether the time (h:m:s) is displayed alongside the date if the bookmark has a time extent defined. Default value is true.

Event Overview

Name	Type	Summary	Class
	{bookmark: Bookmark}	more details Fires when a Bookmark is edited.	more details	Bookmarks
	{bookmark: Bookmark}	more details Fires when a Bookmark is selected.	more details	Bookmarks

Event Details

bookmark-edit Since: ArcGIS API for JavaScript 4.17

Fires when a Bookmark is edited.

Property:

bookmark Bookmark

The edited bookmark.

Example:

// once an edit has been made, enable the "Save Webmap" button
//    to allow the user to save their changes
bookmarksWidget.on("bookmark-edit", function(event){
   saveBtn.disabled = false;
}

bookmark-select Since: ArcGIS API for JavaScript 4.17

Fires when a Bookmark is selected.

Property:

bookmark Bookmark

The bookmark selected by the user.

Example:

const bookmarksWidget = new Bookmarks({
  view: view
});

const bookmarksExpand = new Expand({
  view: view,
  content: bookmarksWidget
});
view.ui.add(bookmarksExpand, "top-right");

// collapses the associated Expand instance
// when the user selects a bookmark
bookmarksWidget.on("bookmark-select", function(event){
  bookmarksExpand.expanded = false;
});

ArcGIS API for JavaScriptAPI Reference

Was this page helpful?

Was this page helpful?