Skip To Content ArcGIS for Developers Sign In Dashboard

DistanceSymbolRangeListModel QML Type

A list model of DistanceSymbolRange objects. More...

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

Properties

Signals

Methods

  • void append(distanceSymbolRange)
  • void clear()
  • bool contains(distanceSymbolRange)
  • void forEach(callback)
  • DistanceSymbolRange get(index)
  • int indexOf(distanceSymbolRange)
  • void insert(index, DistanceSymbolRange distanceSymbolRange)
  • void move(from, int to)
  • void remove(index, int count = 1)
  • void removeOne(distanceSymbolRange)
  • void setProperty(index, string property, variant value)

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:

RoleTypeDescription
maxDistancedoubleThe maximum distance range value.
minDistancedoubleThe minimum distance range value.
symbolSymbolThe 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.


distanceSymbolRangeAdded(index)

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

Note: The corresponding handler is onDistanceSymbolRangeAdded.


distanceSymbolRangeRemoved(index)

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

Note: The corresponding handler is onDistanceSymbolRangeRemoved.


Method Documentation

void append(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)

Returns true if the list model contains the specified distanceSymbolRange.


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

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

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

DistanceSymbolRange get(index)

Returns the distance symbol range at the specified index.


int indexOf(distanceSymbolRange)

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

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


void insert(index, DistanceSymbolRange distanceSymbolRange)

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


void move(from, int to)

Moves a distance symbol range from an index in the list model to a different index.


void remove(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)

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

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


void setProperty(index, string property, variant value)

Changes the property of the distance symbol range at index in the list model to value.



Feedback on this topic?