• FieldsPopupElement
  • class Esri::ArcGISRuntime::FieldsPopupElement

    A pop-up element that displays the fields of a GeoElement in a pop-up. More...

    Header: #include <FieldsPopupElement>
    Since: Esri::ArcGISRuntime 100.14
    Inherits: Esri::ArcGISRuntime::PopupElement

    Public Functions

    FieldsPopupElement(const QList<Esri::ArcGISRuntime::PopupField *> &fields, QObject *parent = nullptr)
    virtual ~FieldsPopupElement() override
    QString description() const
    Esri::ArcGISRuntime::PopupFieldListModel *fields() const
    (since Esri::ArcGISRuntime 200.3) QStringList formattedValues() const
    (since Esri::ArcGISRuntime 200.3) QStringList labels() const
    void setDescription(const QString &description)
    void setTitle(const QString &title)
    QString title() const

    Detailed Description

    The order of the fields PopupFieldListModel defines the order in which fields are displayed in the pop-up. Each field has a PopupField definition that defines the field format, whether the field is visible, editable, and so on.

    See also PopupElementType.

    Member Function Documentation

    [explicit] FieldsPopupElement::FieldsPopupElement(const QList<Esri::ArcGISRuntime::PopupField *> &fields, QObject *parent = nullptr)

    Creates a new fields pop-up element with the given QList of PopupField.

    • fields - An QList of PopupField objects defining how each field participates in the pop-up window.
    • parent - The optional parent QObject.

    The order of the QList is the order that fields are shown in the pop-up window.

    [override virtual noexcept] FieldsPopupElement::~FieldsPopupElement()

    Destructor.

    QString FieldsPopupElement::description() const

    Returns a string value describing the element in detail. Can be an empty string.

    See also setDescription().

    Esri::ArcGISRuntime::PopupFieldListModel *FieldsPopupElement::fields() const

    Returns a QList of PopupField objects defining how each field participates in the pop-up window.

    [since Esri::ArcGISRuntime 200.3] QStringList FieldsPopupElement::formattedValues() const

    Returns the formatted values for the fields defined in fields.

    This property is populated once Popup::evaluateExpressionsAsync has completed successfully.

    Dates and times are returned in the local timezone. If a field is part of a CodedValueDomain, the CodedValue::name is returned. If PopupElement::isEvaluated value is false, an empty QStringList is returned.

    This function was introduced in Esri::ArcGISRuntime 200.3.

    [since Esri::ArcGISRuntime 200.3] QStringList FieldsPopupElement::labels() const

    Returns the user-friendly display names for the fields defined in fields.

    This property is populated once Popup::evaluateExpressionsAsync has completed successfully.

    If PopupElement::isEvaluated is false, this property will return an empty QStringList.

    This function was introduced in Esri::ArcGISRuntime 200.3.

    void FieldsPopupElement::setDescription(const QString &description)

    Sets the description to description.

    See also description.

    void FieldsPopupElement::setTitle(const QString &title)

    Sets the title to title.

    See also title.

    QString FieldsPopupElement::title() const

    Returns a string value indicating what the element represents. The value can be an empty string.

    See also setTitle().