PopupManager Class

qmlRegisterUncreatableType<PopupManager>("Esri.Samples", 1, 0, "PopupManager", "PopupManager is uncreateable");
qmlRegisterUncreatableType<PopupAttachmentManager>("Esri.Samples", 1, 0, "PopupAttachmentManager", "PopupAttachmentManager is uncreateable");
qmlRegisterUncreatableType<PopupAttributeListModel>("Esri.Samples", 1, 0, "PopupAttributeListModel", "PopupAttributeListModel is uncreateable");
qmlRegisterUncreatableType<PopupAttachmentListModel>("Esri.Samples", 1, 0, "PopupAttachmentListModel", "PopupAttachmentListModel is uncreateable");

Member Function Documentation

PopupManager::PopupManager(Esri::ArcGISRuntime::Popup *popup, QObject *parent = nullptr)

Constructor that takes a popup with an optional parent.

[signal] void PopupManager::editingCompleted(Esri::ArcGISRuntime::Error errors)

Signal emitted when editing completes after finishEditing is called.

• errors - The Error object.

[signal] void PopupManager::evaluateExpressionsCompleted(QUuid taskId, const QList<Esri::ArcGISRuntime::PopupExpressionEvaluation *> &popupExpressionEvaluationResults)

Signal emitted when evaluateExpressions completes.

• taskId - The task ID of the asynchronous task.
• popupExpressionEvaluationResults - The generated list of PopupExpressionEvaluation.

The returned PopupExpressionEvaluation objects have the PopupManager as its parent.

See also Returned QObjects Parenting.

[signal] void PopupManager::featureTypeChanged()

Signal emitted when isFeatureType changes.

[signal] void PopupManager::geoElementContingencyValidationErrorsChanged(const QMap<QString, Esri::ArcGISRuntime::Error> &errors)

Signal emitted when the geoelement contingency validation errors change.

• errors - The Error object.

This function was introduced in Esri::ArcGISRuntime 100.14.

[signal] void PopupManager::geoElementContingencyValidationWarningsChanged(const QMap<QString, Esri::ArcGISRuntime::Error> &warnings)

Signal emitted when the geoelement contingency validation warnings change.

• warnings - The Error object.

This function was introduced in Esri::ArcGISRuntime 100.14.

[signal] void PopupManager::geoElementValidChanged()

Signal emitted when isGeoElementValid changes.

[signal] void PopupManager::geoElementWarningsChanged(const QMap<QString, Esri::ArcGISRuntime::Error> &warnings)

Signal emitted when the geoelement validation warnings change.

• warnings - The Error object.

This function was introduced in Esri::ArcGISRuntime 100.14.

[override virtual] PopupManager::~PopupManager()

Destructor.

Esri::ArcGISRuntime::PopupAttachmentManager *PopupManager::attachmentManager() const

Returns the PopupAttachmentManager for this PopupManager.

Returns null if there is no associated PopupAttachmentManager.

Note: Getter function for property attachmentManager.

This function was introduced in Esri::ArcGISRuntime 100.1.

void PopupManager::cancelEditing()

Cancels the editing session.

Any edits that have been made since starting will be discarded.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

QMap<QString, Esri::ArcGISRuntime::Error> PopupManager::contingencyValidationErrors() const

Returns one or more field group names, and for each field group name, an associated contingent-value validation error.

Errors are reported in validation when editing is defined as restrictive in the FieldGroup.

This function was introduced in Esri::ArcGISRuntime 100.14.

QMap<QString, Esri::ArcGISRuntime::Error> PopupManager::contingencyValidationWarnings() const

Returns one or more field group names, and for each field group name, an associated contingent-value validation warning.

Warnings are reported in validation when editing is defined as non-restrictive in the FieldGroup.

This function was introduced in Esri::ArcGISRuntime 100.14.

Esri::ArcGISRuntime::ContingentValuesResult *PopupManager::contingentValuesForField(Esri::ArcGISRuntime::PopupField *field) const

The returned result contains values for each FieldGroup and the field it belongs to. Multiple values are returned if the specified field belongs to multiple groups.

This function was introduced in Esri::ArcGISRuntime 100.14.

QString PopupManager::customHtmlDescription() const

Returns the text to display as the custom HTML description.

If PopupDefinition::expressions is not empty, the custom HTML description may be using expressions with Arcade FeatureSet functions. Use PopupManager::evaluateExpressions() to evaluate the Arcade expressions before trying to get the PopupManager::customHtmlDescription() otherwise it may not return the correct description.

Note: Getter function for property customHtmlDescription.

Esri::ArcGISRuntime::PopupAttributeListModel *PopupManager::displayedFields() const

Returns the fields for display use as a PopupAttributeListModel.

Note: Getter function for property displayedFields.

bool PopupManager::doesChangeRequireNotification(const Esri::ArcGISRuntime::FeatureTemplate &featureTemplate) const

Returns whether changes to the specified featureTemplate requires a notification to the user that some data may be overwritten by the change.

Esri::ArcGISRuntime::Domain PopupManager::domain(Esri::ArcGISRuntime::PopupField *popupField) const

Returns the Domain of the specified popupField.

QString PopupManager::editSummary() const

Returns the current edit summary.

Note: Getter function for property editSummary.

Esri::ArcGISRuntime::PopupAttributeListModel *PopupManager::editableFields() const

Returns the editable fields as a PopupAttributeListModel.

Note: Getter function for property editableFields.

Esri::ArcGISRuntime::GeometryBuilder *PopupManager::editingGeometryBuilder() const

Returns the GeometryBuilder used to edit the GeoElement's geometry.

See also setEditingGeometryBuilder().

Esri::ArcGISRuntime::TaskWatcher PopupManager::evaluateExpressions()

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.

QList<Esri::ArcGISRuntime::PopupElement *> PopupManager::evaluatedElements() const

Returns a QList of PopupElement objects evaluated asynchronously by evaluateExpressions. During the evaluation, the ExpressionPopupElement are replaced by the PopupElement returned by the Arcade expression. If the Arcade expression returns a list of attributes to use by the pop-up element, these attributes will be used by formattedValue(PopupField) or fieldValue(PopupField).

The QList is empty while evaluateExpressions has not been executed and is cleared if evaluateExpressions is executed more than once. After evaluation, the order of the PopupElement in the QList is the order that elements are in the PopupDefinition::elements and are shown in the pop-up window. If an ExpressionPopupElement is failed to be evaluated, it will be skipped in the QList. The error can be found in the list of PopupExpressionEvaluation returned from evaluateExpressions.

This function was introduced in Esri::ArcGISRuntime 100.14.

See also PopupDefinition::elements and evaluateExpressions.

QList<Esri::ArcGISRuntime::FeatureType> PopupManager::featureTypes() const

Returns a list of FeatureTypes or an empty list if the GeoElement is not an ArcGISFeature in an ArcGISFeatureTable.

Esri::ArcGISRuntime::PopupField *PopupManager::fieldByName(const QString &fieldName) const

Returns the PopupField object corresponding to the specified fieldName.

This will return nullptr if there is no such field or if the GeoElement is not an ArcGISFeature with fields.

QString PopupManager::fieldLabel(Esri::ArcGISRuntime::PopupField *popupField) const

Returns the label of the specified popupField.

If the field is based on a PopupExpression, the title of the expression will be returned.

This function was introduced in Esri::ArcGISRuntime 100.3.

Esri::ArcGISRuntime::FieldType PopupManager::fieldType(Esri::ArcGISRuntime::PopupField *popupField) const

Returns the FieldType of the specified popupField.

QVariant PopupManager::fieldValue(Esri::ArcGISRuntime::PopupField *popupField) const

Returns the value of the specified popupField.

If the field is part of a CodedValueDomain, the CodedValue::code is returned (unlike PopupManager::formattedValue, which returns the CodedValue::name)

QVariant PopupManager::fieldValue(const QString &fieldName, Esri::ArcGISRuntime::PopupElement *popupElement) const

Returns the attribute value for the field specified by a name.

• fieldName - The name of the field.
• popupElement - The pop-up element to look up for the field. This argument is useful only if the pop-up element is coming from an Arcade expression evaluation that can return a list of attributes (see evaluatedElements).

If any field is using expressions, use evaluateExpressions to evaluate the Arcade expressions before trying to get the fields' values. Otherwise, the values may not be evaluated properly.

If the field is part of a CodedValueDomain, the CodedValue::code is returned (unlike formattedValue(PopupField), which returns the CodedValue::name).

This function was introduced in Esri::ArcGISRuntime 100.14.

void PopupManager::finishEditing()

Finishes the editing session.

This runs asynchronously, and editingCompleted signal emit once the editing session has ended.

Note: The PopupManager does not automatically call applyEdits on the associated GeoElement's ArcGISFeatureTable. To commit any edits to the source data, call applyEdits on the associated ArcGISFeatureTable.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

QString PopupManager::formattedValue(Esri::ArcGISRuntime::PopupField *popupField) const

Returns a formatted string representation of the specified popupField.

If PopupDefinition::expressions is not empty, the PopupField may be using expressions with Arcade FeatureSet functions. Use PopupManager::evaluateExpressions() to evaluate the Arcade expressions before trying to get the formatted string representation of the popup field's value, otherwise it may return an empty string.

If the field is part of a CodedValueDomain, the CodedValue::name is returned.

bool PopupManager::isDeleteAllowed() const

Returns whether deleting the GeoElement is allowed.

Note: Getter function for property deleteAllowed.

bool PopupManager::isEditGeometryAllowed() const

Returns whether geometry editing is allowed.

Note: Getter function for property editGeometryAllowed.

bool PopupManager::isEditing() const

Returns whether the PopupManager is currently in editing mode.

Note: Getter function for property editing.

bool PopupManager::isEditingAllowed() const

Returns whether attribute editing is allowed.

Note: Getter function for property editingAllowed.

bool PopupManager::isFeatureType(Esri::ArcGISRuntime::PopupField *popupField) const

Returns whether the specified popupField is a FeatureType field.

bool PopupManager::isFieldInFieldGroup(Esri::ArcGISRuntime::PopupField *popupField) const

Returns whether the given popupField is part of a FieldGroup as defined in a ContingentValuesDefinition.

This function was introduced in Esri::ArcGISRuntime 100.14.

bool PopupManager::isGeoElementValid() const

Returns whether the GeoElement is valid.

Note: Getter function for property geoElementValid.

bool PopupManager::isNullable(Esri::ArcGISRuntime::PopupField *popupField) const

Returns whether the specified popupField is nullable.

bool PopupManager::isShowAttachments() const

Returns whether attachments should be shown.

Note: Getter function for property showAttachments.

bool PopupManager::isShowCustomHtmlDescription() const

Returns whether the showCustomHtmlDescription should be shown.

Note: Getter function for property showCustomHtmlDescription.

bool PopupManager::isShowEditSummary() const

Returns whether the showEditSummary should be shown.

Note: Getter function for property showEditSummary.

bool PopupManager::isShowMedia() const

Returns whether media should be shown.

Note: Getter function for property showMedia.

int PopupManager::maxLength(Esri::ArcGISRuntime::PopupField *popupField) const

Returns the maximum allowed length of the specified popupField.

Esri::ArcGISRuntime::Popup *PopupManager::popup() const

Returns the Popup that is being managed.

QString PopupManager::rangeDomainValidationText(Esri::ArcGISRuntime::PopupField *popupField) const

Returns a string that can be used to hint the acceptable values for a RangeDomain in a popupField.

void PopupManager::setEditingGeometryBuilder(Esri::ArcGISRuntime::GeometryBuilder *builder)

Sets the GeometryBuilder used to edit the GeoElement's geometry.

• builder - The GeometryBuilder.

See also editingGeometryBuilder().

bool PopupManager::startEditing()

Initiates an editing session with the Popup.

Returns true if editing was started successfully and false if editing is already started or not allowed.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

QString PopupManager::substitute(const QString &templateString) const

Substitutes attribute values for attribute place-holders in a given templateString.

If PopupDefinition::expressions is not empty, the input string may be using expressions with Arcade FeatureSet functions. Use PopupManager::evaluateExpressions() to evaluate the Arcade expressions before trying to get the substitute string, otherwise it may return an empty string.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

Esri::ArcGISRuntime::Symbol *PopupManager::symbol() const

Returns the Symbol of the Popup.

QString PopupManager::title() const

Returns the Popup's title text.

Note: Getter function for property title.

Esri::ArcGISRuntime::Error PopupManager::updateValue(const QVariant &newValue, Esri::ArcGISRuntime::PopupField *popupField)

Updates the value of the specified popupField to the specified newValue.

Esri::ArcGISRuntime::Error PopupManager::updateValue(const Esri::ArcGISRuntime::FeatureTemplate &featureTemplate, Esri::ArcGISRuntime::FeatureTypeChangeMode changeMode)

Updates the GeoElement's featureTemplate, which in turn updates the values of its attribute table to match those in the feature template, dependent on the changeMode.

Esri::ArcGISRuntime::Error PopupManager::validationError(Esri::ArcGISRuntime::PopupField *popupField) const

Returns the validation Error for the specified popupField.