ESM: import Bookmarks from "@arcgis/core/widgets/Bookmarks.js";
CDN: const Bookmarks = await $arcgis.import("@arcgis/core/widgets/Bookmarks.js");
Class: @arcgis/core/widgets/Bookmarks
Since: ArcGIS Maps SDK 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 are typically defined inside the WebMap.
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.
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 capability in the Bookmarks widget, set capabilities.time in the BookmarksViewModel to false.
new Bookmarks(properties)
Parameter
optionalSee the properties for a list of all the properties that may be passed into the constructor.
Show inherited properties Hide inherited properties
Property DetailsA collection of Bookmarks. These are typically defined inside of a WebMap, but can also be defined manually, as shown in the code snippet below.
Example
const bookmarks = new Bookmarks({
view: view,
bookmarks: [ // array of bookmarks defined manually
new Bookmark({
name: "Angeles National Forest",
viewpoint: {
targetGeometry: {
type: "extent",
spatialReference: {
wkid: 102100
},
xmin: -13139131.948889678,
ymin: 4047767.23531948,
xmax: -13092887.54677721,
ymax: 4090610.189673263
}
}
}),
new Bookmark({
name: "Crystal Lake",
viewpoint: {
targetGeometry: {
type: "extent",
spatialReference: {
wkid: 102100
},
xmin: -13125852.551697943,
ymin: 4066904.1101411926,
xmax: -13114291.451169826,
ymax: 4077614.8487296384
},
rotation: 90
}
})
]
});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 case 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"
});Inherited
Property declaredClass Stringreadonly
The name of the class. The declared class name is formatted as esri.folder.className.
Since: ArcGIS Maps SDK for JavaScript 4.18 Bookmarks since 4.8, defaultCreateOptions added at 4.18.
Specifies how new bookmarks will be created if visibleElements.addBookmarkButton 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,
visibleElements: {
addBookmarkButton: true,
editBookmarkButton: true
},
draggable: 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
}
}
});Since: ArcGIS Maps SDK for JavaScript 4.18 Bookmarks since 4.8, defaultEditOptions added at 4.18.
Specifies how bookmarks will be edited, if visibleElements.editBookmarkButton 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.
Since: ArcGIS Maps SDK for JavaScript 4.15 Bookmarks since 4.8, disabled added at 4.15.
When true, the widget is visually withdrawn and cannot be interacted with.
dragEnabled Boolean
Since: ArcGIS Maps SDK for JavaScript 4.29 Bookmarks since 4.8, dragEnabled added at 4.29.
Indicates if a Bookmark is able to be dragged in order to update its position in the list.
filterPlaceholder String
Since: ArcGIS Maps SDK for JavaScript 4.29 Bookmarks since 4.8, filterPlaceholder added at 4.29.
Defines the text used as a placeholder when visibleElements.filter is set to true.
filterText String
Since: ArcGIS Maps SDK for JavaScript 4.29 Bookmarks since 4.8, filterText added at 4.29.
Defines the text used to filter the bookmarks when visibleElements.filter is set to true.
This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.
Example
// The following snippet uses Search 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 Maps SDK for JavaScript 4.20 Bookmarks since 4.8, headingLevel added at 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.
Example
// "No bookmarks" will render as an <h3>
bookmarks.headingLevel = 3;Since: ArcGIS Maps SDK for JavaScript 4.27 Bookmarks since 4.8, icon added at 4.27.
Icon which represents the widget. It is typically used when the widget is controlled by another one (e.g. in the Expand widget).
Inherited
Property id String
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.
The widget's default label.
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.
Inherited
Property visible Boolean
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".
Example
// Hides the widget in the view
widget.visible = false;Since: ArcGIS Maps SDK for JavaScript 4.13 Bookmarks since 4.8, visibleElements added at 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
};Show inherited methods Hide inherited methods
Method DetailsInherited
Method addHandles(handleOrHandles, groupKey)
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
Handles marked for removal once the object is destroyed.
groupKey *
optionalKey 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.
Inherited
Method classes(classNames){String}
A utility method used for building the value for a widget's class property. This aids in simplifying css class setup.
Returns
Type Description String The computed class name.Example
// .tsx syntax showing how to set css classes while rendering the widget
render() {
const dynamicClasses = {
[css.flip]: this.flip,
[css.primary]: this.primary
};
return (
<div class={classes(css.root, css.mixin, dynamicClasses)} />
);
}Inherited
Method destroy()
Destroys the widget instance.
Inherited
Method emit(type, event){Boolean}
Emits an event on the instance. This method should only be used when creating subclasses of this class.
Parameters
The name of the event.
optionalThe event payload.
Returns
Type Description Booleantrue if a listener was notified
goTo(Bookmark){Promise}
Zoom to a specific bookmark.
Returns
Type Description Promise Resolves after the animation to specified bookmark finishes.Inherited
Method hasEventListener(type){Boolean}
Indicates whether there is an event listener on the instance that matches the provided event name.
Returns
Type Description Boolean Returns true if the class supports the input event.Inherited
Method hasHandles(groupKey){Boolean}
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 *
optionalA group key.
Returns
Type Description Boolean Returnstrue 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");
}Inherited
Method isFulfilled(){Boolean}
Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, isFulfilled added at 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).Inherited
Method isRejected(){Boolean}
Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, isRejected added at 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.Inherited
Method isResolved(){Boolean}
Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, isResolved added at 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.Inherited
Method on(type, listener){Object}
Registers an event handler on the instance. Call this method to hook an event with a listener.
Returns
Type Description Object Returns an event handler with aremove() 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);
});Inherited
Method postInitialize()
Executes after widget is ready for rendering.
Inherited
Method removeHandles(groupKey)
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 *
optionalA 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");Inherited
Method render(){Object}
This method is implemented by subclasses for rendering.
Returns
Type Description Object The rendered virtual node.Inherited
Method renderNow()
Renders widget to the DOM immediately.
Inherited
Method scheduleRender()
Schedules widget rendering. This method is useful for changes affecting the UI.
Inherited
Method when(callback, errback){Promise}
Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, when added at 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
optionalThe function to call when the promise resolves.
optionalThe function to execute when the promise fails.
Returns
Type Description Promise Returns a new Promise for the result ofcallback.
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
}); VisibleElements Accessor
The visible elements that are displayed within the widget. This provides the ability to turn individual elements of the widget's display on/off.
Default Value:false
Since 4.29. Indicates whether the button to add a new bookmark displays.
Default Value:false
Since 4.29. Indicates whether to display a close button at the top of the widget.
Default Value:false
Since 4.29. Indicates whether to display a collapse button at the top of the widget.
Default Value:false
Since 4.29. Indicates whether the button to edit a bookmark displays.
Default Value:false
Since 4.29. Indicates whether the bookmarks filter displays.
Default Value:true
Since 4.29. Determines whether the widget should be shown within its built-in flow component or if the flow component should be excluded. The widget will be displayed within its original flow component if set to true. The flow component will be omitted from the widget if set to false. To place the widget into an existing Calcite flow component, set this property to false.
Default Value:false
Since 4.29. Indicates whether to display the widget heading. The heading text is "Bookmarks".
Default Value:true
Since 4.13. Indicates whether the thumbnail associated with the bookmark displays.
Default Value:true
Since 4.22. Indicates whether the time (h:m:s) is displayed alongside the date if the bookmark has a time extent defined.
bookmark-edit
Since: ArcGIS Maps SDK for JavaScript 4.17 Bookmarks since 4.8, bookmark-edit added at 4.17.
Fires when a Bookmark is edited.
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 Maps SDK for JavaScript 4.17 Bookmarks since 4.8, bookmark-select added at 4.17.
Fires when a Bookmark is selected.
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;
});RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4