Popup Class
The combination of a PopupDefinition and a GeoElement, which allows a visual representation of the GeoElement's attributes as well as the ability to edit them. More...
| Header: | #include <Popup> |
| Since: | Esri::ArcGISRuntime 100.0 |
| Inherits: | Object |
Public Functions
| Popup(GeoElement *geoElement, QObject *parent = nullptr) | |
| Popup(GeoElement *geoElement, PopupDefinition *popupDefinition, QObject *parent = nullptr) | |
| ~Popup() | |
| TaskWatcher | evaluateExpressions() const |
| QString | formattedValue(PopupField *popupField) const |
| GeoElement * | geoElement() const |
| PopupDefinition * | popupDefinition() const |
| Symbol * | symbol() const |
| QString | title() const |
- 31 public functions inherited from QObject
Signals
| void | evaluateExpressionsCompleted(QUuid taskId, const QList<Esri::ArcGISRuntime::PopupExpressionEvaluation *> &popupExpressionEvaluationResults) |
- 1 signal inherited from Esri::ArcGISRuntime::Object
- 2 signals inherited from QObject
Additional Inherited Members
- 1 property inherited from QObject
- 1 public slot inherited from QObject
- 1 public variable inherited from QObject
- 10 static public members inherited from QObject
- 9 protected functions inherited from QObject
- 2 protected variables inherited from QObject
Detailed Description
The combination of a PopupDefinition and a GeoElement, which allows a visual representation of the GeoElement's attributes as well as the ability to edit them.
Use the Popup to create a PopupManager. The PopupManager can then be used in conjunction with the PopupView (from the ArcGIS Runtime Toolkit) for a visual representation of the Popup.
Member Function Documentation
Popup::Popup(GeoElement *geoElement, QObject *parent = nullptr)
Constructor that takes a geoElement with an optional parent.
Popup::Popup(GeoElement *geoElement, PopupDefinition *popupDefinition, QObject *parent = nullptr)
Constructor that takes a geoElement and a popupDefinition with an optional parent.
If you pass in a null PopupDefinition, a default one will be created for you based on the GeoElement's attributes and schema.
Popup::~Popup()
Destructor.
TaskWatcher Popup::evaluateExpressions() const
Asynchronously evaluates all expressions, including Arcade FeatureSet functions, available at PopupDefinition::expressions().
This method must be called before displaying the popup information in a UI so you can use synchronous methods Popup::formattedValue() and PopupManager::substitute() to get the formatted string representation. If there are no PopupDefinition::expressions() then the result list will be empty.
The PopupExpression may be used in the PopupDefinition::fields(), PopupDefinition::media(), PopupDefinition::title() and PopupDefinition::description().
This function was introduced in Esri::ArcGISRuntime 100.8.
[signal] void Popup::evaluateExpressionsCompleted(QUuid taskId, const QList<Esri::ArcGISRuntime::PopupExpressionEvaluation *> &popupExpressionEvaluationResults)
Signal emitted after the popup expression evaluation asynchronous method completes.
- taskId - The task ID of the asynchronous task.
- popupExpressionEvaluationResults - The generated list of popupExpressionEvaluation results.
QString Popup::formattedValue(PopupField *popupField) const
Returns a string from a popupField that you can use in a display for the Popup's field value.
The string will have the proper formatting based on the field type and PopupField configuration. Dates/times are returned in the local timezone. This synchronous method doesn't support Arcade expressions with FeatureSet.
GeoElement *Popup::geoElement() const
Returns the GeoElement of this Popup.
PopupDefinition *Popup::popupDefinition() const
Returns the PopupDefinition of this Popup.
Symbol *Popup::symbol() const
Returns the Symbol of this Popup.
QString Popup::title() const
Returns the title of this Popup.