FieldDescriptionListModel QML Type

A list model storing a list of FieldDescription objects in a TableDescription. More...

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

Properties

count : int
error : Error

Signals

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

Methods

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

Detailed Description

Modifying this model (adding, removing, moving) will update the FieldDescription's available in the TableDescription.

The model returns data for the following roles:

Role	Type	Description
alias	string	The field's alias.
domainName	string	The name of the domain to use on this field.
editable	bool	True if the field is editable.
fieldType	FieldType	The field's data type.
length	int	The length of the field.
name	string	The field's name.
nullable	bool	True if the field is nullable.

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.

elementRemoved(int index)

Emitted when an object is removed from the list model at the index specified in the parameter. Use itemRemoved(int index)

Note: The corresponding handler is onElementRemoved.

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(FieldDescription fieldDescription)

Appends a fieldDescription to the list model.

void clear()

Removes all field descriptions from the list model.

bool contains(FieldDescription fieldDescription)

Returns true if the list model contains the specified fieldDescription.

error forEach(callback)

Receives a callback function to execute for each pop-up field in the model.

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

element Current FieldDescription.
index Current index in array.
array Reference to FieldDescriptionListModel.

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

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

FieldDescription get(int index)

Returns the FieldDescription at the specified index.

int indexOf(FieldDescription fieldDescription)

Returns the index of a specific fieldDescription from the list model.

void insert(int index, FieldDescription fieldDescription)

Inserts a fieldDescription at a specified index in the list.

void move(int from, int to)

Moves one FieldDescription 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(FieldDescription fieldDescription)

Removes the specified fieldDescription from the list model.