ImageOverlayListModel QML Type
A list model storing a list of image overlays available in a SceneView. More...
| Import Statement: | import Esri.ArcGISRuntime 100.9 |
| Since: | Esri.ArcGISRuntime 100.8 |
Properties
- count : int
Signals
- countChanged()
- imageOverlayAdded(index)
- imageOverlayRemoved(index)
Methods
- void append(imageOverlay)
- void clear()
- bool contains(imageOverlay)
- void forEach(callback)
- ImageOverlay get(index)
- int indexOf(imageOverlay)
- void insert(index, ImageOverlay imageOverlay)
- void move(from, int to)
- void remove(index, int count = 1)
- void removeOne(imageOverlay)
- 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 image overlays available in the GeoView.
The model returns data for the following roles:
| Role | Type | Description |
|---|---|---|
| opacity | double | The opacity of the image overlay. |
| visibility | bool | Whether the image overlay is visible. |
Property Documentation
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 onImageOverlayAdded.
Emitted when an object is removed from the list model at the index specified in the parameter.
Note: The corresponding handler is onImageOverlayRemoved.
Method Documentation
Appends an imageOverlay to the ImageOverlay list model.
Receives a callback function to execute for each image overlay in the model.
The callback function can take 0 to 3 optional arguments, in order:
- element Current image overlay.
- index Current index in array.
- array Reference to ImageOverlayListModel.
Returns undefined if no error occurred, and an error message otherwise.
var error = ImageOverlayListModel.forEach(function(element, index, array) {
...
});
if (error) {
console.error(error.message);
}ImageOverlay get(index) |
Returns the ImageOverlay at the specified index.
Returns the index of a specific image overlay (imageOverlay) from the list model.
void insert(index, ImageOverlay imageOverlay) |
Inserts an imageOverlay to the ImageOverlay list model at index.
Moves one ImageOverlay 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.
Removes the specified image overlay (imageOverlay) from the list model.
Changes the property of the ImageOverlay at index in the list model to value.