Skip To ContentArcGIS for DevelopersSign In Dashboard
require(["esri/widgets/Bookmarks"], function(Bookmarks) { /* code goes here */ });
Class: esri/widgets/Bookmarks
Inheritance: Bookmarks Widget Accessor
Since: ArcGIS API for JavaScript 4.8

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

Known Limitations

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

For information about gaining full control of widget styles, see the Styling topic.
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.
NameTypeSummaryClass
BookmarkCreationOptions

Specifies how new bookmarks will be created if editingEnabled is set to true.

more details
more detailsBookmarks
Collection<Bookmark>

A collection of Bookmarks.

more details
more detailsBookmarks
String|HTMLElement

The ID or node representing the DOM element containing the widget.

more details
more detailsWidget
String

The name of the class.

more details
more detailsAccessor
Boolean

When true, this property indicates whether the widget has been destroyed.

more details
more detailsWidget
Boolean

Indicates whether the widget is able to be edited.

more details
more detailsBookmarks
GoToOverride

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

more details
more detailsBookmarks
String

The widget's default CSS icon class.

more details
more detailsBookmarks
String

The unique ID assigned to the widget when the widget is created.

more details
more detailsWidget
String

The widget's default label.

more details
more detailsBookmarks
MapView

The view from which the widget will operate.

more details
more detailsBookmarks
BookmarksViewModel

The view model for this widget.

more details
more detailsBookmarks
VisibleElements

The visible elements that are displayed within the widget.

more details
more detailsBookmarks

Property Details

bookmarkCreationOptions BookmarkCreationOptions
Since: ArcGIS API for JavaScript 4.13

Specifies how new bookmarks will be created if editingEnabled is set to true. Can be used to enable or disable taking screenshots or creating an extent based on the current view when a bookmark is created. See BookmarkCreationOptions for more information.

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 extent
   // of the view will not be set as the extent of the new bookmark
   bookmarkCreationOptions: {
     takeScreenshot: true,
     captureExtent: false,
     screenshotSettings: {
       width: 100,
       height: 100
     }
   }
});
bookmarks Collection<Bookmark>

A collection of Bookmarks.

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.

destroyed Boolean inherited

When true, this property indicates whether the widget has been destroyed.

editingEnabled Boolean
Since: ArcGIS API for JavaScript 4.13

Indicates whether the widget is able to be edited. When true, allows bookmarks to be added, edited, reordered, or deleted from within the widget. Any edits made will only be shown locally and will not be saved.

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);
};
iconClass String

The widget's default CSS icon class.

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.

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.

visibleElements VisibleElementsautocast
Autocasts from Object[]
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

NameReturn TypeSummaryClass
String

A utility method used for building the value for a widget's class property.

more details
more detailsWidget

Destroys the widget instance.

more details
more detailsWidget
Boolean

Emits an event on the instance.

more details
more detailsWidget
Promise

Zoom to a specific bookmark.

more details
more detailsBookmarks
Boolean

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

more details
more detailsWidget
Object

Registers an event handler on the instance.

more details
more detailsWidget

Widget teardown helper.

more details
more detailsWidget

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget
Object

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget

Renders widget to the DOM immediately.

more details
more detailsWidget

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget

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 Array<(string|Array<string>|Object)>
repeatable

The class names.

Returns:
TypeDescription
StringThe computed class name.
See also:
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:
TypeDescription
Booleantrue if a listener was notified
goTo(Bookmark){Promise}

Zoom to a specific bookmark.

Parameter:
Bookmark Bookmark

The bookmark to zoom to.

Returns:
TypeDescription
PromiseResolves 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:
TypeDescription
BooleanReturns true if the class supports the input event.
on(type, listener){Object}inherited

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

Parameters:

A event type, or an array of event types, to listen for.

listener Function

The function to call when the event is fired.

Returns:
TypeDescription
ObjectReturns an event handler with a remove() method that can be called to stop listening for the event(s).
PropertyTypeDescription
removeFunctionWhen 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 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:
TypeDescription
ObjectThe 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.

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.

Event Overview

NameTypeSummaryClass
{bookmark: Bookmark}

Fires when a Bookmark is selected.

more details
more detailsBookmarks

Event Details

select-bookmark

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("select-bookmark", function(event){
  bookmarksExpand.expanded = false;
});

API Reference search results

NameTypeModule
Loading...