Skip To Content ArcGIS for Developers Sign In Dashboard

FeatureCollection QML Type

A container for a collection of FeatureCollectionTables. More...

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

Object

Properties

Signals

Methods

  • void save()
  • void saveAs(Portal portal, string title, list tags, PortalFolder folder, string description, url thumbnailImage)

Detailed Description

Represents a collection of features, usually contained in a web map (by-value) or portal item (by-reference). The features are stored in a FeatureCollection as a collection of FeatureCollectionTables. Use this object to maintain and serialize collections of features to and from JSON, and to save them to and load them from portal items.

See also JsonSerializable and Loadable.

Property Documentation

item : ArcGISItem

The item used to create this FeatureCollection.

Note that this property can only be changed or assigned before the FeatureCollection is loaded with layers.

See also Loadable.


json : jsobject

JSON that can be used to instantiate the type instance.


loadError : Error

Returns the load error (read-only).

Note: load errors are also reported on the error property and emit the errorChanged signal.

See also Loadable.


loadStatus : Enums.LoadStatus

The Enums.LoadStatus of the Layer.

See also Loadable and Enums.LoadStatus.


saveStatus : Enums.TaskStatus

The save status of one of the asynchronous save operations:

Check this status when the saveStatusChanged signal emits.

This QML property was introduced in Esri.ArcGISRuntime 100.1.

See also Enums.TaskStatus.


Returns the list model of tables in this FeatureCollection (read-only).

See also FeatureCollectionTable.


unknownJson : jsobject

Returns unknown JSON data from the source JSON. (read-only).

Unknown JSON data consists of values that are in the source JSON but not parsed by ArcGIS Runtime.


unsupportedJson : jsobject

Returns unsupported JSON data from the source JSON. (read-only).

Unsupported JSON data consists of values that are supported by web maps, but are not exposed through the ArcGIS Runtime API.


Signal Documentation

itemChanged()

Emitted when the item property changes.


loadErrorChanged()

Emitted when the loadError property changes.

Note: load errors are also reported on the error property and emit the errorChanged signal.

See also Loadable and Object.


loadStatusChanged()

Emitted when the loadStatus property changes.

See also Loadable.


saveStatusChanged()

Emitted when the saveStatus property of this FeatureCollection changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.1.


tablesChanged()

Emitted when the tables property changes.


Method Documentation

void save()

Saves any changes that have been made to the FeatureCollection to the associated PortalItem.

The FeatureCollection must have been constructed using the PortalItem constructor to associate it with a PortalItem object, or must have been previously saved using saveAs.

Updates the FeatureCollection content data on the portal and also updates the portal item properties stored on the portal to match those stored within the FeatureCollection's PortalItem object.

If the portal associated with the item is not loaded, it will be loaded automatically. If the portal requires a credential that has not been supplied, it should be loaded before calling this function.

The FeatureCollection must be loaded to call this function. Calling this function will not force the FeatureCollection to start loading. If the FeatureCollection is not already associated with a PortalItem, calling save will emit loadErrorChanged.

The saveStatus property shows the progress of a save operation.

This QML method was introduced in Esri.ArcGISRuntime 100.1.


void saveAs(Portal portal, string title, list tags, PortalFolder folder, string description, url thumbnailImage)

Saves the FeatureCollection to a new PortalItem.

The FeatureCollection does not need to be associated with an existing PortalItem object. Updates the FeatureCollection content data on the portal, and updates the portal item properties stored on the portal to match those stored within the FeatureCollection's PortalItem object.

The FeatureCollection must be loaded to call this function. Calling this function will not force the FeatureCollection to start loading.

Note: If the FeatureCollection was already associated with a PortalItem object (either because the FeatureCollection was created using a PortalItem or was previously saved), that object will be replaced with a new PortalItem, effectively duplicating the FeatureCollection on the portal.

The saveStatus property shows the progress of a saveAs operation.

This QML method was introduced in Esri.ArcGISRuntime 100.1.



Feedback on this topic?