FieldsPopupElement Class

  • FieldsPopupElement
  • class Esri::ArcGISRuntime::FieldsPopupElement

    Represents a pop-up element of type fields that is displayed in a pop-up for a geoelement. 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
    QStringList formattedValues() const
    QStringList labels() const
    void setDescription(const QString &description)
    void setTitle(const QString &title)
    QString title() const

    Detailed Description

    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] 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 when Popup::evaluateExpressionsAsync is called.

    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 is false, this property will return an empty collection.

    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 when Popup::evaluateExpressionsAsync is called.

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

    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. Can be an empty string.

    See also setTitle().

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.