A container class storing a list of scale range display filters. More...
Import Statement: | import Esri.ArcGISRuntime 100.15 |
Since: | Esri::ArcGISRuntime 100.13 |
Properties
Signals
- countChanged()
- errorChanged()
- itemAdded(int index)
- itemRemoved(int index)
Methods
- void append(ScaleRangeDisplayFilter scaleRangeDisplayFilter)
- void clear()
- bool contains(ScaleRangeDisplayFilter scaleRangeDisplayFilter)
- void forEach(void callback)
- QmlScaleRangeDisplayFilter get(int index)
- int indexOf(ScaleRangeDisplayFilter scaleRangeDisplayFilter)
- void insert(int index, ScaleRangeDisplayFilter scaleRangeDisplayFilter)
- void move(int from, int to)
- void remove(int index, int count)
- void removeOne(ScaleRangeDisplayFilter scaleRangeDisplayFilter)
Detailed Description
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 |
---|---|---|
name | QString | The name of the scale range display filter. |
whereClause | QString | SQL expression that defines which features are rendered. |
filterId | QString | The identifier for the scale range display filter (read only). |
minScale | double | The minimum scale at which this scale range display filter is applied. |
maxScale | double | The maximum scale at which this scale range display filter is applied. |
See also ScaleRangeDisplayFilter.
Property Documentation
error : Error |
Returns the error object in case an error occurs (read-only).
Signal Documentation
Emitted when the count property of the model changes.
Note: The corresponding handler is onCountChanged
.
Emitted when the error property changes, which can indicate that an error occurred.
Note: The corresponding handler is onErrorChanged
.
Signal emitted when an item is added to the list.
index is the index of the added item.
Note: The corresponding handler is onItemAdded
.
This signal was introduced in Esri.ArcGISRuntime 100.15.
Signal emitted when an item is removed from the list.
index is the index of the removed item
Note: The corresponding handler is onItemRemoved
.
This signal was introduced in Esri.ArcGISRuntime 100.15.
Method Documentation
void append(ScaleRangeDisplayFilter scaleRangeDisplayFilter) |
Appends the scaleRangeDisplayFilter to the scale range display filter list model.
bool contains(ScaleRangeDisplayFilter scaleRangeDisplayFilter) |
Returns true
if the list model contains the specified scaleRangeDisplayFilter.
Receives a callback function to execute for each scale range display filter in the model.
The callback function can take from 0 to 3 optional arguments, in order:
- element Current display filter.
- index Current index in array.
- array Reference to the ScaleRangeDisplayFilterListModel.
Returns undefined if no error occurred, and an error message otherwise.
const error = scaleRangeDisplayFilterListModel.forEach(function(element, index, array) { ... }); if (error) { console.error(error.message); }
Returns the scale range display filter at the specified index.
int indexOf(ScaleRangeDisplayFilter scaleRangeDisplayFilter) |
Returns the index of the scaleRangeDisplayFilter specified.
void insert(int index, ScaleRangeDisplayFilter scaleRangeDisplayFilter) |
Inserts a scaleRangeDisplayFilter at a specified index in the list model.
Moves one scale range display filter 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
.
void removeOne(ScaleRangeDisplayFilter scaleRangeDisplayFilter) |
Removes the specified scaleRangeDisplayFilter from the list model.