LabelStackSeparatorListModel QML Type

A list model storing a list of LabelStackSeparators. More...

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

Properties

count : int
error : Error

Signals

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

Methods

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

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
breakPosition	Enums.LabelStackSeparatorBreakPosition	The position where the separator will be written, if used and remaining visible.
forced	bool	Whether a line break must be inserted when the separator is encountered.
separator	string	A QString intended to describe one code point.
visible	bool	Whether the separator should still be visible, if chosen as a line break position.

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(LabelStackSeparator labelStackSeparator)

Appends a labelStackSeparator to the labelStackSeparator list model.

void clear()

Removes all labelStackSeparator from the list model.

bool contains(LabelStackSeparator labelStackSeparator)

Returns true if the list model contains the specified labelStackSeparator.

error forEach(callback)

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

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

element Current labelStackSeparator.
index Current index in array.
array Reference to LabelStackSeparatorListModel.

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

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

LabelStackSeparator get(int index)

Returns the LabelStackSeparator at the specified index.

int indexOf(LabelStackSeparator labelStackSeparator)

Returns the index of a specific labelStackSeparator (labelStackSeparator) from the list model.

void insert(int index, LabelStackSeparator labelStackSeparator)

Inserts a labelStackSeparator at a specified index in the list.

void move(int from, int to)

Moves one labelStackSeparator 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(LabelStackSeparator labelStackSeparator)

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