Namespace: qlik.app.bookmark
The Bookmark API contains methods to work with bookmarks on the Qlik Sense app you are connected to. It can be called only once an app has been opened using the Root API. Using the Bookmark API, you can do the following:
- Create and remove bookmarks
- Modify bookmarks
- Apply bookmarks
A bookmark, when created, has the following attributes that can be set:
Name |
Type |
Description |
title |
String |
Bookmark title. |
description |
String |
Bookmark description. |
sheetId |
String |
Optional. Bookmark sheet ID. |
Here is an example of creating a bookmark. This example retrieves a specific app and then, using the Bookmark API, creates a new bookmark with the name Test, the description Test bookmark for Mastering Qlik Sense, and the unique ID fmcJkH:
var app = qlik.openApp('c31e2aba-3b46-4b13-8b87-c5c2514dea1d');
app.bookmark.create('Test','Test bookmark for Mastering Qlik Sense','fmcJkH');
Unfortunately, as you can see, there is no way to specify whether a bookmark and its selections can be shared by multiple users in the same way as QlikView. Also, you can't specify the alternate state ID of the bookmark.