CodedValueDescriptionListModel QML Type

A list model storing coded value descriptions. More...

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

Properties

count : int
error : Error

Signals

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

Methods

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

Detailed Description

Note: You cannot declare or create a component of this type in QML code. The model returns data for the following roles:

Role	Type	Description
name	string	The coded value description's name.
value	var	The coded value description's value.

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

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(CodedValueDescription codedValueDescription)

Appends a codedValueDescription to the list model.

void clear()

Removes all coded value description from the list model.

bool contains(CodedValueDescription codedValueDescription)

Returns true if the list model contains the specified codedValueDescription.

error forEach(callback)

Receives a callback function to execute for each coded value description in the model.

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

element Current CodedValueDescription.
index Current index in array.
array Reference to CodedValueDescriptionListModel.

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

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

CodedValueDescription get(int index)

Returns the CodedValueDescription at the specified index.

int indexOf(CodedValueDescription codedValueDescription)

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

void insert(int index, CodedValueDescription codedValueDescription)

Inserts a codedValueDescription at a specified index in the list.

void move(int from, int to)

Moves one CodedValueDescription 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(CodedValueDescription codedValueDescription)

Removes the specified codedValueDescription from the list model.