ImageOverlayListModel QML Type

A list model storing a list of image overlays available in a SceneView. More...

Import Statement:	import Esri.ArcGISRuntime 100.15
Since:	Esri.ArcGISRuntime 100.8

Properties

count : int

Signals

countChanged()
itemAdded(int index)
itemRemoved(int index)

Methods

void append(ImageOverlay imageOverlay)
void clear()
bool contains(ImageOverlay imageOverlay)
error forEach(callback)
ImageOverlay get(int index)
int indexOf(ImageOverlay imageOverlay)
void insert(int index, ImageOverlay imageOverlay)
void move(int from, int to)
void remove(int index, int count)
void removeOne(ImageOverlay imageOverlay)

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

count : int

Returns the number of objects in the model (read-only).

Signal Documentation

countChanged()

Emitted when the count property of the model changes.

Note: The corresponding handler is onCountChanged.

itemAdded(int index)

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.

itemRemoved(int index)

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(ImageOverlay imageOverlay)

Appends an imageOverlay to the ImageOverlay list model.

void clear()

Removes all ImageOverlays from the list model.

bool contains(ImageOverlay imageOverlay)

Returns true if the list model contains the specified imageOverlay.

error forEach(callback)

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.

const error = ImageOverlayListModel.forEach(function(element, index, array) {
    ...
});
if (error) {
    console.error(error.message);
}

ImageOverlay get(int index)

Returns the ImageOverlay at the specified index.

int indexOf(ImageOverlay imageOverlay)

Returns the index of a specific image overlay (imageOverlay) from the list model.

void insert(int index, ImageOverlay imageOverlay)

Inserts an imageOverlay to the ImageOverlay list model at index.

void move(int from, int to)

Moves one ImageOverlay 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.

void removeOne(ImageOverlay imageOverlay)

Removes the specified image overlay (imageOverlay) from the list model.