Skip to content

PopupExpression Class

  • PopupExpression
  • class Esri::ArcGISRuntime::PopupExpression

    Defines an Arcade expression within a Popup. More...

    Header: #include <PopupExpression.h>
    Since: Esri::ArcGISRuntime 100.3
    Inherits: Esri::ArcGISRuntime::Object

    Public Functions

    PopupExpression(QObject *parent = nullptr)
    virtual ~PopupExpression() override
    QString expression() const
    QString name() const
    Esri::ArcGISRuntime::PopupExpressionReturnType returnType() const
    void setExpression(const QString &expression)
    void setName(const QString &name)
    void setReturnType(Esri::ArcGISRuntime::PopupExpressionReturnType returnType)
    void setTitle(const QString &title)
    QString title() const

    Detailed Description

    Arcade is an expression language that is supported across ArcGIS. It can be used to perform calculations, manipulate text, and evaluate logical statements. The expression can transform a list of attributes into engaging information for your audience. For example, to place a field value into a string of meaningful text you just need to use the `Concatenate` and `Text` functions. Explore Arcade's function reference for a full list of Arcade commands that offer a range of logical, geometry, math, and date functions.

    Once you have constructed an Arcade expression, pass it to the expression and specify a returnType. Pass the pop-up expression to ExpressionPopupElement::ExpressionPopupElement(Esri::ArcGISRuntime::PopupExpression*, QObject*) to create an ExpressionPopupElement.

    Member Function Documentation

    [explicit] PopupExpression::PopupExpression(QObject *parent = nullptr)

    Default constructor that takes an optional parent.

    Use a pop-up expression object to define an Arcade expression within a pop-up.

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

    Destructor.

    QString PopupExpression::expression() const

    Returns the Arcade expression defined in this expression.

    See also setExpression().

    QString PopupExpression::name() const

    Returns the name of this expression.

    See also setName().

    Esri::ArcGISRuntime::PopupExpressionReturnType PopupExpression::returnType() const

    Returns the return type of this expression.

    See also setReturnType().

    void PopupExpression::setExpression(const QString &expression)

    Sets the Arcade expression defined in this expression to expression.

    Please see the Arcade documentation for details on how to set an Arcade expression.

    See also expression().

    void PopupExpression::setName(const QString &name)

    Sets the name of this Arcade expression name.

    See also name().

    void PopupExpression::setReturnType(Esri::ArcGISRuntime::PopupExpressionReturnType returnType)

    Sets the return type of this expression to returnType.

    See also returnType().

    void PopupExpression::setTitle(const QString &title)

    Sets the title of this expression to title.

    See also title().

    QString PopupExpression::title() const

    Returns the title of this expression.

    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.