A list model storing a list of Bookmarks available in a Map. More...
| Import Statement: | import Esri.ArcGISRuntime 100.15 |
| Since: | Esri.ArcGISRuntime 100.0 |
Properties
Signals
- countChanged()
- errorChanged()
- itemAdded(int index)
- itemRemoved(int index)
Methods
- void append(Bookmark bookmark)
- void clear()
- bool contains(Bookmark bookmark)
- error forEach(callback)
- Bookmark get(int index)
- int indexOf(Bookmark bookmark)
- void insert(int index, Bookmark bookmark)
- void move(int from, int to)
- void remove(int index, int count)
- void removeOne(Bookmark bookmark)
Detailed Description
Note: You cannot declare or create a component of this type in QML code.
Modifying this model (adding, removing, moving) will update the Bookmarks available in the Map.
The model returns data for the following roles:
| Role | Type | Description |
|---|---|---|
| name | string | The name of the bookmark. |
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 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
bool contains(Bookmark bookmark) |
Returns true if the list model contains the specified bookmark.
Receives a callback function to execute for each bookmark in the model.
The callback function can take 0 to 3 optional arguments, in order:
- element Current bookmark.
- index Current index in array.
- array Reference to BookmarkListModel.
Returns undefined if no error occurred, and an error message otherwise.
const error = bookmarkListModel.forEach(function(element, index, array) { ... }); if (error) { console.error(error.message); }
Bookmark get(int index) |
Returns the Bookmark at the specified index.
int indexOf(Bookmark bookmark) |
Returns the index of the bookmark specified.
This method was introduced in Esri::ArcGISRuntime 100.5..
void insert(int index, Bookmark bookmark) |
Inserts a bookmark at a specified index in the list.
Moves one Bookmark 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(Bookmark bookmark) |
Removes the specified bookmark (bookmark) from the list model.
This method was introduced in Esri::ArcGISRuntime 100.5..