Виджет
Виджеты позволяют вам отображать метрики в стандартном виде стандартном виде интерфейса системы Центральный Пульт.
Виджеты это часть данные клиента объекта.
Модель Виджет
Поле | Тип | Описание |
---|---|---|
id |
String |
ID виджета. |
type |
String |
Тип виджета. |
parameters |
Object |
Набор параметров виджета. Зависят от Типа виджета. |
Типы виджетов
Центральный Пульт предоставляет 10 типов виджетов, каждый со своим набором параметров. Ниже вы можете найти типы виджетов и их параметры.
Настройки виджета, описанные ниже, определяются в поле parameter
.
counter
Виджет счётчик отображает текст и числовые значения из таблицы данных.

Поле |
Тип |
Описание |
bindPeriod |
String |
Тип интервала метрики. Доступные типы:
|
Object |
Если в поле |
|
customAvgPeriod.from |
Integer |
Время начала периода для интервала типа |
customAvgPeriod.to |
Integer |
Время конца периода для интервала типа |
dictionary |
String | Object |
Словарь, который используется для отображения значений метрики. Чтобы использовать существующий словарь, укажите его название:
Также, можно определить новый словарь для конкретного виджета:
|
entity |
Array<String> |
Сущность в которой система будет искать указанную метрику для отображения на виджете. Если это поле пустое, то система будет искать указанную метрику в объекте, к которому привязан этот виджет. Сущность определяется следующим образом:
Например, виджет, у которого заданы настройки, указанные ниже, будет искать метрики в объекте с ID
|
fontSize |
Integer |
Размер шрифта, который используется для многострочной метрики. |
humanReadable |
Boolean |
Сократить значение, если возможно. Удаляет ведущие и конечные нули, заменяет большие числа суффиксами (например, |
metric |
String |
Имя метрики, отображаемой на виджете. |
metricAvg |
String |
Тип преобразования значений метрики. Вы можете выбрать свой период для всех типов преобразования, кроме Доступные значения:
|
metricCaption |
String |
Заголовок отображаемой метрики. Если это поле пустое, виджет использует название метрики как заголовок. |
multiline |
Boolean |
Использовать многострочный формат для отображения метрики. |
periodAvg |
String |
Интервал, для которого отображается метрика. Доступные значения: При выборе значения |
position |
Object |
Позиция виджета в стандартном и подробном виде. |
showBefore |
Boolean |
Отображать метрики за предыдущий период. |
showBeforeTimes |
Integer |
Смещение значений метрики за предыдущий период. Для использования смещения, в поле Это поле использует значение из поля
|
showName |
Boolean |
Показывать заголовок метрики. |
theme |
String |
Тема виджета. Доступные значения – |
toStringValue |
Boolean |
Отображать значение как оно было получено, без сокращения. Например, если это поле выставлено в |
ring
Виджет Кольцо отображает процентные значения из таблицы данных.

Поле | Тип | Описание |
---|---|---|
bindPeriod |
String |
Тип интервала метрики. Доступные типы:
|
Object |
Если в поле |
|
customAvgPeriod.from |
Integer |
Время начала периода для интервала типа |
customAvgPeriod.to |
Integer |
Время конца периода для интервала типа |
entity |
Array<String> |
Сущность в которой система будет искать указанную метрику для отображения на виджете. Если это поле пустое, то система будет искать указанную метрику в объекте, к которому привязан этот виджет. Сущность определяется следующим образом:
Например, виджет, у которого заданы настройки, указанные ниже, будет искать метрики в объекте с ID
|
metric |
String |
Имя метрики, отображаемой на виджете. |
metricAvg |
String |
Тип преобразования значений метрики. Вы можете выбрать свой период для всех типов преобразования, кроме Доступные значения:
|
metricCaption |
String |
Заголовок отображаемой метрики. Если это поле пустое, виджет использует название метрики как заголовок. |
periodAvg |
String |
Интервал, для которого отображается метрика. Доступные значения: При выборе значения |
position |
Object |
Позиция виджета в стандартном и подробном виде. |
position.height |
Integer |
Высота виджета. |
position.width |
Integer |
Ширина виджета. |
showBefore |
Boolean |
Отображать метрики за предыдущий период. |
showBeforeTimes |
Integer |
Смещение значений метрики за предыдущий период. Для использования смещения, в поле Это поле использует значение из поля
|
showName |
Boolean |
Показывать заголовок метрики. |
percent-bar
Виджет Уровень предназначен для отображения значений из Таблицы данных.

Поле | Тип | Описание |
---|---|---|
bindPeriod |
String |
Тип интервала метрики. Доступные типы:
|
Object |
Если в поле |
|
customAvgPeriod.from |
Integer |
Время начала периода для интервала типа |
customAvgPeriod.to |
Integer |
Время конца периода для интервала типа |
entity |
Array<String> |
Сущность в которой система будет искать указанную метрику для отображения на виджете. Если это поле пустое, то система будет искать указанную метрику в объекте, к которому привязан этот виджет. Сущность определяется следующим образом:
Например, виджет, у которого заданы настройки, указанные ниже, будет искать метрики в объекте с ID
|
metric |
String |
Имя метрики, отображаемой на виджете. |
metricAvg |
String |
Тип преобразования значений метрики. Вы можете выбрать свой период для всех типов преобразования, кроме Доступные значения:
|
metricCaption |
String |
Заголовок отображаемой метрики. Если это поле пустое, виджет использует название метрики как заголовок. |
periodAvg |
String |
Интервал, для которого отображается метрика. Доступные значения: При выборе значения |
position |
Object |
Позиция виджета в стандартном и подробном виде. |
position.height |
Integer |
Высота виджета. |
position.width |
Integer |
Ширина виджета. |
showBefore |
Boolean |
Отображать метрики за предыдущий период. |
showBeforeTimes |
Integer |
Смещение значений метрики за предыдущий период. Для использования смещения, в поле Это поле использует значение из поля
|
showName |
Boolean |
Показывать заголовок метрики. |
pie
Этот виджет позволяет выбрать и сравнить несколько разных метрик из одного объекта или одноименные метрики из нескольких объектов.

Поле | Тип | Описание |
---|---|---|
bindPeriod |
String |
Тип интервала метрики. Доступные типы:
|
colors |
Array<String> |
Набор цветов, используемых для цветов кругового графика. По умолчанию – не задан, цвета выбираются из списка, указанного в конфигурации Web-приложения. |
Object |
Если в поле |
|
customAvgPeriod.from |
Integer |
Время начала периода для интервала типа |
customAvgPeriod.to |
Integer |
Время конца периода для интервала типа |
entity |
Array<String> |
Сущность или список сущностей, в которых система будет искать указанную метрику для отображения на виджете. Если это поле пустое, то система будет искать указанную метрику в объекте, к которому привязан этот виджет. Сущность определяется следующим образом:
Например, виджет, у которого заданы настройки, указанные ниже, будет искать метрики в объекте с ID
|
innerRadius |
Integer |
Радиус внутреннего круга. |
legend |
Boolean |
Отображать легенду графика. |
metric |
Array<String> |
Массив метрик, которые должны отображаться на круговом графике. |
metricAvg |
String |
Тип преобразования значений метрики. Вы можете выбрать свой период для всех типов преобразования, кроме Доступные значения:
|
metricCaption |
String |
Заголовок отображаемой метрики. Если это поле пустое, виджет использует название метрики как заголовок. |
periodAvg |
String |
Интервал, для которого отображается метрика. Доступные значения: При выборе значения |
position |
Object |
Позиция виджета в стандартном и подробном виде. |
position.height |
Integer |
Высота виджета. |
position.width |
Integer |
Ширина виджета. |
sectorLabel |
String |
Тип заголовка для метрик кругового графика. Доступные значения – |
sectorLabelColor |
String |
Цвет заголовка сектора. |
showBefore |
Boolean |
Отображать метрики за предыдущий период. |
showBeforeTimes |
Integer |
Смещение значений метрики за предыдущий период. Для использования смещения, в поле Это поле использует значение из поля
|
showName |
Boolean |
Отображать подпись метрик. |
radar
Радиальный виджет позволяет отображать и сравнивать метрики нескольких сущностей.

Поле | Тип | Описание |
---|---|---|
bindPeriod |
String |
Тип интервала метрики. Доступные типы:
|
Object |
Если в поле |
|
customAvgPeriod.from |
Integer |
Время начала периода для интервала типа |
customAvgPeriod.to |
Integer |
Время конца периода для интервала типа |
entity |
Array<String> |
Сущность или список сущностей, в которых система будет искать указанную метрику для отображения на виджете. Если это поле пустое, то система будет искать указанную метрику в объекте, к которому привязан этот виджет. Сущность определяется следующим образом:
Например, виджет, у которого заданы настройки, указанные ниже, будет искать метрики в объекте с ID
|
legend |
Boolean |
Отображать легенду графика. |
metric |
Array<String> |
Массив метрик, которые должны отображаться на радиальном виджете. |
metricAvg |
String |
Тип преобразования значений метрики. Вы можете выбрать свой период для всех типов преобразования, кроме Доступные значения:
|
metricCaption |
String |
Заголовок отображаемой метрики. Если это поле пустое, виджет использует название метрики как заголовок. |
periodAvg |
String |
Интервал, для которого отображается метрика. Доступные значения: При выборе значения
|
position |
Object |
Позиция виджета в стандартном и подробном виде. |
position.height |
Integer |
Высота виджета. |
position.width |
Integer |
Ширина виджета. |
showBefore |
Boolean |
Отображать метрики за предыдущий период. |
showBeforeTimes |
Integer |
Смещение значений метрики за предыдущий период. Для использования смещения, в поле Это поле использует значение из поля
|
showName |
Boolean |
Отображать подпись метрик. |
chart
Виджет График позволяет построить график по заданной метрике.

Поле | Тип | Описание |
---|---|---|
chartType |
String |
Тип графика. Доступные типы – |
downsample |
Integer |
Размер интервала даунсэмплинга. |
duration |
Integer |
Период отображения метрик. Указывается в миллисекундах. |
entity |
Array<String> |
Сущность в которой система будет искать указанную метрику для отображения на виджете. Если это поле пустое, то система будет искать указанную метрику в объекте, к которому привязан этот виджет. Сущность определяется следующим образом:
Например, виджет, у которого заданы настройки, указанные ниже, будет искать метрики в объекте с ID
|
legend |
Boolean |
Показывать легенду на виджете. |
metric |
String |
Метрика или набор метрик виджета. Метрики должны быть указаны как математическая формула. |
movingAverage |
Boolean |
Использовать скользящую среднюю на графике. |
movingAveragePeriod |
Integer |
Длина интервала скользящей средней. |
position |
Object |
Позиция виджета в стандартном и подробном виде. |
position.height |
Integer |
Высота виджета. |
position.width |
Integer |
Ширина виджета. |
graph
Виджет Структура отображает отношения дочерних сущностей.

Поле | Тип | Описание |
---|---|---|
depth |
Integer |
Глубина структуры. |
entity |
Array<String> |
Сущность в которой система будет искать указанную метрику для отображения на виджете. Если это поле пустое, то система будет искать указанную метрику в объекте, к которому привязан этот виджет. Сущность определяется следующим образом:
Например, виджет, у которого заданы настройки, указанные ниже, будет искать метрики в объекте с ID
|
graphType |
String |
Тип структуры. Доступные типы – |
position |
Object |
Позиция виджета в стандартном и подробном виде. |
position.height |
Integer |
Высота виджета. |
position.scale |
Integer |
Масштаб графика. |
position.translation |
Array<Integer> |
Координаты графика внутри виджета. |
position.width |
Integer |
Ширина виджета. |
section
Виджет Секция позволяет выводить секцию из вида подробной информации

Поле | Тип | Описание |
---|---|---|
entity |
Array<String> |
Сущность в которой система будет искать указанную метрику для отображения на виджете. Если это поле пустое, то система будет искать указанную метрику в объекте, к которому привязан этот виджет. Сущность определяется следующим образом:
Например, виджет, у которого заданы настройки, указанные ниже, будет искать метрики в объекте с ID
|
position |
Object |
Позиция виджета в стандартном и подробном виде. |
position.height |
Integer |
Высота виджета. |
position.width |
Integer |
Ширина виджета. |
section |
String |
Тип секции, отображаемой на виджете. Доступные типы – |
operation-widget
Виджет Кнопка позволяет отображать в интерфейсе кнопку, которая запускает операцию.

Поле | Тип | Описание |
---|---|---|
color |
String |
Цвет кнопки. |
entity |
Array<String> |
Сущность в которой система будет искать указанную метрику для отображения на виджете. Если это поле пустое, то система будет искать указанную метрику в объекте, к которому привязан этот виджет. Сущность определяется следующим образом:
Например, виджет, у которого заданы настройки, указанные ниже, будет искать метрики в объекте с ID
|
operation |
String |
ID операции. Операция будет выполнена при нажатию на кнопку. |
operationCaption |
String |
Подпись операции. |
position |
Object |
Позиция виджета в стандартном и подробном виде. |
position.height |
Integer |
Высота виджета. |
position.width |
Integer |
Ширина виджета. |
iframe
Виджет iframe позволяет встраивать контент с других веб сайтов в пользовательский интерфейс.

Поле | Тип | Описание |
---|---|---|
entity |
Array<String> |
Сущность в которой система будет искать указанную метрику для отображения на виджете. Если это поле пустое, то система будет искать указанную метрику в объекте, к которому привязан этот виджет. Сущность определяется следующим образом:
Например, виджет, у которого заданы настройки, указанные ниже, будет искать метрики в объекте с ID
|
src |
String |
URL страницы, показываемой в iframe. |
type |
String |
MIME тип данных, показываемых в iframe. |
position |
Object |
Позиция виджета в стандартном и подробном виде. |
position.height |
Integer |
Высота виджета. |
position.width |
Integer |
Ширина виджета. |