import type { PopupAction, PopupPositionResult, PopupPositionVariable, PopupPositionValue, Alignment } from "@arcgis/core/widgets/Popup/types.js";Type definitions
PopupAction
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- ActionButton | ActionToggle
PopupPositionResult
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- "top-left" | "top-center" | "top-right" | "bottom-left" | "bottom-center" | "bottom-right"
PopupPositionVariable
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- "auto" | "top-leading" | "top-trailing" | "bottom-leading" | "bottom-trailing"
Alignment
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- PopupPositionValue | (() => PopupPositionValue)
PopupDockPosition
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- PopupPositionValue | (() => PopupPositionValue)
ActionEvent
- Since
- ArcGIS Maps SDK for JavaScript 5.0
action
- Type
- PopupAction
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The action clicked by the user. For a description of this object and a specification of its properties, see the Popup.actions property of this class.
DockOptions
- Since
- ArcGIS Maps SDK for JavaScript 5.0
position
- Type
- PopupDockPosition | undefined
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The position in the view at which to dock the popup.
Can be set as either a string or function. See the table below for known
string values and their position in the view based on the view's size.
| Known Value | View size > breakpoint | View size < breakpoint (at xsmall view breakpoint) |
|---|---|---|
| auto | top-right | top-right |
| top-left | top-left | top-left |
| top-center | top-center | top 100% |
| top-right | top-right | top right |
| bottom-left | bottom-left | bottom left |
| bottom-center | bottom-center | bottom 100% |
| bottom-right | bottom-right | bottom right |
If viewing the popup in a mobile UI, the default dock position is bottom 100%.
- Default value
- auto
breakpoint
- Type
- DockOptionsBreakpoint | boolean | undefined
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Defines the dimensions of the View
at which to dock the popup. Set to false to disable docking at a breakpoint.
- Default value
- true
InitialDisplayOptions
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- "list" | "feature"
PopupOpenOptions
- Since
- ArcGIS Maps SDK for JavaScript 5.0
actions
- Type
- Collection<PopupAction> | undefined
- Since
- ArcGIS Maps SDK for JavaScript 5.0
This property allows you to specify a collection of actions to the action bar when the Features widget opens.
content
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Sets the Popup.content of the popup.
features
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Sets the popup's Popup.features, which populate the title and content of the popup based on each graphic's PopupTemplate.
featureMenuOpen
- Since
- ArcGIS Maps SDK for JavaScript 5.0
This property enables multiple features in a popup to display in a list rather than displaying the first selected feature. Setting this to true
allows the user to scroll through the list of features.
This value will only be honored if PopupViewModel.initialDisplayMode is set to feature.
- Default value
- false
fetchFeatures
- Since
- ArcGIS Maps SDK for JavaScript 5.0
When true, indicates the the content of this feature should be fetched and displayed. If no PopupTemplate exists, a default template is created for the layer if
Popup.defaultPopupTemplateEnabled = true. In order for this option to work, there must be a valid view and location set.
- Default value
- false
location
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Sets the popup's Popup.location, which is the geometry used to position the popup.
promises
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Sets pending Popup.promises on the popup. The popup will display once the promises resolve. Each promise must resolve to an array of Graphics.
title
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Sets the Popup.title of the popup.
updateLocationEnabled
- Since
- ArcGIS Maps SDK for JavaScript 5.0
When true, indicates the popup should update its Popup.location for each paginated feature based on the selectedFeature's geometry.
- Default value
- false
FetchFeaturesOptions
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Optional properties to use with the Features.fetchFeatures() and Popup.fetchFeatures() methods.
- Supertypes
- AbortOptions
event
- Type
- ClickEvent | undefined