Skip to main content Skip to complementary content

Qlik Sense Backend API reference

The Qlik SenseBackend API consists of a number of methods, and is used for communicating with the Qlik Sense Engine. It provides Helper functions for Engine calls and access to Engine data. Available for extensions as this.backendApi.

List of methods

Method Description
abortSearch Method used to abort a search in a list object.
acceptSearch Method used to accept a search in a list object.
applyPatches Method used to update properties for this object.
clearSelections Method used to clear unconfirmed selections for this object.
clearSoftPatches Method used to clear soft patches for this object
eachDataRow Method used to loop through data rows for this object.
getData Method used to get data from the Engine for this object.
getDataRow Method used to get a data row for this object.
getDimensionInfos Method used to get DimensionInfo for this object.
getMeasureInfos Method used to get MeasureInfo for this object.
getProperties Method used to get properties for this object.
getReducedData Method used to get reduced data from the Engine for this object.
getRowCount Method used to get total number of data rows for this object.
hasSelections Method used to know if there are unconfirmed selections for this object.
save Method used to save this object.
search Method used to search for a term in a list object.
selectRange Method used to select values in this object using ranges.
selectValues Method used to Select values in this object.
setProperties Method used to set properties for this object.

Example

this.backendApi.eachDataRow(function(rownum, row) { ..... });

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!