PopupMediaListModel QML Type

A list model storing pop-up media. More...

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

Properties

count : int
error : Error

Signals

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

Methods

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

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
caption	string	The pop-up media's caption.
title	string	The pop-up media's title.
type	Enums.PopupMediaType	The pop-up media's type.
value	PopupMediaValue	The pop-up media's value.

Property Documentation

count : int

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

error : Error

Returns the Error object (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(PopupMedia popupMedia)

Appends a popupMedia to the list model.

void clear()

Removes all pop-up medias from the list model.

bool contains(PopupMedia popupMedia)

Returns true if the list model contains the specified popupMedia.

error forEach(callback)

Receives a callback function to execute for each pop-up media in the model.

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

element Current PopupMedia.
index Current index in array.
array Reference to PopupMediaListModel.

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

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

PopupMedia get(int index)

Returns the PopupMedia at the specified index.

int indexOf(PopupMedia popupMedia)

Returns the index of a specific popupMedia from the list model.

void insert(int index, PopupMedia popupMedia)

Inserts a popupMedia at a specified index in the list.

void move(int from, int to)

Moves one PopupMedia 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(PopupMedia popupMedia)

Removes the specified popupMedia from the list model.