AnalysisOverlayListModel QML Type

A list model storing a list of analysis overlays available in the scene view. More...

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

Properties

count : int
error : Error

Signals

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

Methods

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

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 analysis overlays available in the scene view.

The model returns data for the following roles:

Role	Type	Description
analysisOverlayVisible	bool	The analysis overlay's visibility.

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.

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(AnalysisOverlay analysisOverlay)

Appends an analysisOverlay to the analysis overlay list model.

void clear()

Removes all analysis overlays from the list model.

bool contains(AnalysisOverlay analysisOverlay)

Returns true if the list model contains the specified analysisOverlay.

error forEach(callback)

Receives a callback function to execute for each analysis overlay in the model.

The callback function can take 0 to 3 optional arguments, in order:

element Current analysis overlay.
index Current index in array.
array Reference to AnalysisOverlayListModel.

Returns undefined if no error occurred, and an error message otherwise.

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

AnalysisOverlay get(int index)

Returns the AnalysisOverlay at the specified index.

int indexOf(AnalysisOverlay analysisOverlay)

Returns the index of the analysisOverlay specified.

void insert(int index, AnalysisOverlay analysisOverlay)

Inserts an analysisOverlay at a specified index in the list.

void move(int from, int to)

Moves one analysis overlay 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 overlay will be removed if the specified index is out of range.

void removeOne(AnalysisOverlay analysisOverlay)

Removes the specified analysis overlay (analysisOverlay) from the list model.

This method was introduced in Esri::ArcGISRuntime 100.5..