import "@arcgis/map-components/components/arcgis-bookmarks";
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 | |
| ||
| ||
| ||
disabled | boolean | |
drag-enabled | boolean | |
filter-placeholder | string | |
filter-text | string | |
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 | ArcgisLinkChart | ArcgisMap | ArcgisScene | string | |
show-add-bookmark-button | boolean | |
show-close-button | boolean | |
show-collapse-button | boolean | |
show-edit-bookmark-button | boolean | |
show-filter | boolean | |
show-heading | boolean | |
state readonly | state | "loading" | "ready" |
autoDestroyDisabled
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.
- Attribute
- auto-destroy-disabled
- Default value
- false
defaultCreateOptions
defaultCreateOptions: BookmarkOptions
Specifies how new bookmarks will be created if visibleElements.addBookmarkButton is set to true
.
defaultEditOptions
defaultEditOptions: BookmarkOptions
Specifies how bookmarks will be edited, if visibleElements.editBookmarkButton is set to true
.
disabled
disabled: boolean
When true, the widget is visually withdrawn and cannot be interacted with.
- Attribute
- disabled
- Default value
- false
dragEnabled
dragEnabled: boolean
Indicates 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: string
Defines the text used as a placeholder when visibleElements.filter is set to true
.
- Attribute
- filter-placeholder
filterText
filterText: string
Defines the text used to filter the bookmarks when visibleElements.filter is set to true
.
- Attribute
- filter-text
icon
icon: string
Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component). Search Calcite Icons for possible values.
- 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: ArcgisLinkChart | ArcgisMap | ArcgisScene | string
- 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 view model's state.
- Attribute
- state
- Default value
- "ready"
Methods
Method | Signature |
---|---|
componentOnReady(): Promise<void> | |
destroy(): Promise<void> |
componentOnReady
componentOnReady(): Promise<void>
Create a promise that resolves once component is fully loaded.
- Returns
- Promise<void>
Events
Event | Type |
---|---|
BookmarksBookmarkEditEvent | |
{ name: "state"; } | |
undefined | |
BookmarksBookmarkSelectEvent |