GeoprocessingFeatures QML Type

A features (or records) input or output parameter. More...

Import Statement: import Esri.ArcGISRuntime 100.15
Since: Esri.ArcGISRuntime 100.0
Inherits:

GeoprocessingParameter

Properties

Signals

Methods

Detailed Description

Corresponds to GPRecordSet and GPFeatureRecordSetLayer parameter types on the service.

When Features are returned as an output parameter, the returned features are provided in a GeoprocessingFeatureSet. These features can be visualized on a map using a temporary Graphic on a GraphicsOverlay or using a FeatureCollectionTable on a FeatureCollectionLayer. If the geoprocessing service used is configured to use a result map server, then GeoprocessingResult::mapImageLayer is populated and it can be used to visualize the results using the symbology predefined by the service.

When providing GeoprocessingFeatures as an input to the geoprocessing task, features can be provided directly from the FeatureQueryResult that was returned from the FeatureTable. If there is a need to create a new set of features or records, FeatureCollectionTable can be used.

This QML type supports the following default properties. A default property may be declared inside another declared object without being assigned explicitly to a property.

TypeDefault Property
FeatureSetfeatures
RequestConfigurationrequestConfiguration (deprecated since Esri.ArcGISRuntime 100.13)
Credentialcredential (deprecated since Esri.ArcGISRuntime 100.13)

Note: A feature contains a geometry and some number of attributes. A record (or a row) is a feature that doesn't contain a geometry, only attributes.

See also Cancelable and RemoteResource.

Property Documentation

canFetchOutputFeatures : bool

Returns whether features can be fetched from the service of an output parameter (read-only).

This property applies to output parameters. It indicates that the parameter is an output parameter that can fetch features from the geoprocessing service. Depending on the type of the service, the features may already be available.

If features are not present then this property indicates that you can use fetchOutputFeatures to request features, asynchronously updating the features property.


[default] features : FeatureSet

The FeatureSet that is the source of the features.


fetchOutputFeaturesResult : FeatureSet

Returns features from the fetchOutputFeatures task (read-only).


url : url

The URL that is the source of the features.


Signal Documentation

featuresChanged()

Emitted when the features property changes.

Note: The corresponding handler is onFeaturesChanged.


fetchOutputFeaturesStatusChanged()

Emitted when the fetchOutputFeaturesStatus property changes.

Note: The corresponding handler is onFetchOutputFeaturesStatusChanged.


urlChanged()

Emitted when the url property changes.

Note: The corresponding handler is onUrlChanged.


Method Documentation

bool cancelTask(string taskId)

Cancel the task with the ID taskId.

Returns false if the task cannot be canceled or there is no task with the specified id taskId.

See also Cancelable.


string fetchOutputFeatures()

Creates a task to fetch features.

Returns the task ID of the new task.

When the task completes, the features are available on the features property.


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