21 饼图
描述
这些参数以及相应仪表板小部件字段对象的可选属性值，可用于在 dashboard.create 和 dashboard.update 方法中配置饼图小部件。
在创建或更新仪表板期间，不会验证小部件 fields 属性。
这使用户能够修改内置小部件并创建自定义小部件，但也会带来错误创建或更新小部件的风险。
为确保成功创建或更新饼图小部件，请参阅下表中列出的参数行为。
参数
饼图组件支持以下参数：
| 参数 | 类型 | 参数名称 | 参数值或参数说明 |
|---|---|---|---|
| 刷新频率 | 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 | Item ID。 在模板仪表板上配置该小部件时，只应设置模板上已配置的监控项。 注意：要配置多个监控项，请为每个监控项创建一个仪表板小部件字段对象，并在属性名称中使用递增的编号。 参数行为： - 如果 数据集类型 设置为“监控项列表”且未设置 监控项（小部件），则为 必需 |
|
| 监控项（小部件） | 1 | ds.0.itemids.0._reference | 用于代替 Item ID：ABCDE._itemid - 将一个兼容的小部件（其 Reference 参数设置为 "ABCDE"）设置为监控项的数据源。注意：要配置多个小部件，请为每个小部件创建一个仪表板小部件字段对象，并在属性名称中使用递增的编号。 参数行为： - 如果 数据集类型 设置为“监控项列表”且未设置 监控项，则为 必需 |
|
| 颜色 | 1 | ds.0.color.0 | 十六进制颜色代码（例如 FF0000）。参数行为： - 如果 数据集类型 设置为“监控项列表”，则为 必需 |
|
| 监控项类型 | 0 | ds.0.type.0 | 0 - (默认) 普通； 1 - 总计。 值“总计”在整个图表中只能为一个监控项设置。 参数行为： - 如果 数据集类型 设置为“监控项列表”，则 支持 |
|
| 主机模式 | 1 | ds.0.hosts.0 | Host 名称或模式（例如，“Zabbix*”）。 参数行为： - 如果 数据集类型 设置为“监控项模式”，则为 必需 如果在模板仪表板上配置该小部件，则不支持此参数。 |
|
| 监控项模式 | 1 | ds.0.items.0 | Item 名称或模式（例如，“*: 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 | 任意字符串值。 注意：属性名称中的数字表示标签评估列表中的标签顺序。 参数行为： - 如果配置 监控项标签，则为 必需 |
|
显示选项
以下参数支持用于配置显示选项。
| Parameter | 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 等）中的有效时间字符串。参数行为： - 如果未设置 时间段，则 supported - 如果设置了 time_period.to，则 required |
|
| To | 1 | time_period.to | 绝对（YYYY-MM-DD hh:mm:ss）或相对时间语法（now、now/d、now/w-1w 等）中的有效时间字符串。参数行为： - 如果未设置 时间段，则 supported - 如果设置了 time_period.from，则 required |
|
图例
配置 图例 时，支持以下参数：
| 参数 | 类型 | 参数名称 | 参数值或参数说明 |
|---|---|---|---|
| 显示图例 | 0 | 图例 | 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。 参数行为： - 支持 (如果 显示图例 设置为 "启用" 并且 Show value 设置为 "禁用")。 |
示例
以下示例仅用于介绍如何在仪表盘组件字段对象中配置 饼图 组件. 更多信息，请参考 创建仪表盘。
配置 饼图 部件
按以下方式配置 饼图 部件：
- 在 1 台主机上为总计 9 个监控项配置 2 个数据集。
- 第一个数据集的类型为“监控项列表”，由 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
}