Общие функции
- Установка фильтров
/**
* @param widgetGuid - guid виджета, на котором хотим установить фильтр
*/
visApi().setFilterSelectedValues(widgetGuid, [["Москва"], ["Казань"]], function (response) {});
Для сброса фильтра нужно отправить пустой массив:
visApi().setFilterSelectedValues(widgetGuid, [], function (response) {});
2. Установка исключающих фильтров
/**
* @param widgetGuid - guid виджета, на котором хотим установить фильтр
*/
visApi().setExcludeFilterSelectedValues(widgetGuid, [["Москва"], ["Казань"]], function (response) {});
3. Получение данных у виджета
/**
* @param widgetGuid - guid виджета, данные которого хотим получить
*/
visApi().getWidgetDataByGuid(widgeGuid).then(function (widgetData) {});
4. Подписка на изменение выбранных элементов у виджета
/**
* @param widgetGuid - guid виджета, на который хотим подписаться. Если не указан, то будет подписка на все фильтры
* @param guid - guid подписываемого события. Используется, чтобы в памяти не накапливались подписки
*/
visApi().onSelectedValuesChangedListener({guid: "123", widgetGuid: "123" }, function (info) {})
5. Экспорт дашборда
/**
* @param format - формат экспортируемого файла (png, pdf, xlsx, pptx);
*/
visApi().exportDashboard(format);
6. Экспорт видимых данных виджета в Excel
/**
* @param widgetGuid - guid виджета, данные которого хотим экспортировать в Excel
*/
visApi().exportExcelWidgetData(widgetGuid);
7. Экспорт всех данных виджета в Excel
/**
* @param widgetGuid - guid виджета, данные которого хотим экспортировать в Excel
*/
visApi().exportAllWidgetData(widgetGuid);
8. Получить состояние всех виджетов на листе
visApi().getWidgets();
9. Получить состояние выделенных виджетов на листе
visApi().getSelectedWidgets();
10. Получить состояние конкретного виджета на листе по ID
/**
* @param widgetGuid - guid виджета, данные которого хотим получить
*/
visApi().getWidgetByGuid(widgetGuid);
11. Получить выделенные (выбранные) значения (selectedValues)
/**
* @param widgetGuid - guid виджета, выбранные значения которого хотим получить
*/
visApi().getSelectedValues(widgetGuid);
12. Получить значение зума листа дашборда
visApi().getSheetZoom() - вернет величину зума.
13. Установка фильтра по датам
/**
* @param widgetGuid - guid виджета, на котором хотим установить фильтр
*/
"date" - дата в формате YYYY.MM.DD
visApi().setDateFilterSelectedValues(widgetGuid, [new Date()]); - установка текущей даты
visApi().setDateFilterSelectedValues(widgetGuid, [new Date("date")]); - единичный выбор
visApi().setDateFilterSelectedValues(widgetGuid, [new Date("date"), new Date("date")]); - множественный выбор
visApi().setDateFilterSelectedValues(widgetGuid, []); - для сброса значений
Например, установка 1 июня 2020 года
visApi().setDateFilterSelectedValues(widgetGuid, [new Date("2020-06-01")]);
14. Подписка на то, что виджет загрузился
/**
* @param widgetGuid - guid виджета, на который хотим подписаться
* @param guid - guid подписываемого события. Используется, чтобы в памяти не накапливались подписки
*/
visApi().onWidgetLoadedListener({widgetGuid: "123", guid: "123"}, function () {});
15. Подписка на то, что все виджеты загрузились
/**
* @param guid - guid подписываемого события. Используется, чтобы в памяти не накапливались подписки
*/
visApi().onAllWidgetsLoadedListener({guid: "123"}, function () {});
16. Получить состояние выпадающего списка в виджете "Фильтр"
/**
* @param widgetGuid- guid виджета Фильтр
*/
visApi().getFilterIsOpen(widgetGuid);
17.Подписка на то, в каком состоянии находится выпадающий список в виджете "Фильтр"
/**
* @param widgetGuid - guid виджета, на который хотим подписаться
* @param guid - guid подписываемого события. Используется, чтобы в памяти не накапливались подписки
*/
visApi().onFilterIsOpenChangedListener({widgetGuid: "123", guid: "123"}, function () {});