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.6
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(int index)

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


bookmarkRemoved(int index)

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


countChanged()

Emitted when the count property of the model changes.


errorChanged()

Emitted when the error property changes, which can indicate that an error occurred.


Method Documentation

void append(Bookmark bookmark)

Appends a Bookmark to the Bookmark list model.


void clear()

Removes all Bookmarks from the list model.


bool contains(Bookmark 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(int index) const

Returns the Bookmark at the specified index.


int indexOf(Bookmark bookmark)

Returns the index of the bookmark specified.

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


void insert(int index, Bookmark bookmark)

Inserts a Bookmark at a specified index in the list.


void move(int from, int to)

Moves one Bookmark 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.

void removeOne(Bookmark bookmark)

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

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


void setProperty(int index, string property, variant value)

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



Feedback on this topic?