DistanceSymbolRangeListModel QML Type
A list model of DistanceSymbolRange objects. More...
| Import Statement: | import Esri.ArcGISRuntime 100.9 |
| Since: | Esri.ArcGISRuntime 100.0 |
Properties
- count : int
Signals
- countChanged()
- distanceSymbolRangeAdded(index)
- distanceSymbolRangeRemoved(index)
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:
| 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
Signal Documentation
Emitted when the count property changes.
Note: The corresponding handler is onCountChanged.
Emitted when an object is added to the list model at the index specified in the parameter.
Note: The corresponding handler is onDistanceSymbolRangeAdded.
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
Appends the distance symbol range distanceSymbolRange to the distance symbol range list model.
Returns true if the list model contains the specified distanceSymbolRange.
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.
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.
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.
Moves a distance symbol range from an index in the list model to a different index.
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.
Removes the specified distance symbol range (distanceSymbolRange) from the list model.
This method was introduced in Esri::ArcGISRuntime 100.5..
Changes the property of the distance symbol range at index in the list model to value.