GeometricEffectListModel QML Type
A list model storing a list of geometric effects. More...
| Import Statement: | import Esri.ArcGISRuntime |
| Since: | Esri.ArcGISRuntime 100.5 |
Properties
Signals
- countChanged()
- errorChanged()
- itemAdded(int index)
- itemRemoved(int index)
Methods
- void append(GeometricEffect geometricEffect)
- void clear()
- bool contains(GeometricEffect geometricEffect)
- error forEach(callback)
- GeometricEffect get(int index)
- int indexOf(GeometricEffect geometricEffect)
- void insert(int index, GeometricEffect geometricEffect)
- void move(int from, int to)
- void remove(int index, int count)
- void removeOne(GeometricEffect geometricEffect)
Detailed Description
Modifying this model (adding, removing, moving) will update the SolidStrokeSymbolLayer.
The model returns data for the following roles:
| Role | Type | Description |
|---|---|---|
| geometricEffectType | Enums.GeometricEffectType | The Enums.GeometricEffectType enum. |
Property Documentation
count : int |
Returns the number of objects in the model (read-only).
error : Error |
Returns the Error object (read-only).
Signal Documentation
countChanged() |
Emitted when the count property of the model changes.
Note: The corresponding handler is onCountChanged.
errorChanged() |
Emitted when the error property changes, which can indicate that an error occurred.
Note: The corresponding handler is onErrorChanged.
|
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.
|
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(GeometricEffect geometricEffect) |
Appends a geometricEffect to the geometric effects list model.
void clear() |
Removes all geometric effects from the list model.
bool contains(GeometricEffect geometricEffect) |
Returns true if the list model contains the specified geometricEffect.
error forEach(callback) |
Receives a callback function to execute for each symbol in the model.
The callback function can take 0 to 3 optional arguments, in order:
- element Current symbol.
- index Current index in array.
- array Reference to GeometricEffectListModel.
Returns undefined if no error occurred, and an error message otherwise.
const error = GeometricEffectListModel.forEach(function(element, index, array) { ... }); if (error) { console.error(error.message); }
GeometricEffect get(int index) |
Returns the GeometricEffect at the specified index.
|
Returns the index of the geometric effect (geometricEffect) specified.
This method was introduced in Esri::ArcGISRuntime 100.5..
void insert(int index, GeometricEffect geometricEffect) |
Inserts a geometricEffect at a specified index in the list.
void move(int from, int to) |
Moves one symbol 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.
|
Removes the specified geometric effect (geometricEffect) from the list model.
This method was introduced in Esri::ArcGISRuntime 100.5..