Skip to content

PopupElement Class

  • PopupElement
  • class Esri::ArcGISRuntime::PopupElement

    A pop-up element displays information about a GeoElement in a pop-up. More...

    Public Functions

    virtual ~PopupElement() override
    (since Esri::ArcGISRuntime 200.3) bool isEvaluated() const
    Esri::ArcGISRuntime::PopupElementType popupElementType() const

    Reimplemented Public Functions

    (since Esri::ArcGISRuntime 200.1) virtual QString toJson() const override
    (since Esri::ArcGISRuntime 200.1, deprecated) virtual QJsonObject unknownJson() const override
    (since Esri::ArcGISRuntime 200.1, deprecated) virtual QJsonObject unsupportedJson() const override

    Static Public Members

    (since Esri::ArcGISRuntime 200.1) Esri::ArcGISRuntime::PopupElement *fromJson(const QString &json, QObject *parent = nullptr)

    Detailed Description

    This is the base class for pop-up elements such as AttachmentsPopupElement, ExpressionPopupElement, FieldsPopupElement, and MediaPopupElement. Pop-up elements allow users to author popups that have multiple elements such as field lists, rich text (HTML), media (charts and images), and attachments. They can also be defined using Arcade expressions to support dynamic configurations.

    See also PopupElementType, PopupDefinition::elements, and Popup::evaluatedElements.

    Member Function Documentation

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

    Destructor.

    [static, since Esri::ArcGISRuntime 200.1] Esri::ArcGISRuntime::PopupElement *PopupElement::fromJson(const QString &json, QObject *parent = nullptr)

    Converts a JSON string and returns an object.

    • json - The JSON string.
    • parent The parent object (optional).

    This function was introduced in Esri::ArcGISRuntime 200.1.

    See also JsonSerializable.

    [since Esri::ArcGISRuntime 200.3] bool PopupElement::isEvaluated() const

    Returns true if the pop-up element is contained in the Popup::evaluatedElements, false otherwise.

    This function was introduced in Esri::ArcGISRuntime 200.3.

    Esri::ArcGISRuntime::PopupElementType PopupElement::popupElementType() const

    Returns the type of instantiated pop-up element.

    [override virtual, since Esri::ArcGISRuntime 200.1] QString PopupElement::toJson() const

    Reimplements: JsonSerializable::toJson() const.

    Converts an object and returns a JSON string.

    This function was introduced in Esri::ArcGISRuntime 200.1.

    See also JsonSerializable.

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