Введение в Qlik Sense Backend API

Backend API состоит из ряда методов и используется для взаимодействия с ассоциативным механизмом Qlik. Он предоставляет вспомогательные функции для вызовов ассоциативного механизма Qlik и доступ к данным ассоциативного механизма Qlik.

Backend API – это оболочка для выбранных методов Qlik Engine JSON API, но с той разницей, что Backend API знает контекст, то есть текущее соединение WebSocket и приложение Qlik Sense.

Backend API доступен для разработчиков расширений как this.backendApi:

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

Примеры использования

Selections

Следующие методы Backend API доступны, когда вы работаете с выборками в универсальном объекте, стоящем за вашим расширением.

• selectValues
• selectRange
• clearSelections
• hasSelections

Используйте метод selectValues для выбора значений в этом объекте. Вызов вызывает перерисовку объекта.

$element.find('li').on('click', function() {
    if(this.hasAttribute("data-value")) {
        var value = parseInt(this.getAttribute("data-value"), 10), dim = 0;
        self.backendApi.selectValues(dim, [value], true);
    }
});

Метод selectRange выбирает значения в этом объекте, используя диапазоны.

var range = {
    "qMeasureIx": 1,
    "qRange": {
        "qMin": 10,
        "qMax": 100,
        "qMinInclEq": true,
        "qMaxInclEq": true
    }
};
self.backendApi.selectRange( [range], false);

Метод hasSelections можно использовать, чтобы узнать, есть ли неподтвержденные выборы для этого объекта.

this.backendApi.hasSelections();

Если для этого объекта есть неподтвержденные выборки, вы можете использовать метод clearSelections, чтобы очистить их.

this.backendApi.clearSelections();

Search

При работе с поиском в объектах списка вы можете использовать следующие методы Backend API.

• search
• acceptSearch
• abortSearch

Используйте метод search для поиска термина в list object. Это приводит к обновленному layout, который содержит только совпадающие записи.

this.backendApi.search("A");

Метод acceptSearch принимает результат поиска и делает его выбранным в поле.

this.backendApi.acceptSearch(false);

Используйте метод abortSearch, если поиск должен быть прерван. Это очищает существующий поиск и возвращает объект в состояние, в котором он находился до поиска.

this.backendApi.abortSearch();