Class Qww.BookMark.Mgr
JavaScript class to provide access to QVS bookmark functionality.
Defined in: <JavaScript\QWW\QwwJs_BookMarkMgr.js>.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
JavaScript class to provide access to QVS bookmark functionality.
|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
Qww.BookMark.Mgr.ApplyBookmark(applicationId, bookMarkId)
Applies a previously created bookmark.
|
| <static> |
Qww.BookMark.Mgr.CreateBookMark(applicationId, name, onCreated)
Creates a shared bookmark based on the current selections.
|
Method Detail
<static>
Qww.BookMark.Mgr.ApplyBookmark(applicationId, bookMarkId)
Applies a previously created bookmark.
- Parameters:
- {String} applicationId
- Id/Name of the QlikView application (note this is only necessary when multiple QlikView documents are being used on the same web page and should otherwise be set to null).
- {String} bookMarkId
- Id of the bookmark as passed by the onCreated callback passed to the CreateBookMark method.
<static>
Qww.BookMark.Mgr.CreateBookMark(applicationId, name, onCreated)
Creates a shared bookmark based on the current selections.
Qww.BookMark.Mgr.CreateBookMark(null, "MyBookMark", function(bookmarkid) {
alert("Bookmark created, id = " + bookmarkid);
// This book mark can be applied be appending it to the pages url, e.g.
// http://server/page.aspx?bookmark=" + bookmarkid;
});
- Parameters:
- {String} applicationId
- Id/Name of the QlikView application (note this is only necessary when multiple QlikView documents are being used on the same web page and should otherwise be set to null).
- {String} name
- Name for the bookmark (note this is not currently useful - the id needed is to reapply the bookmark is passed via the onCreated callback).
- {Function} onCreated
- Callback function to run when the bookmark has been created. The function should accept one parameter which is the id of the bookmark created.
