Obsolete Members for ArcadeEvaluator

ArcadeEvaluator

The following members of class ArcadeEvaluator are deprecated. They are provided to keep old source code working. We strongly advise against using them in new code.

Public Functions

Signals

Member Function Documentation

Esri::ArcGISRuntime::TaskWatcher ArcadeEvaluator::attributes(const QString &variableName, Esri::ArcGISRuntime::FeatureTable *attributeNameSource)

This function is deprecated. We strongly advise against using it in new code.

For a given profile variable, asynchronously gets a list of attributes used in the script.

• variableName - The name of the profile variable whose used attributes are returned.
• attributeNameSource - A FeatureTable from which we can get a list of all attribute names for the profile variable of interest.

To fully support the wildcard expansion in the expects statement, calculation of used attributes on a profile variable requires an object that can supply a full set of attribute names.

This method returns a TaskWatcher for the asynchronous operation.

Esri::ArcGISRuntime::TaskWatcher ArcadeEvaluator::attributes(const QString &variableName, Esri::ArcGISRuntime::GeoElement *attributeNameSource)

This function is deprecated. We strongly advise against using it in new code.

For a given profile variable, asynchronously gets a list of attributes used in the script.

• variableName - The name of the profile variable whose used attributes are required.
• attributeNameSource - A GeoElement from which we can get a list of all attributes names for the profile variable of interest.

To fully support the wildcard expansion in the expects statement, calculation of used attributes on a profile variable requires an object that can supply a full set of attribute names.

This method returns a TaskWatcher for the asynchronous operation.

[signal] void ArcadeEvaluator::attributesCompleted(const QUuid &taskId, const QStringList &stringResult)

This function is deprecated. We strongly advise against using it in new code.

Signal emitted when either the attributes(QString, FeatureTable), or attributes(QString, GeoElement) operations complete.

• taskId - The task ID of the asynchronous operation
• stringResult - The result of the asynchronous operation

Esri::ArcGISRuntime::TaskWatcher ArcadeEvaluator::evaluate(const QVariantMap &profileVariables)

This function is deprecated. We strongly advise against using it in new code.

Asynchronously evaluates the script using the supplied profileVariables.

• profileVariables - The profile variables for the script as key/value pairs. Required for evaluation.

Each entry of the profileVariables map is placed into the interpreter as a value accessible throughout the script. The name and type of these should comply with the profile the Arcade evaluator has been constructed with. Values are not persisted across evaluations, meaning all required profile variables must be supplied with each evaluation.

Each value of a key/value pair in the map is converted to a type understood by the interpreter. The result is then placed into the interpreter as a profile variable using the key as its name.

Values in the map can be any of the following types:

• QString
• Integers and floating points of various sizes. Arcade uses doubles for all internal calculations.
• Boolean.
• QDateTime
• Geometry
• GeoElement (or anything derived from it such as Feature, EncFeature)
• FeatureTable, see FeatureTableType
• Geodatabase
• GeoModel (or anything derived from it such as Map or Scene)
• ServiceGeodatabase
• Location
• QVariantMap. The keys of the map will always be strings and the values could be of any type in this list. This can be recursive.

The following list describes how these API types are converted to Arcade types.

• GeoElement types are converted to an Arcade Feature type.
• Location is converted to an Arcade Feature type.
• FeatureTable types are converted to an Arcade FeatureSet type.
• Geodatabase is converted to an Arcade FeatureSetCollection type.
• ServiceGeodatabase is converted to an Arcade FeatureSetCollection type.
• GeoModel is converted to an Arcade FeatureSetCollection type.

This method returns a TaskWatcher for the asynchronous operation.

[signal] void ArcadeEvaluator::evaluateCompleted(const QUuid &taskId, Esri::ArcGISRuntime::ArcadeEvaluationResult *arcadeEvaluationResult)

This function is deprecated. We strongly advise against using it in new code.

Signal emitted when the evaluate operation completes.

• taskId - The task ID of the asynchronous operation.
• arcadeEvaluationResult - the result of the asynchronous operation.

See also Returned QObjects Parenting.