Skip To Content ArcGIS for Developers Sign In Dashboard

UniqueValueListModel QML Type

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

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

Properties

Signals

Methods

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:

RoleTypeDescription
descriptionstringThe description of the unique value.
labelstringThe label used to display the unique value.
valueslist<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.


uniqueValueAdded(index)

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

Note: The corresponding handler is onUniqueValueAdded.


uniqueValueRemoved(index)

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

Note: The corresponding handler is onUniqueValueRemoved.


Method Documentation

void append(uniqueValue)

Appends the unique value uniqueValue to the list model.


void clear()

Removes all unique values from the list model.


bool contains(uniqueValue)

Returns true if the list model contains the specified uniqueValue.


void 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.

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

UniqueValue get(index)

Returns the unique value at the specified index.


int indexOf(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(index, UniqueValue uniqueValue)

Inserts the unique value uniqueValue at a specified index.


void move(from, int to)

Moves a unique value from an index in the list model to a different index.


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

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

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


void setProperty(index, string property, variant value)

Changes the property of the unique value at index to value.



Feedback on this topic?