A list model storing a list of symbol layers available in a multi-layer symbol. More...
| Import Statement: | import Esri.ArcGISRuntime 100.15 |
| Since: | Esri.ArcGISRuntime 100.5 |
Properties
Signals
- countChanged()
- errorChanged()
- itemAdded(int index)
- itemRemoved(int index)
Methods
- void append(SymbolLayer symbolLayer)
- void appendAll(list<SymbolLayer> symbolLayers)
- void clear()
- bool contains(SymbolLayer symbolLayer)
- error forEach(callback)
- SymbolLayer get(int index)
- int indexOf(SymbolLayer symbolLayer)
- void insert(int index, SymbolLayer symbolLayer)
- void move(int from, int to)
- void remove(int index, int count)
- void removeOne(SymbolLayer symbolLayer)
Detailed Description
Modifying this model (adding, removing, moving) will update the MultiLayerSymbol.
The model returns data for the following roles:
| Role | Type | Description |
|---|---|---|
| symbolLayerType | Enums.SymbolLayerType | The type of symbol layer. The role is read-only. |
| colorLocked | bool | Whether the symbol layer has been color locked. |
| enabled | bool | Whether the symbol layer is enabled. |
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 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.
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(SymbolLayer symbolLayer) |
Appends a symbolLayer to the symbol layer list model.
void appendAll(list<SymbolLayer> symbolLayers) |
Appends the list symbolLayers to the symbol layer list model.
bool contains(SymbolLayer symbolLayer) |
Returns true if the list model contains the specified symbolLayer.
Receives a callback function to execute for each symbol layer in the model.
The callback function can take 0 to 3 optional arguments, in order:
- element Current symbol layer.
- index Current index in array.
- array Reference to SymbolLayerListModel.
Returns undefined if no error occurred, and an error message otherwise.
const error = SymbolLayerListModel.forEach(function(element, index, array) { ... }); if (error) { console.error(error.message); }
SymbolLayer get(int index) |
Returns the Symbol at the specified index.
int indexOf(SymbolLayer symbolLayer) |
Returns the index of a specific symbol layer (symbolLayer) from the list model.
This method was introduced in Esri::ArcGISRuntime 100.5..
void insert(int index, SymbolLayer symbolLayer) |
Inserts a symbolLayer at a specified index in the list.
Moves one symbol layer 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.
void removeOne(SymbolLayer symbolLayer) |
Removes the specified symbol layer (symbolLayer) from the list model.
This method was introduced in Esri::ArcGISRuntime 100.5..