Skip To Content ArcGIS for Developers Sign In Dashboard

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.9
Since: Esri.ArcGISRuntime 100.1

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

The model returns data for the following roles:

RoleTypeDescription
jsonjsobjectThe 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.


labelDefinitionAdded(index)

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

Note: The corresponding handler is onLabelDefinitionAdded.


labelDefinitionRemoved(index)

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

Note: The corresponding handler is onLabelDefinitionRemoved.


Method Documentation

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

Returns true if the list model contains the specified labelDefinition.


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

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

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

LabelDefinition get(index)

Returns the label definition at the specified index.


int indexOf(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(index, LabelDefinition labelDefinition)

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


void move(from, int to)

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

Removes the specified label definition (labelDefinition) 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 label definition at index in the list model to value.



Feedback on this topic?