Виджет

Виджеты позволяют вам отображать метрики в стандартном виде стандартном виде интерфейса системы Центральный Пульт.

Виджеты это часть данные клиента объекта.

Модель Виджет

Поле Тип Описание

id

String

ID виджета.

type

String

Тип виджета.

parameters

Object

Набор параметров виджета. Зависят от Типа виджета.

Типы виджетов

Центральный Пульт предоставляет 10 типов виджетов, каждый со своим набором параметров. Ниже вы можете найти типы виджетов и их параметры.

Настройки виджета, описанные ниже, определяются в поле parameter.

counter

Виджет счётчик отображает текст и числовые значения из таблицы данных.

Counter Widget

Поле

Тип

Описание

bindPeriod

String

Тип интервала метрики.

Доступные типы:

  • present – отсчёт от текущего момента времени,

  • calendar – отсчёт от указанного момента времени.

customAvgPeriod

Object

Если в поле periodAvg указать значение custom, то в этой переменной можно задать свой интервал отображения метрики.

customAvgPeriod.from

Integer

Время начала периода для интервала типа custom.

customAvgPeriod.to

Integer

Время конца периода для интервала типа custom.

dictionary

String | Object

Словарь, который используется для отображения значений метрики. Чтобы использовать существующий словарь, укажите его название:

{
    "parameters": {
        ...
        "dictionary":"test"
    }
}

Также, можно определить новый словарь для конкретного виджета:

"parameters": {
    ...
    "dictionary": {
        "0": "No data",
        "4": "Normal"
    }
}

entity

Array<String>

Сущность в которой система будет искать указанную метрику для отображения на виджете. Если это поле пустое, то система будет искать указанную метрику в объекте, к которому привязан этот виджет.

Сущность определяется следующим образом:

<objects|links>-<id>

Например, виджет, у которого заданы настройки, указанные ниже, будет искать метрики в объекте с ID 659ce032cec144058ea7f488:

"parameters": {
    "entity": "objects-659ce032cec144058ea7f488",
    ...
}

fontSize

Integer

Размер шрифта, который используется для многострочной метрики.

humanReadable

Boolean

Сократить значение, если возможно. Удаляет ведущие и конечные нули, заменяет большие числа суффиксами (например, 1543000.82 заменяется на 1.54 M). Работает только если значение поля toStringValue равно false.

metric

String

Имя метрики, отображаемой на виджете.

metricAvg

String

Тип преобразования значений метрики. Вы можете выбрать свой период для всех типов преобразования, кроме current. Настроить период можно в полях bindPeriod, periodAvg, customAvgPeriod и showBeforeTimes.

Доступные значения:

  • current – текущее значение,

  • min – минимальное значение,

  • avg – среднее значение,

  • max – максимальное значение,

  • count – число точек,

  • zimsum – сумма всех значений,

  • dev – среднеквадратичное отклонение.

metricCaption

String

Заголовок отображаемой метрики. Если это поле пустое, виджет использует название метрики как заголовок.

multiline

Boolean

Использовать многострочный формат для отображения метрики.

periodAvg

String

Интервал, для которого отображается метрика. Доступные значения: 1h, 1d, 1w, 1n, 3n, 1y, custom.

При выборе значения custom, период нужно указать в поле customAvgPeriod field.

position

Object

Позиция виджета в стандартном и подробном виде.

showBefore

Boolean

Отображать метрики за предыдущий период.

showBeforeTimes

Integer

Смещение значений метрики за предыдущий период. Для использования смещения, в поле showBefore должно быть установлено значение true.

Это поле использует значение из поля periodAvg для определения единицы времени. Например, следующая конфигурация установит смещение отображаемой метрики на 3 часа:

"parameters": {
    "periodAvg": "1h",
    "showBeforeTimes": "3",
    ...
}

showName

Boolean

Показывать заголовок метрики.

theme

String

Тема виджета. Доступные значения – minimal, car, train-station.

toStringValue

Boolean

Отображать значение как оно было получено, без сокращения.

Например, если это поле выставлено в false, 14.428934061353705 будет отображаться как 14.429.

ring

Виджет Кольцо отображает процентные значения из таблицы данных.

Ring Widget
Поле Тип Описание

bindPeriod

String

Тип интервала метрики.

Доступные типы:

  • present – отсчёт от текущего момента времени,

  • calendar – отсчёт от указанного момента времени.

customAvgPeriod

Object

Если в поле periodAvg указать значение custom, то в этой переменной можно задать свой интервал отображения метрики.

customAvgPeriod.from

Integer

Время начала периода для интервала типа custom.

customAvgPeriod.to

Integer

Время конца периода для интервала типа custom.

entity

Array<String>

Сущность в которой система будет искать указанную метрику для отображения на виджете. Если это поле пустое, то система будет искать указанную метрику в объекте, к которому привязан этот виджет.

Сущность определяется следующим образом:

<objects|links>-<id>

Например, виджет, у которого заданы настройки, указанные ниже, будет искать метрики в объекте с ID 659ce032cec144058ea7f488:

"parameters": {
    "entity": "objects-659ce032cec144058ea7f488",
    ...
}

metric

String

Имя метрики, отображаемой на виджете.

metricAvg

String

Тип преобразования значений метрики. Вы можете выбрать свой период для всех типов преобразования, кроме current. Настроить период можно в полях bindPeriod, periodAvg, customAvgPeriod и showBeforeTimes.

Доступные значения:

  • current – текущее значение,

  • min – минимальное значение,

  • avg – среднее значение,

  • max – максимальное значение,

  • count – число точек,

  • zimsum – сумма всех значений,

  • dev – среднеквадратичное отклонение.

metricCaption

String

Заголовок отображаемой метрики. Если это поле пустое, виджет использует название метрики как заголовок.

periodAvg

String

Интервал, для которого отображается метрика. Доступные значения: 1h, 1d, 1w, 1n, 3n, 1y, custom.

При выборе значения custom, период нужно указать в поле customAvgPeriod field.

position

Object

Позиция виджета в стандартном и подробном виде.

position.height

Integer

Высота виджета.

position.width

Integer

Ширина виджета.

showBefore

Boolean

Отображать метрики за предыдущий период.

showBeforeTimes

Integer

Смещение значений метрики за предыдущий период. Для использования смещения, в поле showBefore должно быть установлено значение true.

Это поле использует значение из поля periodAvg для определения единицы времени. Например, следующая конфигурация установит смещение отображаемой метрики на 3 часа:

"parameters": {
    "periodAvg": "1h",
    "showBeforeTimes": "3",
    ...
}

showName

Boolean

Показывать заголовок метрики.

percent-bar

Виджет Уровень предназначен для отображения значений из Таблицы данных.

Percent Bar
Поле Тип Описание

bindPeriod

String

Тип интервала метрики.

Доступные типы:

  • present – отсчёт от текущего момента времени,

  • calendar – отсчёт от указанного момента времени.

customAvgPeriod

Object

Если в поле periodAvg указать значение custom, то в этой переменной можно задать свой интервал отображения метрики.

customAvgPeriod.from

Integer

Время начала периода для интервала типа custom.

customAvgPeriod.to

Integer

Время конца периода для интервала типа custom.

entity

Array<String>

Сущность в которой система будет искать указанную метрику для отображения на виджете. Если это поле пустое, то система будет искать указанную метрику в объекте, к которому привязан этот виджет.

Сущность определяется следующим образом:

<objects|links>-<id>

Например, виджет, у которого заданы настройки, указанные ниже, будет искать метрики в объекте с ID 659ce032cec144058ea7f488:

"parameters": {
    "entity": "objects-659ce032cec144058ea7f488",
    ...
}

metric

String

Имя метрики, отображаемой на виджете.

metricAvg

String

Тип преобразования значений метрики. Вы можете выбрать свой период для всех типов преобразования, кроме current. Настроить период можно в полях bindPeriod, periodAvg, customAvgPeriod и showBeforeTimes.

Доступные значения:

  • current – текущее значение,

  • min – минимальное значение,

  • avg – среднее значение,

  • max – максимальное значение,

  • count – число точек,

  • zimsum – сумма всех значений,

  • dev – среднеквадратичное отклонение.

metricCaption

String

Заголовок отображаемой метрики. Если это поле пустое, виджет использует название метрики как заголовок.

periodAvg

String

Интервал, для которого отображается метрика. Доступные значения: 1h, 1d, 1w, 1n, 3n, 1y, custom.

При выборе значения custom, период нужно указать в поле customAvgPeriod field.

position

Object

Позиция виджета в стандартном и подробном виде.

position.height

Integer

Высота виджета.

position.width

Integer

Ширина виджета.

showBefore

Boolean

Отображать метрики за предыдущий период.

showBeforeTimes

Integer

Смещение значений метрики за предыдущий период. Для использования смещения, в поле showBefore должно быть установлено значение true.

Это поле использует значение из поля periodAvg для определения единицы времени. Например, следующая конфигурация установит смещение отображаемой метрики на 3 часа:

"parameters": {
    "periodAvg": "1h",
    "showBeforeTimes": "3",
    ...
}

showName

Boolean

Показывать заголовок метрики.

pie

Этот виджет позволяет выбрать и сравнить несколько разных метрик из одного объекта или одноименные метрики из нескольких объектов.

Pie Chart Widget
Поле Тип Описание

bindPeriod

String

Тип интервала метрики.

Доступные типы:

  • present – отсчёт от текущего момента времени,

  • calendar – отсчёт от указанного момента времени.

colors

Array<String>

Набор цветов, используемых для цветов кругового графика.

По умолчанию – не задан, цвета выбираются из списка, указанного в конфигурации Web-приложения.

customAvgPeriod

Object

Если в поле periodAvg указать значение custom, то в этой переменной можно задать свой интервал отображения метрики.

customAvgPeriod.from

Integer

Время начала периода для интервала типа custom.

customAvgPeriod.to

Integer

Время конца периода для интервала типа custom.

entity

Array<String>

Сущность или список сущностей, в которых система будет искать указанную метрику для отображения на виджете. Если это поле пустое, то система будет искать указанную метрику в объекте, к которому привязан этот виджет.

Сущность определяется следующим образом:

<objects|links>-<id>

Например, виджет, у которого заданы настройки, указанные ниже, будет искать метрики в объекте с ID 659ce032cec144058ea7f488 и связи с ID 659cdffbcec144058ea7f44c:

"parameters": {
    "entity": [
        "objects-659ce032cec144058ea7f488",
        "links-659cdffbcec144058ea7f44c",
    ]
    ...
}

innerRadius

Integer

Радиус внутреннего круга.

legend

Boolean

Отображать легенду графика.

metric

Array<String>

Массив метрик, которые должны отображаться на круговом графике.

metricAvg

String

Тип преобразования значений метрики. Вы можете выбрать свой период для всех типов преобразования, кроме current. Настроить период можно в полях bindPeriod, periodAvg, customAvgPeriod и showBeforeTimes.

Доступные значения:

  • current – текущее значение,

  • min – минимальное значение,

  • avg – среднее значение,

  • max – максимальное значение,

  • count – число точек,

  • zimsum – сумма всех значений,

  • dev – среднеквадратичное отклонение.

metricCaption

String

Заголовок отображаемой метрики. Если это поле пустое, виджет использует название метрики как заголовок.

periodAvg

String

Интервал, для которого отображается метрика. Доступные значения: 1h, 1d, 1w, 1n, 3n, 1y, custom.

При выборе значения custom, период нужно указать в поле customAvgPeriod field.

position

Object

Позиция виджета в стандартном и подробном виде.

position.height

Integer

Высота виджета.

position.width

Integer

Ширина виджета.

sectorLabel

String

Тип заголовка для метрик кругового графика. Доступные значения – none, percent, value, entity.

sectorLabelColor

String

Цвет заголовка сектора.

showBefore

Boolean

Отображать метрики за предыдущий период.

showBeforeTimes

Integer

Смещение значений метрики за предыдущий период. Для использования смещения, в поле showBefore должно быть установлено значение true.

Это поле использует значение из поля periodAvg для определения единицы времени. Например, следующая конфигурация установит смещение отображаемой метрики на 3 часа:

"parameters": {
    "periodAvg": "1h",
    "showBeforeTimes": "3",
    ...
}

showName

Boolean

Отображать подпись метрик.

radar

Радиальный виджет позволяет отображать и сравнивать метрики нескольких сущностей.

Radar Widget
Поле Тип Описание

bindPeriod

String

Тип интервала метрики.

Доступные типы:

  • present – отсчёт от текущего момента времени,

  • calendar – отсчёт от указанного момента времени.

customAvgPeriod

Object

Если в поле periodAvg указать значение custom, то в этой переменной можно задать свой интервал отображения метрики.

customAvgPeriod.from

Integer

Время начала периода для интервала типа custom.

customAvgPeriod.to

Integer

Время конца периода для интервала типа custom.

entity

Array<String>

Сущность или список сущностей, в которых система будет искать указанную метрику для отображения на виджете. Если это поле пустое, то система будет искать указанную метрику в объекте, к которому привязан этот виджет.

Сущность определяется следующим образом:

<objects|links>-<id>

Например, виджет, у которого заданы настройки, указанные ниже, будет искать метрики в объекте с ID 659ce032cec144058ea7f488 и связи с ID 659cdffbcec144058ea7f44c:

"parameters": {
    "entity": [
        "objects-659ce032cec144058ea7f488",
        "links-659cdffbcec144058ea7f44c",
    ]
    ...
}

legend

Boolean

Отображать легенду графика.

metric

Array<String>

Массив метрик, которые должны отображаться на радиальном виджете.

metricAvg

String

Тип преобразования значений метрики. Вы можете выбрать свой период для всех типов преобразования, кроме current. Настроить период можно в полях bindPeriod, periodAvg, customAvgPeriod и showBeforeTimes.

Доступные значения:

  • current – текущее значение,

  • min – минимальное значение,

  • avg – среднее значение,

  • max – максимальное значение,

  • count – число точек,

  • zimsum – сумма всех значений,

  • dev – среднеквадратичное отклонение.

metricCaption

String

Заголовок отображаемой метрики. Если это поле пустое, виджет использует название метрики как заголовок.

periodAvg

String

Интервал, для которого отображается метрика. Доступные значения: 1h, 1d, 1w, 1n, 3n, 1y, custom.

При выборе значения custom, период нужно указать в поле customAvgPeriod field.

custom period must be specified in the customAvgPeriod field.

position

Object

Позиция виджета в стандартном и подробном виде.

position.height

Integer

Высота виджета.

position.width

Integer

Ширина виджета.

showBefore

Boolean

Отображать метрики за предыдущий период.

showBeforeTimes

Integer

Смещение значений метрики за предыдущий период. Для использования смещения, в поле showBefore должно быть установлено значение true.

Это поле использует значение из поля periodAvg для определения единицы времени. Например, следующая конфигурация установит смещение отображаемой метрики на 3 часа:

"parameters": {
    "periodAvg": "1h",
    "showBeforeTimes": "3",
    ...
}

showName

Boolean

Отображать подпись метрик.

chart

Виджет График позволяет построить график по заданной метрике.

Chart Widget
Поле Тип Описание

chartType

String

Тип графика. Доступные типы – lines, bars.

downsample

Integer

Размер интервала даунсэмплинга.

duration

Integer

Период отображения метрик. Указывается в миллисекундах.

entity

Array<String>

Сущность в которой система будет искать указанную метрику для отображения на виджете. Если это поле пустое, то система будет искать указанную метрику в объекте, к которому привязан этот виджет.

Сущность определяется следующим образом:

<objects|links>-<id>

Например, виджет, у которого заданы настройки, указанные ниже, будет искать метрики в объекте с ID 659ce032cec144058ea7f488:

"parameters": {
    "entity": "objects-659ce032cec144058ea7f488",
    ...
}

legend

Boolean

Показывать легенду на виджете.

metric

String

Метрика или набор метрик виджета. Метрики должны быть указаны как математическая формула.

movingAverage

Boolean

Использовать скользящую среднюю на графике.

movingAveragePeriod

Integer

Длина интервала скользящей средней.

position

Object

Позиция виджета в стандартном и подробном виде.

position.height

Integer

Высота виджета.

position.width

Integer

Ширина виджета.

graph

Виджет Структура отображает отношения дочерних сущностей.

Graph Widget
Поле Тип Описание

depth

Integer

Глубина структуры.

entity

Array<String>

Сущность в которой система будет искать указанную метрику для отображения на виджете. Если это поле пустое, то система будет искать указанную метрику в объекте, к которому привязан этот виджет.

Сущность определяется следующим образом:

<objects|links>-<id>

Например, виджет, у которого заданы настройки, указанные ниже, будет искать метрики в объекте с ID 659ce032cec144058ea7f488:

"parameters": {
    "entity": "objects-659ce032cec144058ea7f488",
    ...
}

graphType

String

Тип структуры. Доступные типы – block, blockVert, mindMap, force.

position

Object

Позиция виджета в стандартном и подробном виде.

position.height

Integer

Высота виджета.

position.scale

Integer

Масштаб графика.

position.translation

Array<Integer>

Координаты графика внутри виджета.

position.width

Integer

Ширина виджета.

section

Виджет Секция позволяет выводить секцию из вида подробной информации

Section Widget
Поле Тип Описание

entity

Array<String>

Сущность в которой система будет искать указанную метрику для отображения на виджете. Если это поле пустое, то система будет искать указанную метрику в объекте, к которому привязан этот виджет.

Сущность определяется следующим образом:

<objects|links>-<id>

Например, виджет, у которого заданы настройки, указанные ниже, будет искать метрики в объекте с ID 659ce032cec144058ea7f488:

"parameters": {
    "entity": "objects-659ce032cec144058ea7f488",
    ...
}

position

Object

Позиция виджета в стандартном и подробном виде.

position.height

Integer

Высота виджета.

position.width

Integer

Ширина виджета.

section

String

Тип секции, отображаемой на виджете. Доступные типы – stat, properties, documents, state-history, operations-history.

operation-widget

Виджет Кнопка позволяет отображать в интерфейсе кнопку, которая запускает операцию.

Button Widget
Поле Тип Описание

color

String

Цвет кнопки.

entity

Array<String>

Сущность в которой система будет искать указанную метрику для отображения на виджете. Если это поле пустое, то система будет искать указанную метрику в объекте, к которому привязан этот виджет.

Сущность определяется следующим образом:

<objects|links>-<id>

Например, виджет, у которого заданы настройки, указанные ниже, будет искать метрики в объекте с ID 659ce032cec144058ea7f488:

"parameters": {
    "entity": "objects-659ce032cec144058ea7f488",
    ...
}

operation

String

ID операции. Операция будет выполнена при нажатию на кнопку.

operationCaption

String

Подпись операции.

position

Object

Позиция виджета в стандартном и подробном виде.

position.height

Integer

Высота виджета.

position.width

Integer

Ширина виджета.

iframe

Виджет iframe позволяет встраивать контент с других веб сайтов в пользовательский интерфейс.

IFrame Widget
Поле Тип Описание

entity

Array<String>

Сущность в которой система будет искать указанную метрику для отображения на виджете. Если это поле пустое, то система будет искать указанную метрику в объекте, к которому привязан этот виджет.

Сущность определяется следующим образом:

<objects|links>-<id>

Например, виджет, у которого заданы настройки, указанные ниже, будет искать метрики в объекте с ID 659ce032cec144058ea7f488:

"parameters": {
    "entity": "objects-659ce032cec144058ea7f488",
    ...
}

src

String

URL страницы, показываемой в iframe.

type

String

MIME тип данных, показываемых в iframe.

position

Object

Позиция виджета в стандартном и подробном виде.

position.height

Integer

Высота виджета.

position.width

Integer

Ширина виджета.