VectorMarkerSymbolElementListModel QML Type

A list model storing a list of vector marker symbol elements. More...

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

Properties

count : int
error : Error

Signals

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

Methods

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

Detailed Description

Modifying this model (adding, removing, moving) will update the VectorMarkerSymbolLayer.

The model returns data for the following roles:

Role	Type	Description
geometry	Geometry	The geometry.
symbol	Symbol	The symbol.

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

Appends a vectorMarkerSymbolElement to the symbol list model.

void clear()

Removes all vector marker symbol elements from the list model.

bool contains(VectorMarkerSymbolElement vectorMarkerSymbolElement)

Returns true if the list model contains the specified vectorMarkerSymbolElement.

void 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 vector marker symbol element.
index Current index in array.
array Reference to VectorMarkerSymbolElementListModel.

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

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

VectorMarkerSymbolElement get(int index)

Returns the VectorMarkerSymbolElement at the specified index.

int indexOf(VectorMarkerSymbolElement vectorMarkerSymbolElement)

Returns the index of a specific vector marker symbol element (vectorMarkerSymbolElement) from the list model.

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

void insert(int index, VectorMarkerSymbolElement vectorMarkerSymbolElement)

Inserts a vectorMarkerSymbolElement at a specified index in the list.

void move(int from, int to)

Moves one vector marker symbol element 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(VectorMarkerSymbolElement vectorMarkerSymbolElement)

Removes the specified vector marker symbol element (vectorMarkerSymbolElement) from the list model.

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