FeatureCollectionTableListModel QML Type

A list model that stores a list of feature collection tables in a feature collection. More...

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

Properties

count : int
error : Error

Signals

countChanged()
errorChanged()
itemAdded(int index)
itemRemoved(int index)

Methods

void append(FeatureCollectionTable featureCollectionTable)
void clear()
bool contains(FeatureCollectionTable featureCollectionTable)
error forEach(callback)
FeatureCollectionTable get(int index)
int indexOf(FeatureCollectionTable featureCollectionTable)
void insert(int index, FeatureCollectionTable featureCollectionTable)
void move(int from, int to)
void remove(int index, int count)
void removeOne(FeatureCollectionTable featureCollectionTable)

Detailed Description

Note: You cannot declare or create a component of this type in QML code.

Modifying this model (adding, removing, or moving) will update the feature collection tables available in the FeatureCollection.

The model returns data for the following roles:

Role	Type	Description
title (deprecated)	string	The feature collection table's title. Use displayName instead.
displayName	string	The feature collection table's display name.

Property Documentation

count : int

Returns the number of objects in the model (read-only).

error : Error

Returns the error object in case an error occurs (read-only).

Signal Documentation

countChanged()

Emitted when the count property of the model changes.

Note: The corresponding handler is onCountChanged.

errorChanged()

Emitted when the error property changes, which can indicate that an error occurred.

Note: The corresponding handler is onErrorChanged.

itemAdded(int index)

Emitted when an item is added to the list model at the index specified in the parameter.

Note: The corresponding handler is onItemAdded.

This signal was introduced in Esri.ArcGISRuntime 100.15.

itemRemoved(int index)

Emitted when an item is removed from the list model at the index specified in the parameter.

Note: The corresponding handler is onItemRemoved.

This signal was introduced in Esri.ArcGISRuntime 100.15.

Method Documentation

void append(FeatureCollectionTable featureCollectionTable)

Appends a feature collection table (featureCollectionTable) to the feature collection table list model.

void clear()

Removes all feature collection tables from the list model.

bool contains(FeatureCollectionTable featureCollectionTable)

Returns true if the list model contains the specified FeatureCollectionTable (featureCollectionTable).

error forEach(callback)

Receives a callback function to execute for each feature collection table in the model.

The callback function can take 0 to 3 optional arguments, in order:

element Current feature collection table.
index Current index in array.
array Reference to FeatureCollectionTableListModel.

Returns undefined if no error occurred, and an error message otherwise.

const error = FeatureCollectionTableListModel.forEach(function(element, index, array) {
    ...
});
if (error) {
    console.error(error.message);
}

FeatureCollectionTable get(int index)

Returns the FeatureCollectionTable at the specified index.

int indexOf(FeatureCollectionTable featureCollectionTable)

Returns the index of the feature collection table (featureCollectionTable) specified.

This method was introduced in Esri::ArcGISRuntime 100.5..

void insert(int index, FeatureCollectionTable featureCollectionTable)

Inserts a feature collection table (featureCollectionTable) at a specified index.

This method will append to the list model if the index is greater than the current size of the list model.

void move(int from, int to)

Moves one feature collection table from an index in the list model to a different index.

void remove(int index, int count = 1)

Removes one or more feature collection tables starting at the specified index.

index Index of first object to remove.
count Number of objects to remove. This parameter defaults to 1.

void removeOne(FeatureCollectionTable featureCollectionTable)

Removes the specified feature collection table (featureCollectionTable) from the list model.

This method was introduced in Esri::ArcGISRuntime 100.5..