SymbolListModel QML Type
A list model storing a list of symbols. More...
| Import Statement: | import Esri.ArcGISRuntime 100.9 |
| Since: | Esri.ArcGISRuntime 100.0 |
Properties
Signals
- countChanged()
- errorChanged()
- symbolAdded(index)
- symbolRemoved(index)
Methods
- void append(symbol)
- void clear()
- bool contains(symbol)
- void forEach(callback)
- Symbol get(index)
- int indexOf(symbol)
- void insert(index, Symbol symbol)
- void move(from, int to)
- void remove(index, int count = 1)
- void removeOne(symbol)
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 symbols belonging to the model's parent type (i.e. CompositeSymbol).
The model returns data for the following roles:
| Role | Type | Description |
|---|---|---|
| symbolUrl | url | A file URL to the symbol's swatch image. |
Property Documentation
error : Error |
Returns the Error object (read-only).
Signal Documentation
Emitted when the count property of the model changes.
Note: The corresponding handler is onCountChanged.
Emitted when the error property changes, which can indicate that an error occurred.
Note: The corresponding handler is onErrorChanged.
Emitted when an object is added to the list model at the index specified in the parameter.
Note: The corresponding handler is onSymbolAdded.
Emitted when an object is removed from the list model at the index specified in the parameter.
Note: The corresponding handler is onSymbolRemoved.
Method Documentation
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 symbol.
- index Current index in array.
- array Reference to SymbolListModel.
Returns undefined if no error occurred, and an error message otherwise.
var error = symbolListModel.forEach(function(element, index, array) {
...
});
if (error) {
console.error(error.message);
}Symbol get(index) |
Returns the Symbol at the specified index.
Returns the index of a specific symbol (symbol) from the list model.
This method was introduced in Esri::ArcGISRuntime 100.5..
void insert(index, Symbol symbol) |
Inserts a symbol at a specified index in the list.
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 symbol (symbol) from the list model.
This method was introduced in Esri::ArcGISRuntime 100.5..