Skip To Content ArcGIS for Developers Sign In Dashboard

BookmarkListModel QML Type

A list model storing a list of Bookmarks available in a Map. More...

Import Statement: import Esri.ArcGISRuntime 100.9
Since: Esri.ArcGISRuntime 100.0

Properties

Signals

Methods

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:

RoleTypeDescription
namestringThe name of the bookmark.

Property Documentation

count : int

Returns the number of objects in the model (read-only).


error : Error

Returns the Error object (read-only).


Signal Documentation

bookmarkAdded(index)

Emitted when an object is added to the list model at the index specified in the parameter.

Note: The corresponding handler is onBookmarkAdded.


bookmarkRemoved(index)

Emitted when an object is removed from the list model at the index specified in the parameter.

Note: The corresponding handler is onBookmarkRemoved.


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.


Method Documentation

void append(bookmark)

Appends bookmark to the Bookmark list model.


void clear()

Removes all Bookmarks from the list model.


bool contains(bookmark)

Returns true if the list model contains the specified bookmark.


void forEach(callback)

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.

var error = bookmarkListModel.forEach(function(element, index, array) {
    ...
});
if (error) {
    console.error(error.message);
}

Bookmark get(index)

Returns the Bookmark at the specified index.


int indexOf(bookmark)

Returns the index of the bookmark specified.

This method was introduced in Esri::ArcGISRuntime 100.5..


void insert(index, Bookmark bookmark)

Inserts a bookmark at a specified index in the list.


void move(from, int to)

Moves one Bookmark from an index in the list model to a different index.


void remove(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.

void removeOne(bookmark)

Removes the specified bookmark (bookmark) from the list model.

This method was introduced in Esri::ArcGISRuntime 100.5..


void setProperty(index, string property, variant value)

Changes the property of the Bookmark at index in the list model to value.



Feedback on this topic?