RelationshipPopupElement Class

  • RelationshipPopupElement
  • class Esri::ArcGISRuntime::RelationshipPopupElement

    Represents a pop-up element of type relationship that is displayed in a pop-up for a geoelement. More...

    Header: #include <RelationshipPopupElement.h>
    Since: Esri::ArcGISRuntime 200.1
    Inherits: Esri::ArcGISRuntime::PopupElement

    Public Functions

    RelationshipPopupElement(qint64 relationshipId, QObject *parent = nullptr)
    virtual ~RelationshipPopupElement() override
    QString description() const
    int displayCount() const
    QList<Esri::ArcGISRuntime::OrderBy> orderByFields() const
    qint64 relationshipId() const
    void setDescription(const QString &description)
    void setDisplayCount(int displayCount)
    void setTitle(const QString &title)
    QString title() const

    Detailed Description

    A typical UI implementation displays a preview of displayCount related records with a possibility to show more records and more detailed info by record.

    See also PopupElementType.

    Member Function Documentation

    [explicit] RelationshipPopupElement::RelationshipPopupElement(qint64 relationshipId, QObject *parent = nullptr)

    Creates a new relationship pop-up element with the given relationship ID.

    • relationshipId - The id of the relationship as defined in the feature layer definition.
    • parent - The optional parent QObject.

    [override virtual] RelationshipPopupElement::~RelationshipPopupElement()


    QString RelationshipPopupElement::description() const

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

    See also setDescription().

    int RelationshipPopupElement::displayCount() const

    Returns the maximum number of records to display.

    The default value is 3.

    If this maximum number is 0, no records will be displayed in the preview.

    See also setDisplayCount().

    QList<Esri::ArcGISRuntime::OrderBy> RelationshipPopupElement::orderByFields() const

    Returns a QList of OrderBy objects indicating the display order for the related records and whether they should be sorted in ascending or descending order.

    If this collection is empty, the related records are displayed in whatever order the server decides.

    See also SortOrder.

    qint64 RelationshipPopupElement::relationshipId() const

    Returns the id of the relationship as defined in the feature layer definition.

    void RelationshipPopupElement::setDescription(const QString &description)

    Sets the description to description.

    See also description.

    void RelationshipPopupElement::setDisplayCount(int displayCount)

    Sets the displayCount to displayCount.

    See also displayCount.

    void RelationshipPopupElement::setTitle(const QString &title)

    Sets the title to title.

    See also title.

    QString RelationshipPopupElement::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.