ElevationSourceListModel QML Type
A list model storing a list of elevation sources available in a Scene. More...
| Import Statement: | import Esri.ArcGISRuntime 100.14 |
| Since: | Esri.ArcGISRuntime 100.0 |
Properties
Signals
- countChanged()
- elevationSourceAdded(int index)
- elevationSourceRemoved(int index)
- errorChanged()
Methods
- void append(ElevationSource elevationSource)
- void clear()
- bool contains(ElevationSource elevationSource)
- error forEach(callback)
- ElevationSource get(int index)
- int indexOf(ElevationSource elevationSource)
- void insert(int index, ElevationSource elevationSource)
- void move(int from, int to)
- void remove(int index, int count)
- void removeOne(ElevationSource elevationSource)
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 elevation sources available in the Scene.
The model returns data for the following roles:
| Role | Type | Description |
|---|---|---|
| name | string | The elevation source's name. |
| elevationSourceEnabled | bool | If the elevation source is enabled. |
| elevationSourceType | Enums.ElevationSourceType | The type of elevation source. |
Property Documentation
error : Error |
Returns the error object in case an error occurs (read-only).
Signal Documentation
Emitted when the count property of the model changes.
Note: The corresponding handler is onCountChanged.
Emitted when an object is added to the list model at the index specified in the parameter.
Note: The corresponding handler is onElevationSourceAdded.
Emitted when an object is removed from the list model at the index specified in the parameter.
Note: The corresponding handler is onElevationSourceRemoved.
Emitted when the error property changes, which can indicate that an error occurred.
Note: The corresponding handler is onErrorChanged.
Method Documentation
void append(ElevationSource elevationSource) |
Appends an elevationSource to the elevation source list model.
bool contains(ElevationSource elevationSource) |
Returns true if the list model contains the specified elevationSource.
Receives a callback function to execute for each elevation source in the model.
The callback function can take 0 to 3 optional arguments, in order:
- element Current elevation source.
- index Current index in array.
- array Reference to ElevationSourceListModel.
Returns undefined if no error occurred, and an error message otherwise.
const error = elevationSourceListModel.forEach(function(element, index, array) { ... }); if (error) { console.error(error.message); }
ElevationSource get(int index) |
Returns the ElevationSource at the specified index.
int indexOf(ElevationSource elevationSource) |
Returns the index of the elevation source (elevationSource) specified.
This method was introduced in Esri::ArcGISRuntime 100.5..
void insert(int index, ElevationSource elevationSource) |
Inserts an elevationSource at a specified index in the list.
Moves one elevation source 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(ElevationSource elevationSource) |
Removes the specified elevation source (elevationSource) from the list model.
This method was introduced in Esri::ArcGISRuntime 100.5..