UniqueValueListModel QML Type

A list model storing a list of unique values available in a UniqueValueRenderer. More...

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

Properties

count : int

Signals

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

Methods

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

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 unique values available in the unique value renderer.

The model returns data for the following roles:

Role	Type	Description
description	string	The description of the unique value.
label	string	The label used to display the unique value.
values	list<variant>	The attribute value or list of values that comprise the unique value.

Property Documentation

count : int

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

Signal Documentation

countChanged()

Emitted when the count property changes.

Note: The corresponding handler is onCountChanged.

itemAdded(int index)

Emitted when an object 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(UniqueValue uniqueValue)

Appends the unique value uniqueValue to the list model.

void clear()

Removes all unique values from the list model.

bool contains(UniqueValue uniqueValue)

Returns true if the list model contains the specified uniqueValue.

error forEach(callback)

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

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

element Current unique value.
index Current index in array.
array Reference to UniqueValueListModel.

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

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

UniqueValue get(int index)

Returns the unique value at the specified index.

int indexOf(UniqueValue uniqueValue)

Returns the index of a specific unique value (uniqueValue) from the list model.

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

void insert(int index, UniqueValue uniqueValue)

Inserts the unique value uniqueValue at a specified index.

void move(int from, int to)

Moves a unique value 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(UniqueValue uniqueValue)

Removes the specified unique value (uniqueValue) from the list model.

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