AnalysisOverlayListModel QML Type
A list model storing a list of analysis overlays available in the scene view. More...
| Import Statement: | import Esri.ArcGISRuntime 100.9 |
| Since: | Esri.ArcGISRuntime 100.2 |
Properties
Signals
- analysisOverlayAdded(index)
- analysisOverlayRemoved(index)
- countChanged()
- errorChanged()
Methods
- void append(analysisOverlay)
- void clear()
- bool contains(analysisOverlay)
- void forEach(callback)
- AnalysisOverlay get(index)
- int indexOf(analysisOverlay)
- void insert(index, AnalysisOverlay analysisOverlay)
- void move(from, int to)
- void remove(index, int count = 1)
- void removeOne(analysisOverlay)
- 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, moving) will update the analysis overlays available in the scene view.
The model returns data for the following roles:
| Role | Type | Description |
|---|---|---|
| analysisOverlayVisible | bool | The analysis overlay's visibility. |
Property Documentation
error : Error |
Returns the error object in case an error occurs (read-only).
Signal Documentation
Emitted when an object is added to the list model at the index specified in the parameter.
Note: The corresponding handler is onAnalysisOverlayAdded.
Emitted when an object is removed from the list model at the index specified in the parameter.
Note: The corresponding handler is onAnalysisOverlayRemoved.
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.
Method Documentation
Returns true if the list model contains the specified analysisOverlay.
Receives a callback function to execute for each analysis overlay in the model.
The callback function can take 0 to 3 optional arguments, in order:
- element Current analysis overlay.
- index Current index in array.
- array Reference to AnalysisOverlayListModel.
Returns undefined if no error occurred, and an error message otherwise.
var error = analysisOverlayListModel.forEach(function(element, index, array) {
...
});
if (error) {
console.error(error.message);
}AnalysisOverlay get(index) |
Returns the AnalysisOverlay at the specified index.
void insert(index, AnalysisOverlay analysisOverlay) |
Inserts an analysisOverlay at a specified index in the list.
Moves one analysis overlay 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.
No analysis overlay will be removed if the specified index is out of range.
Removes the specified analysis overlay (analysisOverlay) from the list model.
This method was introduced in Esri::ArcGISRuntime 100.5..
Changes the property of the analysis overlay at index in the list model to value.