SymbolListModel QML Type

A list model storing a list of symbols. More...

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

Properties

count : int
error : Error

Signals

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

Methods

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

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 symbols belonging to the model's parent type (i.e. CompositeSymbol).

The model returns data for the following roles:

Role	Type	Description
symbolUrl	url	A file URL to the symbol's swatch image.

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

Appends a symbol to the symbol list model.

void clear()

Removes all symbols from the list model.

bool contains(Symbol symbol)

Returns true if the list model contains the specified symbol.

error forEach(callback)

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

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

element Current symbol.
index Current index in array.
array Reference to SymbolListModel.

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

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

Symbol get(int index)

Returns the Symbol at the specified index.

int indexOf(Symbol symbol)

Returns the index of a specific symbol (symbol) from the list model.

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

void insert(int index, Symbol symbol)

Inserts a symbol at a specified index in the list.

void move(int from, int to)

Moves one symbol 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(Symbol symbol)

Removes the specified symbol (symbol) from the list model.

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