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
- count : int
Signals
- countChanged()
- labelDefinitionAdded(index)
- labelDefinitionRemoved(index)
Methods
- void append(labelDefinition)
- void clear()
- bool contains(labelDefinition)
- void forEach(callback)
- LabelDefinition get(index)
- int indexOf(labelDefinition)
- void insert(index, LabelDefinition labelDefinition)
- void move(from, int to)
- void remove(index, int count = 1)
- void removeOne(labelDefinition)
- void setProperty(index, string property, variant value)
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
Signal Documentation
Emitted when the count property changes.
Note: The corresponding handler is onCountChanged.
Emitted when an object is added to the list model at the index specified in the parameter.
Note: The corresponding handler is onLabelDefinitionAdded.
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
Appends the label definition labelDefinition to the label definition list model.
Returns true if the list model contains the specified labelDefinition.
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.
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.
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.
Moves a label definition from an index in the list model to a different index.
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.
Removes the specified label definition (labelDefinition) from the list model.
This method was introduced in Esri::ArcGISRuntime 100.5..
Changes the property of the label definition at index in the list model to value.