import type { BookmarksState, BookmarkOptions, BookmarkEditEvent, BookmarkSelectEvent } from "@arcgis/map-components/components/arcgis-bookmarks/types.js";Type definitions
BookmarksState
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Specifies the state of the Bookmarks component.
- Type
- "loading" | "ready"
BookmarkOptions
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Specifies how bookmarks will be created or modified.
captureRotation
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Indicates whether the rotation of the current view will be saved in the Bookmark#viewpoint of a newly created or modified bookmark. Default is true.
captureScale
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Indicates whether the scale of the current view will be saved in the Bookmark#viewpoint of a newly created or modified bookmark. Default is true.
captureTimeExtent
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Indicates whether the time extent of the current view will be saved in the Bookmark#timeExtent of a newly created or modified bookmark. Default is true.
captureViewpoint
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Indicates whether the viewpoint of the current view will become the Bookmark#viewpoint of a newly created or modified bookmark. Default is true.
screenshotSettings
- Type
- Partial<UserSettings> | undefined
- Since
- ArcGIS Maps SDK for JavaScript 5.0
An object that specifies the settings of the screenshot that will be used to create the bookmark's Bookmark#thumbnail. The default screenshot size is 128px x 128px.
takeScreenshot
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Indicates whether a screenshot is taken when a new bookmark is created.
The screenshot will be set as the Bookmark#thumbnail in the newly created bookmark. Default is true.