A container for a collection of FeatureCollectionTables. More...
Import Statement: | import Esri.ArcGISRuntime |
Since: | Esri.ArcGISRuntime 100.0 |
Inherits: |
- List of all members, including inherited members
- FeatureCollection is part of QML Type List.
Properties
- item : ArcGISItem
- json : jsobject
- loadError : Error
- loadStatus : Enums.LoadStatus
- saveStatus : Enums.TaskStatus
- tables : FeatureCollectionTableListModel
- unknownJson : jsobject
- unsupportedJson : jsobject
Signals
Methods
- void cancelLoad()
- void load()
- void retryLoad()
- void save()
- void saveAs(Portal portal, string title, list tags, PortalFolder folder, string description, url localThumbnailImage)
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.
[read-only] 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.
[read-only] loadStatus : Enums.LoadStatus |
The Enums.LoadStatus of the Layer.
See also Loadable and Enums.LoadStatus.
[read-only, since Esri.ArcGISRuntime 100.1] saveStatus : Enums.TaskStatus |
The save status of one of the asynchronous save operations:
Check this status when the saveStatusChanged signal emits.
This property was introduced in Esri.ArcGISRuntime 100.1.
See also Enums.TaskStatus.
[read-only] tables : FeatureCollectionTableListModel |
Returns the list model of tables in this FeatureCollection (read-only).
See also FeatureCollectionTable.
[read-only] 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 this API.
[read-only] 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 this API.
Signal Documentation
itemChanged() |
Emitted when the item property changes.
Note: The corresponding handler is onItemChanged
.
loadErrorChanged() |
loadStatusChanged() |
Emitted when the loadStatus property changes.
Note: The corresponding handler is onLoadStatusChanged
.
See also Loadable.
|
Emitted when the saveStatus property of this FeatureCollection changes.
Note: The corresponding handler is onSaveStatusChanged
.
This signal was introduced in Esri.ArcGISRuntime 100.1.
Method Documentation
void cancelLoad() |
See also Loadable.
void load() |
See also Loadable.
void retryLoad() |
See also Loadable.
|
Saves this feature collection back to the item it originated from.
The feature collection must have a valid item property and if the operation was successful the item will be updated with the feature collection. A feature collection has a valid item property if it was created using FeatureCollection or has been previously saved as a new item.
Returns a string representing the task ID of the asynchronous task.
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 method was introduced in Esri.ArcGISRuntime 100.1.
|
Saves this feature collection as a new feature collection item on the specified portal with the given title in the given folder.
- portal - The portal to save the feature collection to.
- folder - The folder in which to save the feature collection. If
null
, it will be added to the user's root folder. - title - The title of the feature collection.
- description - The description of the feature collection.
- tags - The tags to be associated with the newly created portal item.
- localThumbnailImage - The thumbnail of the feature collection.
Once completed, item will be populated with the new portal item. Note that if the feature collection already has a valid item property (either because the feature collection was created using an item or was previously saved), that property will be replaced with a new item, effectively duplicating the feature collection on the portal.
Returns a string representing the task ID of the asynchronous task.
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 method was introduced in Esri.ArcGISRuntime 100.1.