21 Круговая диаграмма
Описание
Эти параметры и возможные значения свойств для соответствующих объектов полей виджета позволяют настраивать виджет Круговая диаграмма в методах dashboard.create и dashboard.update.
Свойства fields виджета не проверяются при создании или обновлении панели.
Это позволяет пользователям изменять встроенные виджеты и создавать пользовательские виджеты, но также создает риск некорректного создания или обновления виджетов.
Чтобы обеспечить успешное создание или обновление виджета Круговая диаграмма, ознакомьтесь с поведением параметров, описанным в таблицах ниже.
Параметры
Для виджета Круговая диаграмма поддерживаются следующие параметры.
| Параметр | type | name | value |
|---|---|---|---|
| Интервал обновления | 0 | rf_rate | 0 - Без обновления; 10 - 10 секунд; 30 - 30 секунд; 60 - (по умолчанию) 1 минута; 120 - 2 минуты; 600 - 10 минут; 900 - 15 минут. |
Набор данных
Для настройки набора данных поддерживаются следующие параметры.
Первое число в имени свойства (например, ds.0.hosts.0, ds.0.items.0) обозначает конкретный набор данных, а второе число, если оно присутствует, обозначает настроенный узел сети или элемент данных.
| Параметр | type | name | value | |
|---|---|---|---|---|
| Тип набора данных | 0 | ds.0.dataset_type | 0 - Список элементов данных; 1 - (по умолчанию) Шаблоны элементов данных. |
|
| Элементы данных | 4 | ds.0.itemids.0 | ID элемента данных. При настройке виджета на панели шаблона следует указывать только элементы данных, настроенные в шаблоне. Примечание: Чтобы настроить несколько элементов данных, создайте объект поля виджета панели для каждого элемента данных с увеличивающимся номером в имени свойства. Поведение параметра: - обязателен, если Тип набора данных установлен в значение "Список элементов данных" и Элементы данных (Виджет) не задан |
|
| Элементы данных (Виджет) | 1 | ds.0.itemids.0._reference | Вместо ID элемента данных:ABCDE._itemid — укажите совместимый виджет (с параметром Reference, установленным в "ABCDE") в качестве источника данных для элементов данных.Примечание: Чтобы настроить несколько виджетов, создайте объект поля виджета панели для каждого виджета с увеличивающимся номером в имени свойства. Поведение параметра: - обязателен, если Тип набора данных установлен в значение "Список элементов данных" и Элементы данных не заданы |
|
| Цвет | 1 | ds.0.color.0 | Шестнадцатеричный код цвета (например, FF0000).Поведение параметра: - обязателен, если Тип набора данных установлен в значение "Список элементов данных" |
|
| Тип элемента данных | 0 | ds.0.type.0 | 0 - (по умолчанию) Обычный; 1 - Итого. Значение "Итого" можно установить только для одного элемента данных во всей диаграмме. Поведение параметра: - поддерживается, если Тип набора данных установлен в значение "Список элементов данных" |
|
| Шаблоны узлов сети | 1 | ds.0.hosts.0 | Имя узла сети или шаблон (например, "Zabbix*"). Поведение параметра: - обязателен, если Тип набора данных установлен в значение "Шаблоны элементов данных" Этот параметр не поддерживается при настройке виджета на панели шаблона. |
|
| Шаблоны элементов данных | 1 | ds.0.items.0 | Имя элемента данных или шаблон (например, "*: Number of processed *values per second"). При настройке виджета на панели шаблона следует указывать только шаблоны для элементов данных, настроенных в шаблоне. Поведение параметра: - обязателен, если Тип набора данных установлен в значение "Шаблоны элементов данных" |
|
| Цвет | 1 | ds.0.color | Шестнадцатеричный код цвета (например, FF0000).Поведение параметра: - поддерживается, если Тип набора данных установлен в значение "Шаблоны элементов данных" и Палитра цветов не задана |
|
| Палитра цветов | 0 | ds.0.color_palette | Индекс палитры цветов. Возможные значения: от 0 до 11. По умолчанию: 0. Поведение параметра: - поддерживается, если Тип набора данных установлен в значение "Шаблоны элементов данных" и Цвет не задан |
|
| Функция агрегации | 0 | ds.0.aggregate_function | 1 - min; 2 - max; 3 - avg; 4 - count; 5 - sum; 6 - first; 7 - (по умолчанию) last. |
|
| Агрегация набора данных | 0 | ds.0.dataset_aggregation | 0 - (по умолчанию) нет; 1 - min; 2 - max; 3 - avg; 4 - count; 5 - sum. Поведение параметра: - поддерживается, если Тип элемента данных установлен в значение "Итого" |
|
| Метка набора данных | 1 | ds.0.data_set_label | Любое строковое значение. По умолчанию: "" (пусто). |
|
| Теги элементов данных | ||||
| Тип вычисления | 0 | ds.0.item_tags_evaltype | 0 - (по умолчанию) And/Or; 2 - Or. |
|
| Имя тега | 1 | ds.0.item_tags.0.tag | Любое строковое значение. Примечание: Число в имени свойства указывает на порядок тега в списке вычисления тегов. Поведение параметра: - обязателен, если настраиваются Теги элементов данных |
|
| Оператор | 0 | ds.0.item_tags.0.operator | 0 - Содержит; 1 - Равно; 2 - Не содержит; 3 - Не равно; 4 - Существует; 5 - Не существует. Примечание: Число в имени свойства указывает на порядок тега в списке вычисления тегов. Поведение параметра: - обязателен, если настраиваются Теги элементов данных |
|
| Значение тега | 1 | ds.0.item_tags.0.value | Любое строковое значение. Примечание: Число в имени свойства указывает на порядок тега в списке вычисления тегов. Поведение параметра: - обязателен, если настраиваются Теги элементов данных |
|
Параметры отображения
Для настройки Параметров отображения поддерживаются следующие параметры.
| Параметр | type | name | value | |
|---|---|---|---|---|
| Выбор исторических данных | 0 | source | 0 - (по умолчанию) Авто; 1 - История; 2 - Тренды. |
|
| Отрисовка | 0 | draw_type | 0 - (по умолчанию) Круговая; 1 - Кольцевая. |
|
| Ширина | 0 | width | 20 - 20% от радиуса; 30 - 30% от радиуса; 40 - 40% от радиуса; 50 - (по умолчанию) 50% от радиуса. Поведение параметра: - поддерживается, если для Отрисовка установлено значение "Кольцевая" |
|
| Ширина обводки | 0 | stroke | Допустимые значения: от 0 до 10. По умолчанию: 0. Поведение параметра: - поддерживается, если для Отрисовка установлено значение "Кольцевая" |
|
| Показывать суммарное значение | 0 | total_show | 0 - (по умолчанию) Отключено; 1 - Включено. Поведение параметра: - поддерживается, если для Отрисовка установлено значение "Кольцевая" |
|
| Размер | 0 | value_size_type | 0 - (по умолчанию) Авто; 1 - Пользовательский. Поведение параметра: - поддерживается, если для Показывать суммарное значение установлено значение "Включено" |
|
| Размер (значение для пользовательского размера) | 0 | value_size | Допустимые значения: от 1 до 100. По умолчанию: 20. Поведение параметра: - поддерживается, если для Показывать суммарное значение установлено значение "Включено" |
|
| Количество десятичных знаков | 0 | decimal_places | Допустимые значения: от 0 до 6. По умолчанию: 2. Поведение параметра: - поддерживается, если для Показывать суммарное значение установлено значение "Включено" |
|
| Единицы измерения (флажок) | 0 | units_show | 0 - (по умолчанию) Отключено; 1 - Включено. Поведение параметра: - поддерживается, если для Показывать суммарное значение установлено значение "Включено" |
|
| Единицы измерения (значение) | 1 | units | Любое строковое значение. Поведение параметра: - поддерживается, если для Единицы измерения (флажок) установлено значение "Включено" |
|
| Жирный | 0 | value_bold | 0 - (по умолчанию) Отключено; 1 - Включено. Поведение параметра: - поддерживается, если для Показывать суммарное значение установлено значение "Включено" |
|
| Цвет | 1 | value_color | Шестнадцатеричный код цвета (например, FF0000).Поведение параметра: - поддерживается, если для Показывать суммарное значение установлено значение "Включено" |
|
| Промежуток между секторами | 0 | space | Допустимые значения: от 0 до 10. По умолчанию: 1. |
|
| Объединять сектора меньше N% (флажок) | 0 | merge | 0 - (по умолчанию) Отключено; 1 - Включено. |
|
| Объединять сектора меньше N% (значение) | 0 | merge_percent | Допустимые значения: от 1 до 10. По умолчанию: 1. Поведение параметра: - поддерживается, если для Объединять сектора меньше N% (флажок) установлено значение "Включено" |
|
| Объединять сектора меньше N% (цвет) | 1 | merge_color | Шестнадцатеричный код цвета (например, FF0000).Поведение параметра: - поддерживается, если для Объединять сектора меньше N% (флажок) установлено значение "Включено" |
|
Период времени
Для настройки Периода времени поддерживаются следующие параметры.
| Параметр | type | name | value | |
|---|---|---|---|---|
| Период времени | 1 | time_period._reference | DASHBOARD._timeperiod — использовать селектор периода времени панели мониторинга в качестве источника данных;ABCDE._timeperiod — использовать совместимый виджет (с параметром Reference, установленным в значение "ABCDE") в качестве источника данных.По умолчанию: DASHBOARD._timeperiodВ качестве альтернативы можно задать период времени только в параметрах From и To. |
|
| From | 1 | time_period.from | Допустимая строка времени в абсолютном (YYYY-MM-DD hh:mm:ss) или относительном формате времени (now, now/d, now/w-1w и т. д.).Поведение параметра: - поддерживается, если Период времени не задан - обязателен, если задан time_period.to |
|
| To | 1 | time_period.to | Допустимая строка времени в абсолютном (YYYY-MM-DD hh:mm:ss) или относительном формате времени (now, now/d, now/w-1w и т. д.).Поведение параметра: - поддерживается, если Период времени не задан - обязателен, если задан time_period.from |
|
Условные обозначения
Для настройки условных обозначений поддерживаются следующие параметры.
| Параметр | type | name | value |
|---|---|---|---|
| Показывать условные обозначения | 0 | legend | 0 - Отключено; 1 - (по умолчанию) Включено. |
| Показывать значение | 0 | legend_value | 0 - (по умолчанию) Отключено; 1 - Включено. Поведение параметра: - поддерживается, если для Показывать условные обозначения установлено значение "Включено" |
| Показывать функцию агрегации | 0 | legend_aggregation | 0 - (по умолчанию) Отключено; 1 - Включено. Поведение параметра: - поддерживается, если для Показывать условные обозначения установлено значение "Включено" |
| Строки | 0 | legend_lines_mode | 0 - (по умолчанию) Фиксированное; 1 - Переменное. Поведение параметра: - поддерживается, если для Показывать условные обозначения установлено значение "Включено" |
| Количество строк/ Максимальное количество строк |
0 | legend_lines | Допустимые значения: 1-10. По умолчанию: 1. Поведение параметра: - поддерживается, если для Показывать условные обозначения установлено значение "Включено" |
| Количество столбцов | 0 | legend_columns | Допустимые значения: 1-4. По умолчанию: 4. Поведение параметра: - поддерживается, если для Показывать условные обозначения установлено значение "Включено", а для Показывать значение установлено значение "Отключено" |
Примеры
Следующие примеры предназначены только для описания настройки объектов полей виджета панели мониторинга Круговая диаграмма.
Для получения дополнительной информации о настройке панели мониторинга см. dashboard.create.
Настройка виджета Круговая диаграмма
Настройте виджет Круговая диаграмма следующим образом:
- 2 набора данных, всего для 9 элементов данных на 1 узле сети.
- Первый набор данных имеет тип "Список элементов данных" и состоит из 3 элементов данных, все они имеют тип "Обычный" и представлены разными цветами.
- Второй набор данных имеет тип "Шаблоны элементов данных", состоит из 6 элементов данных, для каждого элемента данных настроена агрегация, и он представлен пользовательским цветом.
- Второй набор данных также имеет пользовательскую метку набора данных.
- Данные на круговой диаграмме отображаются в виде кольцевой диаграммы с пользовательской шириной и общим значением с единицами измерения в центре.
- Данные на круговой диаграмме отображаются и агрегируются за пользовательский период времени — последние 3 часа.
- Легенда круговой диаграммы отображает настроенные элементы данных в 4 строках.
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "piechart",
"name": "Pie chart",
"x": 0,
"y": 0,
"width": 24,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 0,
"name": "ds.0.dataset_type",
"value": 0
},
{
"type": 4,
"name": "ds.0.itemids.0",
"value": 23264
},
{
"type": 1,
"name": "ds.0.color.0",
"value": "FF0000"
},
{
"type": 0,
"name": "ds.0.type.0",
"value": 0
},
{
"type": 4,
"name": "ds.0.itemids.1",
"value": 23269
},
{
"type": 1,
"name": "ds.0.color.1",
"value": "BF00FF"
},
{
"type": 0,
"name": "ds.0.type.1",
"value": 0
},
{
"type": 4,
"name": "ds.0.itemids.2",
"value": 23257
},
{
"type": 1,
"name": "ds.0.color.2",
"value": "0040FF"
},
{
"type": 0,
"name": "ds.0.type.2",
"value": 0
},
{
"type": 1,
"name": "ds.1.hosts.0",
"value": "Zabbix server"
},
{
"type": 1,
"name": "ds.1.items.0",
"value": "*: Number of processed *values per second"
},
{
"type": 1,
"name": "ds.1.color",
"value": "000000"
},
{
"type": 0,
"name": "ds.1.aggregate_function",
"value": 3
},
{
"type": 1,
"name": "ds.1.data_set_label",
"value": "Number of processed values per second"
},
{
"type": 0,
"name": "draw_type",
"value": 1
},
{
"type": 0,
"name": "width",
"value": 30
},
{
"type": 0,
"name": "total_show",
"value": 1
},
{
"type": 0,
"name": "units_show",
"value": 1
},
{
"type": 0,
"name": "graph_time",
"value": 1
},
{
"type": 1,
"name": "time_period.from",
"value": "now-3h"
},
{
"type": 1,
"name": "time_period.to",
"value": "now"
},
{
"type": 0,
"name": "legend_lines",
"value": 4
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}
Ответ:
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}