Обзор API
Конструктор Pivot
new pivot.Pivot("#root", {
// параметры конфигурации
});
Параметры:
- HTML-контейнер (идентификатор HTML-контейнера)
- объект параметров конфигурации (смотрите здесь)
Методы Pivot
| Название | Описание |
|---|---|
| getTable() | Предос тавляет доступ к базовому экземпляру виджета Table в таблице Pivot |
| setConfig() | Обновляет текущую конфигурацию виджета Pivot |
| setLocale() | Применяет новую локаль к Pivot |
| showConfigPanel() | Показывает или скрывает панель настройки |
Внутреннее API Pivot
Методы Event Bus
| Название | Описание |
|---|---|
| api.detach() | Позволяет удалять/отсоединять обработчики действий |
| api.exec() | Позволяет инициировать внутренние события |
| api.intercept() | Позволяет перехватывать и предотвращать внутренние события |
| api.on() | Позволяет прикрепить обработчик к внутренним событиям |
| api.setNext() | Позволяет добавить действие в цепочку Event Bus |
Методы состояния
| Название | Описание |
|---|---|
| api.getReactiveState() | Возвращает объект с реактивными свойствами Pivot |
| api.getState() | Возвращает объект со свойствами StateStore компонента Pivot |
| api.getStores() | Возвращает объект со свойствами DataStore компонента Pivot |
События Pivot
| Название | Описание |
|---|---|
| add-field | Срабатывает, когда новое поле добавляется в область строк, столбцов или значений |
| apply-filter | Срабатывает при применении фильтра |
| delete-field | Срабатывает при удалении поля |
| move-field | Срабатывает при изменении порядка полей |
| open-filter | Срабатывает при активации фильтра для поля |
| render-table | Срабатывает после обработки конфигурации виджета и непосредственно перед рендерингом таблицы |
| show-config-panel | Срабатывает при изменении видимости панели конфигурации |
| update-config | Срабатывает при изменении строк, столбцов или функций агрегации через интерфейс Pivot |
| update-field | Срабатывает при обновлении поля |
Свойства Pivot
| Название | Описание |
|---|---|
| columnShape | Необязательный. Настраивает внешний вид и поведение колонок Pivot |
| config | Опциональный. Определяет структуру таблицы Pivot и способ агрегации данных |
| configPanel | Необязательный. Управляет видимостью панели конфигурации в интерфейсе |
| data | Необязательный. Массив объектов с данными для таблицы Pivot |
| fields | Необязательный. Массив объектов с полями для таблицы Pivot |
| headerShape | Необязательный. Настраивает внешний вид и поведение заголовков в таблице Pivot |
| limits | Необязательный. Определяет максимальный лимит количества строк и столбцов в итоговом наборе данных |
| locale | Необязательный. Объект пользовательской локали Pivot |
| methods | Необязательный. Задаёт пользовательские математические методы для агрегации данных |
| predicates | Необязательный. Предоставляет пользовательские функции предварительной обработки для измерений данных (строки, столбцы) |
| readonly | Необязательный. Включает/отключает режим только для чтения |
| tableShape | Необязательный. Настраивает внешний вид таблицы Pivot |