AnalysisListModel QML Type
A list model storing a list of analyses available in a AnalysisOverlay. More...
| Import Statement: | import Esri.ArcGISRuntime |
| Since: | Esri.ArcGISRuntime 100.2 |
Properties
Signals
- countChanged()
- errorChanged()
- itemAdded(int index)
- itemRemoved(int index)
Methods
- void append(Analysis analysis)
- void clear()
- bool contains(Analysis analysis)
- error forEach(callback)
- Analysis get(int index)
- int indexOf(Analysis analysis)
- void insert(int index, Analysis analysis)
- void move(int from, int to)
- void remove(int index, int count)
- void removeOne(Analysis analysis)
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 analyses available in the AnalysisOverlay.
The model returns data for the following roles:
| Role | Type | Description |
|---|---|---|
| analysisVisible | bool | The analysis' visibility. |
| analysisType | Enums.AnalysisType | The analysis type. |
Property Documentation
count : int |
Returns the number of objects in the model (read-only).
error : Error |
Returns the error object in case an error occurs (read-only).
Signal Documentation
countChanged() |
Emitted when the count property of the model changes.
Note: The corresponding handler is onCountChanged.
errorChanged() |
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(Analysis analysis) |
Appends an analysis to the analysis list model.
void clear() |
Removes all analyses from the list model.
bool contains(Analysis analysis) |
Returns true if the list model contains the specified analysis.
error forEach(callback) |
Receives a callback function to execute for each analysis in the model.
The callback function can take 0 to 3 optional arguments, in order:
- element Current analysis.
- index Current index in array.
- array Reference to AnalysisListModel.
Returns undefined if no error occurred, and an error message otherwise.
const error = analysisListModel.forEach(function(element, index, array) { ... }); if (error) { console.error(error.message); }
Analysis get(int index) |
Returns the Analysis at the specified index.
int indexOf(Analysis analysis) |
Returns the index of the analysis specified.
void insert(int index, Analysis analysis) |
Inserts an analysis at a specified index in the list.
void move(int from, int to) |
Moves one analysis from an index in the list model to a different index.
void remove(int index, int count = 1) |
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 will be removed if the specified index is out of range.
|
Removes the specified analysis (analysis) from the list model.
This method was introduced in Esri::ArcGISRuntime 100.5..