DisplayFilterListModel QML Type

A container class storing a list of display filters. More...

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

Properties

count : int
error : Error

Signals

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

Methods

void append(DisplayFilter displayFilter)
void clear()
bool contains(DisplayFilter displayFilter)
void forEach(void callback)
QmlDisplayFilter get(int index)
int indexOf(DisplayFilter displayFilter)
void insert(int index, DisplayFilter displayFilter)
void move(int from, int to)
void remove(int index, int count)
void removeOne(DisplayFilter displayFilter)

Detailed Description

Note: You cannot declare or create a component of this type in QML code.

The model returns data for the following roles:

Role	Type	Description
name	QString	The name of the display filter.
whereClause	QString	SQL expression that defines which features are rendered.
filterId	QString	The identifier for the display filter (read only).

See also DisplayFilter.

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)

Signal emitted when an item is added to the list.

index is the index of the added item.

Note: The corresponding handler is onItemAdded.

This signal was introduced in Esri.ArcGISRuntime 100.15.

itemRemoved(int index)

Signal emitted when an item is removed from the list.

index is the index of the removed item.

Note: The corresponding handler is onItemRemoved.

This signal was introduced in Esri.ArcGISRuntime 100.15.

Method Documentation

void append(DisplayFilter displayFilter)

Appends the displayFilter to the display filter list model.

void clear()

Removes all display filters from the list model.

bool contains(DisplayFilter displayFilter)

Returns true if the list model contains the specified displayFilter.

void forEach(void callback)

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

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

element Current display filter.
index Current index in array.
array Reference to the DisplayFilterListModel.

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

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

QmlDisplayFilter get(int index)

Returns the display filter at the specified index.

int indexOf(DisplayFilter displayFilter)

Returns the index of the displayFilter specified.

void insert(int index, DisplayFilter displayFilter)

Inserts a displayFilter at a specified index in the list model.

void move(int from, int to)

Moves one display filter 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(DisplayFilter displayFilter)

Removes the specified displayFilter from the list model.