A list model storing pop-up fields. More...
| Import Statement: | import Esri.ArcGISRuntime 100.15 |
| Since: | Esri.ArcGISRuntime 100.14 |
Properties
Signals
- countChanged()
- errorChanged()
- itemAdded(int index)
- itemRemoved(int index)
Methods
- void append(PopupField popupField)
- void clear()
- bool contains(PopupField popupField)
- error forEach(callback)
- PopupField get(int index)
- int indexOf(PopupField popupField)
- void insert(int index, PopupField popupField)
- void move(int from, int to)
- void remove(int index, int count)
- void removeOne(PopupField popupField)
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 | string | The pop-up field's name. |
| format | PopupFieldFormat | Format options for the pop-up field. |
| editable | bool | Whether the pop-up field is editable. |
| visible | bool | Whether the pop-up field is visible. |
| label | string | The pop-up field's label. |
| stringFieldOption | Enums.PopupStringFieldOption | The pop-up field's string field options. |
| tooltip | string | The pop-up field's tooltip. |
Property Documentation
error : Error |
Returns the Error object (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.
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 object 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(PopupField popupField) |
Appends a popupField to the list model.
bool contains(PopupField popupField) |
Returns true if the list model contains the specified popupField.
Receives a callback function to execute for each pop-up field in the model.
The callback function can take 0 to 3 optional arguments, in order:
- element Current PopupField.
- index Current index in array.
- array Reference to PopupFieldListModel.
Returns undefined if no error occurred, and an error message otherwise.
const error = popupFieldListModel.forEach(function(element, index, array) { ... }); if (error) { console.error(error.message); }
PopupField get(int index) |
Returns the PopupField at the specified index.
int indexOf(PopupField popupField) |
Returns the index of a specific popupField from the list model.
void insert(int index, PopupField popupField) |
Inserts a popupField at a specified index in the list.
Moves one PopupField 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(PopupField popupField) |
Removes the specified popupField from the list model.