DistanceSymbolRangeListModel QML Type

A list model of DistanceSymbolRange objects. 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(DistanceSymbolRange distanceSymbolRange)
void clear()
bool contains(DistanceSymbolRange distanceSymbolRange)
error forEach(callback)
DistanceSymbolRange get(int index)
int indexOf(DistanceSymbolRange distanceSymbolRange)
void insert(int index, DistanceSymbolRange distanceSymbolRange)
void move(int from, int to)
void remove(int index, int count)
void removeOne(DistanceSymbolRange distanceSymbolRange)

Detailed Description

DistanceSymbolRangeListModel is used closely with DistanceCompositeSceneSymbol and DistanceSymbolRange to manage dynamic symbols based on distance from the Camera.

Modifying this model (adding, removing, or moving) will update the distance symbol ranges available in the distance composite scene symbol.

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
maxDistance	double	The maximum distance range value.
minDistance	double	The minimum distance range value.
symbol	Symbol	The symbol for the distance symbol range.

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.

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.

Method Documentation

void append(DistanceSymbolRange distanceSymbolRange)

Appends the distance symbol range distanceSymbolRange to the distance symbol range list model.

void clear()

Removes all distance symbol ranges from the list model.

bool contains(DistanceSymbolRange distanceSymbolRange)

Returns true if the list model contains the specified distanceSymbolRange.

error forEach(callback)

Receives a callback function to execute for each distance symbol range in the model.

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

element Current distance symbol range.
index Current index in array.
array Reference to DistanceSymbolRangeListModel.

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

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

DistanceSymbolRange get(int index)

Returns the distance symbol range at the specified index.

int indexOf(DistanceSymbolRange distanceSymbolRange)

Returns the index of the distance symbol range (distanceSymbolRange) specified.

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

void insert(int index, DistanceSymbolRange distanceSymbolRange)

Inserts the distance symbol range distanceSymbolRange at a specified index in the list.

void move(int from, int to)

Moves a distance symbol range 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(DistanceSymbolRange distanceSymbolRange)

Removes the specified distance symbol range (distanceSymbolRange) from the list model.

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