Skip To Content ArcGIS for Developers Sign In Dashboard

ClassBreakListModel QML Type

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

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

Properties

Signals

Methods

  • void append(ClassBreak classBreak)
  • void clear()
  • bool contains(ClassBreak classBreak)
  • void 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)
  • void setProperty(int index, string property, variant value)

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:

RoleTypeDescription
descriptionstringThe description of the class break.
labelstringThe label used to display the class break.
maxValuedoubleThe maximum value of the class break.
minValuedoubleThe minimum value of the class break.

Property Documentation

count : int

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


Signal Documentation

classBreakAdded(int index)

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


classBreakRemoved(int index)

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


countChanged()

Emitted when the count property changes.


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.


void 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.

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

ClassBreak get(int index) const

Returns the class break at the specified index.


int indexOf(ClassBreak classBreak)

Returns the index of the classBreak specified.

This QML 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 QML method was introduced in Esri::ArcGISRuntime 100.5..


void setProperty(int index, string property, variant value)

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



Feedback on this topic?