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

...

...

...

...

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

/**
* @param widgetGuid - guid виджета, на котором хотим установить фильтр
*/

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().setFilterSelectedValues(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",  "ods", "odp".

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

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

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

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

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

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

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

visApi().getDrillLevel(widgetGuid) number

Возвращает текущий уровень drilldown в виджете (гистограмма, круговая, график).

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

visApi().getDrillPath(widgetGuid) string[][]

Возвращает путь к текущему уровню drilldown в виджете (гистограмма, круговая, график).

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

visApi().drillDown(widgetGuid, values) void

Производит drilldown (проваливание на следующий уровень) в виджете.

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

values: string[] - значение, по которому нужно произвести drilldown. Передается массив, так как на одном уровне может быть разбиение по нескольким измерениям. Если передать null, то drilldown произойдет по выбранным значениям на виджете.

visApi().drillUp(widgetGuid) void

Производит drillup (возвращает на один уровень вверхе после drilldown) в виджете.

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

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

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 подписываемого события. Используется, чтобы в памяти не накапливались подписки. Если повторно использовать эту же функцию с таким же guid, то старая подписка отпишется.

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

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

visApi().onAllWidgetsLoadedListener({ guid }, handler) void

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

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

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, если выпадающий список открыт.

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

Подписка на drilldown в виджете (гистограмма, круговая, график).

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

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

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

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

Подписка на drillup в виджете (гистограмма, круговая, график).

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

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

handler: Function({ widgetGuid: string, hierarchyPath: string[][] }) => void  - Функция обратной связи, которая вызывается после того, как произошел drillup в виджете. widgetGuid: string - guid виджета, у которого происходит drilldown. hierarchyPath: string[][] - путь к текущему уровню.

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

Подписка, которая вызывается перед загрузкой данных для drilldown в виджете (гистограмма, круговая, график).

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

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

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

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

...

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[] - значения итогов/подитогов.