LabelDefinitionListModel QML Type

A list model storing a list of label definitions applied to a ArcGISMapImageLayer, FeatureLayer or GraphicsOverlay. More...

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

Properties

count : int

Signals

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

Methods

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

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 label definitions applied to the layer.

The model returns data for the following roles:

Role	Type	Description
json	jsobject	The json of the label definition.

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 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(LabelDefinition labelDefinition)

Appends the label definition labelDefinition to the label definition list model.

void clear()

Removes all label definitions from the list model.

bool contains(LabelDefinition labelDefinition)

Returns true if the list model contains the specified labelDefinition.

error forEach(callback)

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

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

element Current label definition.
index Current index in array.
array Reference to LabelDefinitionListModel.

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

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

LabelDefinition get(int index)

Returns the label definition at the specified index.

int indexOf(LabelDefinition labelDefinition)

Returns the index of a specific label definition (labelDefinition) from the list model.

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

void insert(int index, LabelDefinition labelDefinition)

Inserts the label definition labelDefinition at a specified index in the list.

void move(int from, int to)

Moves a label definition 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(LabelDefinition labelDefinition)

Removes the specified label definition (labelDefinition) from the list model.

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