Skip To Content ArcGIS for Developers Sign In Dashboard

AnalysisOverlayListModel QML Type

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

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

Properties

Signals

Methods

  • void append(AnalysisOverlay analysisOverlay)
  • void clear()
  • bool contains(AnalysisOverlay analysisOverlay)
  • void 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)
  • void setProperty(int 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 analysis overlays available in the scene view.

The model returns data for the following roles:

RoleTypeDescription
analysisOverlayVisibleboolThe 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

analysisOverlayAdded(int index)

Emitted when an object is added to the list model at the index specified in the parameter.


analysisOverlayRemoved(int index)

Emitted when an object is removed from the list model at the index specified in the parameter.


countChanged()

Emitted when the count property of the model changes.


errorChanged()

Emitted when the error property changes, which can indicate that an error occurred.


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.


void 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:

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

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

AnalysisOverlay get(int index) const

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 QML method was introduced in Esri::ArcGISRuntime 100.5..


void setProperty(int index, string property, variant value)

Changes the property of the analysis overlay at index in the list model to value.



Feedback on this topic?