A list model storing a list of Layers available in a Map. More...
| Import Statement: | import Esri.ArcGISRuntime 100.15 |
| Since: | Esri.ArcGISRuntime 100.0 |
Properties
Signals
- countChanged()
- errorChanged()
- itemAdded(int index)
- itemRemoved(int index)
Methods
- void append(Layer layer)
- void clear()
- bool contains(Layer layer)
- error forEach(callback)
- Layer get(int index)
- int indexOf(Layer layer)
- void insert(int index, Layer layer)
- void move(int from, int to)
- void remove(int index, int count)
- void removeOne(Layer layer)
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 Layers available in the Map.
The model returns data for the following roles:
| Role | Type | Description |
|---|---|---|
| name | string | The layer's name. |
| description | string | The layer's description. |
| layerVisible | bool | Whether the layer is visible. |
| canChangeVisibility | bool | Whether the layer's visibility can be changed. |
| loadError (deprecated) | int | The layer's load error code. |
| loadStatus | Enums.LoadStatus | The layer's load status. |
| layerType | Enums.LayerType | The layer's type. |
| attribution | string | The layer's attribution if any is available. |
| showInLegend | bool | Whether the layer will be shown in the legend. |
| layerId | string | The layer's ID specified in the web map JSON. |
| minScale | double | The minimum scale at which the layer displays. |
| maxScale | double | The maximum scale at which the layer displays. |
| layerOpacity | real | The opacity of the layer between 0.0 and 1.0. |
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(Layer layer) |
Appends a layer to the layer list model.
bool contains(Layer layer) |
Returns true if the list model contains the specified layer.
Receives a callback function to execute for each layer in the model.
The callback function can take 0 to 3 optional arguments, in order:
- element Current layer.
- index Current index in array.
- array Reference to LayerListModel.
Returns undefined if no error occurred, and an error message otherwise.
const error = layerListModel.forEach(function(element, index, array) { ... }); if (error) { console.error(error.message); }
int indexOf(Layer layer) |
Returns the index of a specific layer (layer) from the list model.
This method was introduced in Esri::ArcGISRuntime 100.5..
void insert(int index, Layer layer) |
Inserts a layer 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.
void removeOne(Layer layer) |
Removes the specified layer (layer) from the list model.
This method was introduced in Esri::ArcGISRuntime 100.5..