BookmarksViewModel | API Reference | ArcGIS Maps SDK for JavaScript 4.32

Provides the logic for the Bookmarks widget.

See also

Constructors

BookmarksViewModel Constructor new BookmarksViewModel(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 Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
Bookmark\|null\|undefined	The Bookmark that is being navigated to.	BookmarksViewModel
Collection<Bookmark>	A collection of Bookmarks.	BookmarksViewModel
BookmarksCapabilities	Defines the capabilities of the widget.	BookmarksViewModel
String	The name of the class.	Accessor
BookmarkOptions	Specifies how new bookmarks will be created.	BookmarksViewModel
BookmarkOptions	Specifies how bookmarks will be edited.	BookmarksViewModel
GoToOverride\|null\|undefined	This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.	BookmarksViewModel
String	The view model's state.	BookmarksViewModel
MapView\|SceneView\|null\|undefined	The view from which the widget will operate.	BookmarksViewModel

Property Details

activeBookmark Property activeBookmark Bookmark |null |undefinedreadonly Since: ArcGIS Maps SDK for JavaScript 4.9 BookmarksViewModel since 4.8, activeBookmark added at 4.9.

The Bookmark that is being navigated to.

bookmarks Property bookmarks Collection<Bookmark>autocast

A collection of Bookmarks.

capabilities Property capabilities BookmarksCapabilities Since: ArcGIS Maps SDK for JavaScript 4.27 BookmarksViewModel since 4.8, capabilities added at 4.27.

Defines the capabilities of the widget. This property can be used to enable or disable the time capability of the Bookmarks widget.

Example

const bookmarksVM = new BookmarksViewModel({
  view: view,
  capabilities: {
     time: false // disables all time capability in the Bookmarks widget
  }
});

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

defaultCreateOptions Property defaultCreateOptions BookmarkOptions Since: ArcGIS Maps SDK for JavaScript 4.18 BookmarksViewModel since 4.8, defaultCreateOptions added at 4.18.

Specifies how new bookmarks will be created. 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.

defaultEditOptions Property defaultEditOptions BookmarkOptions Since: ArcGIS Maps SDK for JavaScript 4.18 BookmarksViewModel since 4.8, defaultEditOptions added at 4.18.

Specifies how bookmarks will be edited. 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.

goToOverride Property goToOverride GoToOverride |null |undefined

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

state Property state Stringreadonly

The view model's state.

Possible Values:"loading" |"ready"

Default Value:"ready"

view Property view MapView |SceneView |null |undefined

The view from which the widget will operate.

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
Promise<Bookmark>	Creates a new bookmark from the defaultCreateOptions, unless otherwise specified.	BookmarksViewModel
Promise<Bookmark>	Edits the given bookmark.	BookmarksViewModel
Boolean	Emits an event on the instance.	BookmarksViewModel
Promise	Zoom to a specific bookmark.	BookmarksViewModel
Boolean	Indicates whether there is an event listener on the instance that matches the provided event name.	BookmarksViewModel
Boolean	Returns true if a named group of handles exist.	Accessor
Object	Registers an event handler on the instance.	BookmarksViewModel
	Removes a group of handles owned by the object.	Accessor

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor 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.

createBookmark Method createBookmark(options){Promise<Bookmark>} Since: ArcGIS Maps SDK for JavaScript 4.13 BookmarksViewModel since 4.8, createBookmark added at 4.13.

Creates a new bookmark from the defaultCreateOptions, unless otherwise specified.

Parameter

options BookmarkOptions

optional

Specifies how new bookmarks will be created. Can be used to enable/disable taking screenshots or capturing the extent when a new bookmark is added.

Returns

Type	Description
Promise<Bookmark>	When resolved, returns the newly created Bookmark.

Example

// Creates new bookmark from current view extent
viewModel.createBookmark().then(function(bookmark){
   // Give the bookmark a name
   bookmark.name = "New Bookmark";
   // Add to bookmarks list
   viewModel.bookmarks.add(bookmark);
});

editBookmark Method editBookmark(bookmark, options){Promise<Bookmark>} Since: ArcGIS Maps SDK for JavaScript 4.17 BookmarksViewModel since 4.8, editBookmark added at 4.17.

Edits the given bookmark.

Parameters

bookmark Bookmark|null|undefined

The bookmark to be edited.

options BookmarkOptions

optional

Specifies how bookmarks will be edited. Can be used to enable/disable taking screenshots or capturing the extent when a bookmark is edited. If not specified, the defaultEditOptions will be used.

Returns

Type	Description
Promise<Bookmark>	When resolved, returns the edited Bookmark.

Example

const options = {
  takeScreenshot: false,
  captureViewpoint: true
};

// update the given bookmark's viewpoint without taking a new screenshot
viewModel.editBookmark(bookmark, options).then(function(editedBookmark){
   // the edited bookmark's viewpoint should now match the current view
   console.log(editedBookmark.viewpoint);
   console.log(view.viewpoint);
})

emit Method emit(type, event){Boolean}

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 Method 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 Method hasEventListener(type){Boolean}

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.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor 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");
}

on Method on(type, listener){Object}

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

removeHandles Inherited Method removeHandles(groupKey) Inherited from Accessor 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");

Type Definitions

BookmarkOptions Type Definition BookmarkOptions Object

Specifies how bookmarks will be created or modified.

Properties

takeScreenshot Boolean

optional

Indicates whether a screenshot is taken when a new bookmark is created. The screenshot will be set as the thumbnail in the newly created bookmark. Default is true.

captureViewpoint Boolean

optional

Since 4.17 Indicates whether the viewpoint of the current view will become the viewpoint of a newly created or modified bookmark. Default is true.

captureRotation Boolean

optional

Since 4.17 Indicates whether the rotation of the current view will be saved in the viewpoint of a newly created or modified bookmark. Default is true.

captureScale Boolean

optional

Since 4.17 Indicates whether the scale of the current view will be saved in the viewpoint of a newly created or modified bookmark. Default is true.

captureTimeExtent Boolean

optional

Since 4.22 Indicates whether the time extent of the current view will be saved in the timeExtent of a newly created or modified bookmark. Default is true.

screenshotSettings Object

optional

An object that specifies the settings of the screenshot that will be used to create the bookmark's thumbnail.

Specification

width Number

optional

The width (in pixels) of the screenshot. Default is 128px.

height Number

optional

The height (in pixels) of the screenshot. Default is 128px.

area Object

optional

Used to take a screenshot of a subregion of the view. Defaults to the whole view.

Specification: x Number

The x value of the screenshot area.

y Number

The y value of the screenshot area.

width Number

The width of the screenshot area.

height Number

The height of the screenshot area.

layers Layer []

optional

An optional list of layers to be included in the screenshot.

BookmarksCapabilities Type Definition BookmarksCapabilities Object

Specifies the abilities for the Bookmarks widget.

Property: time Boolean

optional
Indicates whether the time capability is enabled in the Bookmarks widget. Default is true. When false, the timeExtent of a bookmark will not be visible or editable. Any newly created bookmarks will not capture the time extent.