import "@arcgis/map-components/components/arcgis-bookmarks";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
| Property | Attribute | Type |
|---|---|---|
auto-destroy-disabled | boolean | |
| ||
closed | boolean | |
| ||
| ||
disabled | boolean | |
drag-enabled | boolean | |
filter-placeholder | string | |
filter-text | string | |
| (((view: MapView | SceneView, goToParameters: GoToParameters) => void)) | |
hide-flow | boolean | |
hide-thumbnail | boolean | |
hide-time | boolean | |
icon | string | |
label | string | |
position | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing" | |
reference-element | ||
show-add-bookmark-button | boolean | |
show-close-button | boolean | |
show-collapse-button | boolean | |
show-edit-bookmark-button | boolean | |
show-filter | boolean | |
show-heading | boolean | |
statereadonly | state | "loading" | "ready" |
autoDestroyDisabled
autoDestroyDisabled: booleanIf 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.
- Attribute
- auto-destroy-disabled
- Default value
- false
closed
closed: booleanIndicates whether a component is closed. When true, the component will be hidden.
- Attribute
- closed
- Default value
- false
defaultCreateOptions
defaultCreateOptions: BookmarkOptionsSpecifies how new bookmarks will be created if visibleElements.addBookmarkButton is set to true.
defaultEditOptions
defaultEditOptions: BookmarkOptionsSpecifies how bookmarks will be edited, if visibleElements.editBookmarkButton is set to true.
disabled
disabled: booleanWhen true, the widget is visually withdrawn and cannot be interacted with.
- Attribute
- disabled
- Default value
- false
dragEnabled
dragEnabled: booleanIndicates if a Bookmark is able to be dragged in order to update its position in the list.
- Attribute
- drag-enabled
- Default value
- false
filterPlaceholder
filterPlaceholder: stringDefines the text used as a placeholder when visibleElements.filter is set to true.
- Attribute
- filter-placeholder
filterText
filterText: stringDefines the text used to filter the bookmarks when visibleElements.filter is set to true.
- Attribute
- filter-text
goToOverride
goToOverride: (((view: MapView | SceneView, goToParameters: GoToParameters) => void))This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.
icon
icon: stringIcon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).
- See also
- Attribute
- icon
- Default value
- "bookmark"
position
position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"- Attribute
- position
- Default value
- "bottom-left"
referenceElement
referenceElement: HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | stringBy 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.
- Attribute
- reference-element
showAddBookmarkButton
showAddBookmarkButton: boolean- Attribute
- show-add-bookmark-button
- Default value
- false
showCollapseButton
showCollapseButton: boolean- Attribute
- show-collapse-button
- Default value
- false
showEditBookmarkButton
showEditBookmarkButton: boolean- Attribute
- show-edit-bookmark-button
- Default value
- false
state
state: "loading" | "ready"The current state of the component.
- Attribute
- state
- Default value
- "ready"
Slots
Events
| Event | Type |
|---|---|
CustomEvent<void> | |
BookmarksBookmarkEditEvent | |
CustomEvent<{ name: "state"; }> | |
CustomEvent<void> | |
BookmarksBookmarkSelectEvent |
arcgisClose
arcgisClose: CustomEvent<void>Emitted when the component's close button is clicked.
Events triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisEdit
arcgisEdit: BookmarksBookmarkEditEventEvents triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisPropertyChange
arcgisPropertyChange: CustomEvent<{ name: "state"; }>Emitted when the value of a property is changed. Use this to listen to changes to properties.
Events triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisReady
arcgisReady: CustomEvent<void>Emitted when the component associated with a map or scene view is is ready to be interacted with.
Events triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisSelect
arcgisSelect: BookmarksBookmarkSelectEventEvents triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
Methods
| Method | Signature |
|---|---|
componentOnReady(): Promise<void> | |
destroy(): Promise<void> |
componentOnReady
componentOnReady(): Promise<void>Create a promise that resolves once component is fully loaded.
Example
const arcgisBookmarks = document.querySelector("arcgis-bookmarks");
document.body.append(arcgisBookmarks);
await arcgisBookmarks.componentOnReady();
console.log("arcgis-bookmarks is ready to go!");- Returns
- Promise<void>