KmlNodeListModel QML Type

A list model storing a list of KmlNodes available in a KmlContainer. More...

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

Properties

count : int
error : Error

Signals

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

Methods

void append(QmlKmlNode kmlNode)
void clear()
bool contains(KmlNode kmlNode)
error forEach(callback)
KmlNode get(int index)
int indexOf(KmlNode kmlNode)
void insert(int index, KmlNode kmlNode)
void move(int from, int to)
void remove(int index, int count)
void removeOne(KmlNode kmlNode)
void size()

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 nodes available in the KmlContainer.

Property Documentation

count : int

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

error : Error

Returns the error object in case an error occurs (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(QmlKmlNode kmlNode)

Appends a kmlNode to the KmlNode list model.

void clear()

Removes all KmlNodes from the list model.

bool contains(KmlNode kmlNode)

Returns true if the list model contains the specified kmlNode.

error forEach(callback)

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

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

element Current KmlNode.
index Current index in array.
array Reference to KmlNodeListModel.

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

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

KmlNode get(int index)

Returns the KmlNode at the specified index.

int indexOf(KmlNode kmlNode)

Returns the index of the kmlNode specified.

void insert(int index, KmlNode kmlNode)

Inserts a kmlNode at a specified index in the list.

void move(int from, int to)

Moves one KmlNode 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.

No KmlNode will be removed if the specified index is out of range.

void removeOne(KmlNode kmlNode)

Removes the specified kmlNode from the list model.

void size()

Returns how many nodes are contained in the list model.