A list model storing a list of KmlGeometry elements. More...
| Import Statement: | import Esri.ArcGISRuntime |
| Since: | Esri.ArcGISRuntime 100.6 |
- List of all members, including inherited members
- KmlGeometryListModel is part of QML Type List.
Properties
Signals
- countChanged()
- errorChanged()
- itemAdded(int index)
- itemRemoved(int index)
Methods
- void append(KmlGeometry geometry)
- void clear()
- bool contains(KmlGeometry geometry)
- error forEach(callback)
- KmlGeometry get(int index)
- int indexOf(KmlGeometry geometry)
- void insert(int index, KmlGeometry geometry)
- void move(int from, int to)
- void remove(int index, int count)
- void removeOne(KmlGeometry geometry)
Detailed Description
Note: You cannot declare or create a component of this type in QML code.
The model returns data for the following roles:
| Role | Type | Description |
|---|---|---|
| geometry | Geometry | The KmlGeometry's geometry. |
| tessellated | bool | The KmlGeometry's tessellated flag. |
| extruded | bool | The KmlGeometry's extruded flag. |
| altitudeMode | Enums.KmlAltitudeMode | The KmlGeometry's altitude mode. |
| kmlGeometryType | Enums.KmlGeometryType | The KmlGeometry's geomtry type. |
Property Documentation
[read-only] count : int |
Returns the number of objects in the model (read-only).
[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(KmlGeometry geometry) |
Appends a KmlGeometry geometry to the list model.
void clear() |
Removes all KmlGeometry elements from the list model.
bool contains(KmlGeometry geometry) |
Returns true if the list model contains the specified geometry.
error forEach(callback) |
Receives a callback function to execute for each geometry in the model.
The callback function can take from 0 to 3 optional arguments, in order:
- element Current geometry.
- index Current index in array.
- array Reference to KmlGeometryListModel.
Returns undefined if no error occurred, and an error message otherwise.
const error = geometryListModel.forEach(function(element, index, array) { ... }); if (error) { console.error(error.message); }
KmlGeometry get(int index) |
Returns the KmlGeometry at the specified index.
int indexOf(KmlGeometry geometry) |
Returns the index of the geometry specified.
void insert(int index, KmlGeometry geometry) |
Inserts a KmlGeometry geometry at a specified index in the list.
void move(int from, int to) |
Moves one KmlGeometry element 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 geometry will be removed if the specified index is out of range.
void removeOne(KmlGeometry geometry) |
Removes the specified KmlGeometry geometry from the list model.