Сравнение страниц

...

1. Установка фильтров

visApi().setFilterSelectedValues(widgetGuid, [["Москва"], ["Казань"]], function (response) {});

...

2. Установка исключающих фильтров

visApi().setExcludeFilterSelectedValues(widgetGuid, [["Москва"], ["Казань"]], function (response) {});

3. Получение данных у виджета

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. Получить состояние всех виджетов на листе

visApi().getWidgets();

8. Получить состояние выделенных виджетов на листе

visApi().getSelectedWidgets();

9. Получить состояние конкретного виджета на листе по ID

/**
* @param widgetGuid - guid виджета, данные которого хотим получить;
*/

visApi().getWidgetByGuid(widgetGuid);

10. Получить выделенные (выбранные) значения (selectedValues)

/**
* @param widgetGuid - guid виджета, выбранные значения которого хотим получить;
*/

visApi().getSelectedValues(widgetGuid);

11. Получить значение зума листа дашборда

visApi().getSheetZoom() - вернет величину зума.

12. Установка фильтра по датам

"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")])

13.Подписка на то, что виджет загрузился

/**
* @param widgetGuid - guid виджета, на который подписываемся;

...

Методы

...

visApi().setFilterSelectedValues(widgetGuid, values, handler) void

Устанавливает фильтр в виджете.

widgetGuid: string - guid виджета, на котором хотим установить фильтр.

values: string[][] - массив массивов значений, которые нужно установить, как фильтр. Пример: [["Москва"], ["Казань"]]. Для сброса фильтра необходимо передать пустой массив: [].

handler: Function() => void - Функция обратной связи, которая вызывается после того, как фильтр был установлен.

visApi().setExcludeFilterSelectedValues(widgetGuid, values, handler) void

Устанавливает исключающий фильтр в виджете.

widgetGuid: string - guid виджета, на котором хотим установить фильтр.

values: string[][] - массив массивов значений, которые нужно установить, как фильтр. Пример: [["Москва"], ["Казань"]]. Для сброса фильтра необходимо передать пустой массив: [].

handler: Function() => void - Функция обратной связи, которая вызывается после того, как фильтр был установлен.

visApi().setDateFilterSelectedValues(widgetGuid, values) void

Устанавливает фильтр в виджете.

widgetGuid: string - guid виджета, на котором хотим установить фильтр.

values: Date[][] - массив дат, которые нужно установить в фильтр по датам. Пример для множественного выбора (от и до): [new Date(), new Date()]. Пример для единичного выбора: [new Date()]. Для сброса фильтра необходимо передать пустой массив: [].

visApi().getWidgetDataByGuid(widgetGuid) Promise<{ data: DataFrame, selected : string[][] }>

Возвращает данные виджета. Асинхронная функция.

widgetGuid: string - guid виджета, данные которого необходимо получить.

Возвращаемый ответ: data: DataFrame - данные виджета. selected: string[][] - массив выбранных значений (фильтров).

visApi().getSelectedValues(widgetGuid) string[][] = [[" Москва ", " 2020 "], [" Казань ", "2021"]]

Возвращает выбранные значения (фильтры) на виджете.

visApi().getSheetZoom() number

Возвращает значение зума (0 – 100%) листа на дашборде.

visApi().getFilterIsOpen(widgetGuid) boolean

Возвращает состояние выпадающего списка в виджете «Фильтр».

visApi().exportDashboard(format) Promise<void>

Экспортирует дашборд. Асинхронная функция.

format: string - формат файла, в который нужно экспортировать дашборд. Поддерживаемые форматы: "png ", "pdf ", "xlsx ", "pptx".

visApi().exportExcelWidgetData(widgetGuid) Promise<void>

Экспортирует видимые данные виджета в формат XLSX. Асинхронная функция.

Примечание: экспортируется только «первые» данные, данные после drilldown или при раскрытии строк/столбцов не экспортируются.

widgetGuid: string - guid виджета, данные которого необходимо экспортировать в XLSX.

visApi().exportAllWidgetData(widgetGuid) Promise<void>

Экспортирует все данные виджета в формат XLSX. Асинхронная функция.

widgetGuid: string - guid виджета, данные которого необходимо экспортировать в XLSX.

Функции, структуры ответов которых могут часто изменяться

visApi().getWidgets() object[]

Возвращает объекты всех виджетов на выбранном листе. Имеет сложную структуру для каждого типа виджета.

visApi().getSelectedWidgets() object[]

Возвращает объекты выделенных виджетов на выбранном листе. Имеет сложную структуру для каждого типа виджета.

visApi().getWidgetByGuid(widgetGuid) object

Возвращает объект виджета на выбранном лист. Имеет сложную структуру для каждого типа виджета.

widgetGuid: string - guid виджета, который нужно получить.

События

...

visApi().onSelectedValuesChangedListener({ guid, widgetGuid }, handler) void

Подписка на изменение выбранных фильтров у виджета.

guid: string - произвольный  guid подписываемого события. Используется, чтобы в памяти не накапливались подписки. Если повторно использовать эту же функцию с таким же guid, то старая подписка отпишется.

widgetGuid: string - guid виджета, на изменение выбранных значений (фильтров) которого нужно подписаться.

handler: Function({ widgetGuid: string, selectedValues: string[][], useExcluding: boolean) => void - Функция обратной связи, которая вызывается при изменении выбранных значений (фильтров) на виджете. widgetGuid: string - guid виджета, в котором изменили выбранные значения. selectedValues: string[][] - выбранные значения. useExcluding: boolean - true, если фильтр исключающий.

visApi().onWidgetLoadedListener({ guid, widgetGuid }, handler) void

Подписка на загрузку виджета.

guid: string - произвольный guid подписываемого события. Используется, чтобы в памяти не накапливались подписки

...

visApi().onWidgetLoadedListener({widgetGuid, guid}, function () {});

14.Подписка на то, что все виджеты загрузились

/**

...

. Если повторно использовать эту же функцию с таким же guid, то старая подписка отпишется.

widgetGuid: string - guid виджета, на загрузку которого нужно подписаться.

handler: Function({ widgetGuid: string }) => void  - функция обратной связи, которая вызывается после загрузки виджета. widgetGuid: string - guid виджета, который загрузился. Примечание: функция вызывается сразу после выполнения js кода виджета, не дожидаясь его отрисовки.

visApi().onAllWidgetsLoadedListener(handler) void

Подписка на загрузку виджета.

handler: Function() => void - функция обратной связи, которая вызывается после загрузки всех виджетов. Примечание: функция вызывается сразу после выполнения js кода последнего виджета, не дожидаясь его отрисовки.

visApi().onFilterIsOpenChangedListener({ guid, widgetGuid }, handler) void

Подписка на загрузку виджета.

guid: string - произвольный guid подписываемого события. Используется, чтобы в памяти не накапливались подписки

...

. Если повторно использовать эту же функцию с таким же guid, то старая подписка отпишется.

widgetGuid: string - guid виджета «Фильтр», на открытие выпадающего списка которого нужно подписаться.

handler: Function({ widgetGuid: string, isOpen: boolean }) => void  - Функция обратной связи, которая вызывается после открытия/закрытия выпадающего списка в виджете «Фильтр». widgetGuid: string - guid виджета «Фильтр», выпадающий список которого открыли/закрыли. isOpen: boolean - true, если выпадающий список открыт.

Описание объектов

...

DataFrame

cols: string[][] - названия колонок.

rows: string[][] - названия строк.

values: number[][] - значения.

colsInfo: ColInfo[] - информация о колонках.

colsMeta: ColMeta[] - мета-информация о колонках.

totals: Total[] - итоги/подитоги.

colsDataType: string[] - типы колонок.

colHeaders: string[] - названия заголовков столбцов.

rowHeaders: string[] - названия заголовков строк.

ColInfo

id: string - объединенная (join) id колонок.

idParts: string[] - массив id колонок.

ColMeta

measureGroupId: string - id группы показателей.

measureId: string - id показателя.

 dimensions: string[] - массив id измерений.

Total

columnPath: string[] - путь к итогам в столбце.

rowPath: string[] - путь к итогам в строке.

totals: object[] - значения итогов/подитогов.