ClassBreakListModel QML Type

A list model storing a list of class breaks available in a ClassBreaksRenderer. More...

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

Properties

count : int

Signals

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

Methods

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

Detailed Description

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

Modifying this model (adding, removing, or moving) will update the class breaks available in the class breaks renderer.

The model returns data for the following roles:

Role	Type	Description
description	string	The description of the class break.
label	string	The label used to display the class break.
maxValue	double	The maximum value of the class break.
minValue	double	The minimum value of the class break.

Property Documentation

count : int

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

Signal Documentation

countChanged()

Emitted when the count property changes.

Note: The corresponding handler is onCountChanged.

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(ClassBreak classBreak)

Appends the class break classBreak to the class break list model.

void clear()

Removes all class breaks from the list model.

bool contains(ClassBreak classBreak)

Returns true if the list model contains the specified classBreak.

error forEach(callback)

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

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

element Current class break.
index Current index in array.
array Reference to ClassBreakListModel.

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

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

ClassBreak get(int index)

Returns the class break at the specified index.

int indexOf(ClassBreak classBreak)

Returns the index of the classBreak specified.

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

void insert(int index, ClassBreak classBreak)

Inserts the class break classBreak at a specified index in the list.

void move(int from, int to)

Moves a class break 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(ClassBreak classBreak)

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

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