Skip To Content ArcGIS for Developers Sign In Dashboard

AnalysisListModel QML Type

A list model storing a list of analyses available in a AnalysisOverlay. More...

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

Properties

Signals

Methods

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 analyses available in the AnalysisOverlay.

The model returns data for the following roles:

RoleTypeDescription
analysisVisibleboolThe analysis' visibility.
analysisTypeEnums.AnalysisTypeThe analysis type.

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

analysisAdded(index)

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

Note: The corresponding handler is onAnalysisAdded.


analysisRemoved(index)

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

Note: The corresponding handler is onAnalysisRemoved.


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.


Method Documentation

void append(analysis)

Appends an analysis to the analysis list model.


void clear()

Removes all analyses from the list model.


bool contains(analysis)

Returns true if the list model contains the specified analysis.


void forEach(callback)

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

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

  • element Current analysis.
  • index Current index in array.
  • array Reference to AnalysisListModel.

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

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

Analysis get(index)

Returns the Analysis at the specified index.


int indexOf(analysis)

Returns the index of the analysis specified.


void insert(index, Analysis analysis)

Inserts an analysis at a specified index in the list.


void move(from, int to)

Moves one analysis from an index in the list model to a different index.


void remove(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 will be removed if the specified index is out of range.


void removeOne(analysis)

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

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


void setProperty(index, string property, variant value)

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



Feedback on this topic?