FeatureTableListModel QML Type

A list model storing a list of tables available in a Map or related to another FeatureTable. More...

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

Properties

count : int
error : Error

Signals

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

Methods

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

Detailed Description

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

Modifying this model (adding, removing, moving) will update the tables available in the Map.

The model returns data for the following roles:

Role	Type	Description
name	string	The table's name.
geometryType	Enums.GeometryType	The tables's geometry type.
hasGeometry	bool	Whether the table contains features with geometry.
editable	bool	Whether the table is editable.
numberOfFeatures	string	The number of features within the table.
loadError (deprecated)	int	The table's load error code.
loadStatus	Enums.LoadStatus	The table's load status.

Property Documentation

count : int

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

error : Error

Returns the Error object (read-only).

Signal Documentation

countChanged()

Emitted when the count property of the model changes.

Note: The corresponding handler is onCountChanged.

errorChanged()

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

Note: The corresponding handler is onErrorChanged.

itemAdded(int index)

Signal emitted when an item is added to the list model.

index is the index of the added item.

Note: The corresponding handler is onItemAdded.

This signal was introduced in Esri.ArcGISRuntime 100.15.

itemRemoved(int index)

Signal emitted when an item is removed from the list model.

index is the index of the removed item.

Note: The corresponding handler is onItemRemoved.

This signal was introduced in Esri.ArcGISRuntime 100.15.

Method Documentation

void append(FeatureTable featureTable)

Appends a featureTable to the list model.

void clear()

Removes all FeatureTables from the list model.

bool contains(FeatureTable featureTable)

Returns true if the list model contains the specified featureTable.

error forEach(callback)

Receives a callback function to execute for each FeatureTable in the model.

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

element - Current FeatureTable.
index - Current index in array.
array - Reference to FeatureTableListModel.

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

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

FeatureTable get(int index)

Returns the FeatureTable at the specified index.

int indexOf(FeatureTable featureTable)

Returns the index of the feature table (featureTable) specified.

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

void insert(int index, FeatureTable featureTable)

Inserts a FeatureTable featureTable at the specified index in the list.

void move(int from, int to)

Moves one FeatureTable from an index in the list model to a different index.

void remove(int index, int count = 1)

Removes one or more objects 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(FeatureTable featureTable)

Removes the specified feature table (featureTable) from the list model.

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