Use dark colors for code blocks Copy
1
import "@arcgis/map-components/components/arcgis-bookmarks";No specific import is needed for this component.
The Bookmarks component allow end users to quickly navigate to a particular area of interest. It displays a list of bookmarks, which are typically defined inside the WebMap.
Demo Properties autoDestroyDisabledProperty
autoDestroyDisabled: boolean
If true, the component will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the component to a different place on the page, or temporarily hide it. If this is set, make sure to call the destroy method when you are done to prevent memory leaks.
Property
A collection of Bookmarks.
Property
closed: boolean
Indicates whether a component is closed. When true, the component will be hidden.
Property
Specifies how new bookmarks will be created if visibleElements.addBookmarkButton is set to true.
Property
Specifies how bookmarks will be edited, if visibleElements.editBookmarkButton is set to true.
disabled: boolean
When true, the widget is visually withdrawn and cannot be interacted with.
Property
dragEnabled: boolean
Indicates if a Bookmark is able to be dragged in order to update its position in the list.
Property
filterPlaceholder: string
Defines the text used as a placeholder when visibleElements.filter is set to true.
Property
filterText: string
Defines the text used to filter the bookmarks when visibleElements.filter is set to true.
Property
goToOverride: (((view: MapView | SceneView, goToParameters: GoToParameters) => void))
This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.
Property
hideFlow: boolean
Property
hideThumbnail: boolean
Property
hideTime: boolean
Property
icon: string
Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).
Property
label: string
The widget's default label.
Property
position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"
Property
By assigning the id attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.
Property
showAddBookmarkButton: boolean
Property
showCloseButton: boolean
Property
showCollapseButton: boolean
Property
showEditBookmarkButton: boolean
Property
showFilter: boolean
Property
showHeading: boolean
state: "loading" | "ready"
The current state of the component.
No slots to display.
Events arcgisCloseEvent
arcgisClose: CustomEvent<void>
Emitted when the component's close button is clicked.
bubblesEvents triggered on this element will be propagated to their outermost elements.
composedThe event is composable and will propagate across the shadow DOM into the standard DOM.
cancelableThe event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisEditEvent
arcgisEdit: BookmarksBookmarkEditEvent bubbles
Events triggered on this element will be propagated to their outermost elements.
composedThe event is composable and will propagate across the shadow DOM into the standard DOM.
cancelableThe event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisPropertyChangeEvent
arcgisPropertyChange: CustomEvent<{ name: "state"; }>
Emitted when the value of a property is changed. Use this to listen to changes to properties.
bubblesEvents triggered on this element will be propagated to their outermost elements.
composedThe event is composable and will propagate across the shadow DOM into the standard DOM.
cancelableThe event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisReadyEvent
arcgisReady: CustomEvent<void>
Emitted when the component associated with a map or scene view is is ready to be interacted with.
bubblesEvents triggered on this element will be propagated to their outermost elements.
composedThe event is composable and will propagate across the shadow DOM into the standard DOM.
cancelableThe event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisSelectEvent
arcgisSelect: BookmarksBookmarkSelectEvent bubbles
Events triggered on this element will be propagated to their outermost elements.
composedThe event is composable and will propagate across the shadow DOM into the standard DOM.
cancelableThe event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
Methods componentOnReadyMethod
componentOnReady(): Promise<void>
Create a promise that resolves once component is fully loaded.
ExampleUse dark colors for code blocks Copy
1
2
3
4
const arcgisBookmarks = document.querySelector("arcgis-bookmarks");
document.body.append(arcgisBookmarks);
await arcgisBookmarks.componentOnReady();
console.log("arcgis-bookmarks is ready to go!");Method
destroy(): Promise<void>
Permanently destroy the component.
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