Методы
visApi().setFilterSelectedValues(widgetGuid, values, handler) void
Устанавливает фильтр в виджете.
widgetGuid: string - guid виджета, на котором хотим установить фильтр.
values: string[][] - массив массивов значений, которые нужно установить, как фильтр. Пример: [["Москва"], ["Казань"]]. Для сброса фильтра необходимо передать пустой массив: [].
...
Методы
...
visApi().
...
setFilterSelectedValues(widgetGuid, values, handler) void
Устанавливает исключающий фильтр в виджете.
widgetGuid: string - guid виджета, на котором хотим установить фильтр.
...
handler: Function() => void - Функция обратной связи, которая вызывается после того, как фильтр был установлен.
...
visApi().setDateFilterSelectedValues(widgetGuid, values) void
Устанавливает фильтр выбранные даты в виджете Фильтр по датам.
widgetGuid: string - guid виджета, на котором хотим установить фильтр.
...
format: string - формат файла, в который нужно экспортировать дашборд. Поддерживаемые форматы: "png ", "pdf ", "xlsx ", "pptx", "ods", "odp".
visApi().exportExcelWidgetData(widgetGuid) Promise<void>
...
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.
Функции, структуры ответов которых могут часто изменяться
...
handler: Function({ widgetGuid: string }) => void - функция обратной связи, которая вызывается после загрузки виджета. Если виджет уже загрузился, то функция сработает сразу. widgetGuid: string - guid виджета, который загрузился. Примечание: функция вызывается сразу после выполнения js кода виджета, не дожидаясь его отрисовки.
visApi().onAllWidgetsLoadedListener({ guid }, handler) void
Подписка на загрузку виджета.
guid: string - произвольный guid подписываемого события. Используется, чтобы в памяти не накапливались подписки. Если повторно использовать эту же функцию с таким же guid, то старая подписка отпишется.
handler: Function() => void - функция обратной связи, которая вызывается после загрузки всех виджетов. Примечание: функция вызывается сразу после выполнения js кода последнего виджета, не дожидаясь его отрисовки.
...
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
...