Структура дашборда в JSON
Дашборды позволяют визуализировать, организовывать и совместно использовать аналитические данные.
Каждый дашборд характеризуется следующими особенностями:
- Может состоять из одной или нескольких строк панелей.
- Каждая панель содержит визуализацию, например, диаграмму или таблицу.
- В каждой панели поиск генерирует данные для визуализации.
- Включает элементы
inputs
, такие как текстовые поля или мультивыбор, для взаимодействия с пользователем. Элементы в дашборде можно настроить для реагирования на ввод данных, например, для изменения поискового запроса, который управляет визуализацией.
Составные части дашборда
Общий вид иерархии дашборда выглядит следующим образом
{
"label": [0..1],
"inputs": [
{
"input": [0..N]
}
],
"rows": [
{
"panels": [0..N]
}
],
"vars": [
{
"var": [0..N]
}
]
}
Элемент | Описание | Представление в JSON |
---|---|---|
Заголовок | Наименование дашборда. |
|
Фильтры | Массив элементов для взаимодействия. |
|
Строки | Массив строк дашборда с панелью или панелями. |
|
- | - |
|
Фильтры
Фильтры определяют интерфейс взаимодействия пользователя с дашбордом. Фильтр, например, радиокнопки и чек-бокс позволяют пользователям выбирать один или несколько вариантов. Другие фильтры, такие как текстовые поля, поля ввода времени и т.д. позволяют пользователям вводить данные или изменять временной диапазон поиска.
Атрибуты
В каждом элементе используются следующие атрибуты.
Название | Тип данных | Предназначение |
---|---|---|
name | Строка | Системное имя фильтра. |
label | Строка | Текстовая метка для фильтра. |
type | Один из представленных типов.
| |
options | Объект | Предварительные настройки для фильтра. |
token | Объект | Значение, выбранное пользователем с помощью фильтра. |
timeInput | Строка | Значение системного поля фильтра типа time для использования в поисковых запросах. Применим для типов фильтров: selection , multiselection . |
Атрибут options
В каждом фильтре могут использоваться различные виды настроек.
Название | Тип данных | Предназначение |
---|---|---|
default | Объект | Настройки по умолчанию для фильтра. |
static | Массив | Перечень значений, которые заполняются вручную (для типов checkbox , selection , radio , multiselection ). |
allow_custom | Булево значение | Возможность ввести свой вариант для дальнейшего выбора в фильтре (только для типа multiselection ). |
search | Строка | Поисковый запрос для формирования динамических опций выбора в фильтре (только для типов selection и multiselection ). |
Атрибут default
Для каждого типа фильтров используются свои настройки по умолчанию.
Тип фильтра | Структура | Описание |
---|---|---|
time |
|
|
|
|
|
|
| Текстовое значение по умолчанию. |
Атрибут token
Для каждого типа фильтров токен имеет свое представление.
Тип фильтра | Структура | Описание |
---|---|---|
|
| Для
Для
Для
|
|
|
|
Панели
В контексте интерфейсов дашбордов элемент rows
(строки) является контейнером для одного или нескольких дочерних элементов panel
(панель). Она служит для группировки и управления расположением панелей на странице.
Внутри контейнера row
(строка) располагаются элементы panel
(панель), которые служат для отображения визуальных данных (графики, диаграммы и т.п.). Панели позволяют управлять группировкой и расположением визуализаций на странице.
Внутри панели элементы визуализации выравниваются по горизонтали. Для расположения визуализаций вертикально, создаётся новый контейнер row
.
Общий вид структуры панели
{
"inputs": [],
"height": "number | string",
"width": "number | string",
"label": "string",
"type": "string",
"viz": {},
"depends": [],
"subpanels": []
}
Элемент | Описание | Представление в JSON |
---|---|---|
Фильтры | Массив элементов для взаимодействия. |
|
Высота панели | Числовое или строковое значение (в процентах) высоты панели. |
|
Ширина панели | Числовое или строковое значение (в процентах или пикселях) ширины панели. |
|
Заголовок | Заголовок панели. |
|
Тип | Тип панели. |
|
Визуализация | Используемая визуализация в панели. |
|
Отображение | Массив токенов, используемых для отображения панели. |
|
Подпанели | Массив дочерних панелей. |
|
Атрибут viz
Панель может содержать один или несколько типов визуализаций.
Элемент | Структура | Описание |
---|---|---|
|
| Настройки для визуализации. |
options.sme.query |
| Поисковый запрос формирующий значения в визуализации. |
options.drilldown |
| Механизм Drilldown (детализации).
|
|
| Значение системного поля фильтра типа |
| ||
|
| Один из представленных типов визуализаций. |
Тип визуализации table
(Таблица)
Для визуализации характерны следующие типы настроек.
Элемент | Структура | Описание |
---|---|---|
options.colorRuleList |
| Настройка цветовой схемы столбцов.
|
colorRuleList[].palette |
| Для |
| Для
| |
| Для
| |
options.tableAutoWidth |
| Флаг автоматического расчета ширины таблицы. |
options.pagination |
| Настройка пагинации.
|
options.summary |
| Флаг включения статистики по столбцам. |