BookmarksViewModel
require(["esri/widgets/Bookmarks/BookmarksViewModel"], function(BookmarksViewModel) { /* code goes here */ });esri/widgets/Bookmarks/BookmarksViewModelProvides the logic for the Bookmarks widget.
- See also:
Constructors
- new BookmarksViewModel(properties)
- Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| Bookmark | The Bookmark that is being navigated to. more details | more details | BookmarksViewModel | |
| Collection<Bookmark> | A collection of Bookmarks. more details | more details | BookmarksViewModel | |
| String | The name of the class. more details | more details | Accessor | |
| GoToOverride | This function provides the ability to override either the MapView goTo() or SceneView goTo() methods. more details | more details | BookmarksViewModel | |
| String | The view model's state. more details | more details | BookmarksViewModel | |
| MapView | The view from which the widget will operate. more details | more details | BookmarksViewModel |
Property Details
- activeBookmark BookmarkreadonlySince: ArcGIS API for JavaScript 4.9
The Bookmark that is being navigated to.
- bookmarks Collection<Bookmark>
A collection of Bookmarks.
The name of the class. The declared class name is formatted as
esri.folder.className.
- goToOverride
This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.
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 Stringreadonly
The view model's state.
Possible Values: loading | disabled
- Default Value:disabled
- view MapView
The view from which the widget will operate.
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| Promise | Zoom to a specific bookmark. more details | more details | BookmarksViewModel |