Position of the popup in relation to the selected feature.
This property indicates to the Popup
that it needs to allow or disallow the click event propagation.
Indicates whether to enable collapse functionality for the popup.
Indicates whether the popup displays its content.
The ID or node representing the DOM element containing the widget.
The content of the popup.
Dock position in the View.
Enables automatic creation of a popup template for layers that have popups enabled but no popupTemplate defined.
Indicates whether the placement of the popup is docked to the side of the view.
Docking the popup allows for a better user experience, particularly when opening popups in apps on mobile devices.
The number of selected features available to the popup.
When enabled, the popup displays a list of all available features (using each feature's popup template title) rather than displaying the popup template of the first selected feature.
An array of features associated with the popup.
This function provides the ability to override either the IMapView goTo() or SceneView goTo() methods.
Indicates the heading level to use for the title of the popup.
Highlight the selected popup feature using the highlightOptions set on the MapView or the highlightOptions set on the SceneView.
The unique ID assigned to the widget when the widget is created.
The widget's label.
Point used to position the popup.
Defines the maximum icons displayed at one time in the action area.
An array of pending Promises that have not yet been fulfilled.
The selected feature accessed by the popup.
Index of the feature that is selected.
Returns a reference to the current Feature that the Popup is using.
Indicates whether to display a spinner at the popup location prior to its display when it has pending promises.
The title of the popup.
This is a class that contains all the logic (properties and methods) that controls this widget's behavior.
Indicates whether the widget is visible.
The visible elements that are displayed within the widget.
Use this method to remove focus from the Widget.
A utility method used for building the value for a widget's class
property.
Closes the popup by setting its visible property to false
.
Destroys the widget instance.
Emits an event on the instance.
Use this method to return feature(s) at a given screen location.
Use this method to give focus to the Widget if the widget is able to be focused.
Indicates whether there is an event listener on the instance that matches the provided event name.
isFulfilled()
may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).
isRejected()
may be used to verify if creating an instance of the class is rejected.
isResolved()
may be used to verify if creating an instance of the class is resolved.
Selects the feature at the next index in relation to the selected feature.
Registers an event handler on the instance.
Opens the popup at the given location with content defined either explicitly with content
or driven from the PopupTemplate of input features.
Widget teardown helper.
This method is primarily used by developers when implementing custom widgets. Executes after widget is ready for rendering.
Selects the feature at the previous index in relation to the selected feature.
This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.
Renders widget to the DOM immediately.
Positions the popup on the view.
This method is primarily used by developers when implementing custom widgets. Schedules widget rendering.
Triggers the trigger-action event and executes the action at the specified index in the actions array.
when()
may be leveraged once an instance of the class is created.
Generated using TypeDoc
Defines actions that may be executed by clicking the icon or image symbolizing them in the popup.
Read more...