10 图形原型

描述

这些参数以及相应仪表板小部件字段对象的可选属性值，可用于在 dashboard.create 和 dashboard.update 方法中配置 图形原型 小部件。

在创建或更新仪表板期间，不会验证小部件 fields 属性。 这使用户能够修改内置小部件并创建自定义小部件，但也会带来错误创建或更新小部件的风险。 为确保成功创建或更新 图形原型 小部件，请参阅下表中列出的参数行为。

参数

以下参数适用于 图形原型 部件。

参数 type name value
刷新间隔 0 rf_rate 0 - 不刷新；
10 - 10 秒；
30 - 30 秒；
60 - (默认) 1 分钟；
120 - 2 分钟；
600 - 10 分钟；
900 - 15 分钟。
来源 0 source_type 2 - (默认) 图形原型；
3 - 简单图形原型。
图形原型 7 graphid.0 图形原型 ID。

参数行为：
- 如果 来源 设置为“图形原型”，则为 必需
监控项原型 5 itemid.0 监控项原型 ID。

参数行为：
- 如果 来源 设置为“简单图形原型”，则为 必需
时间段 1 time_period._reference DASHBOARD._timeperiod - 将仪表板时间段选择器设置为数据源；
ABCDE._timeperiod - 将兼容部件（其 引用 参数设置为“ABCDE”）设置为数据源。

默认值：DASHBOARD._timeperiod

或者，也可以仅在 从 和 到 参数中设置时间段。
从 1 time_period.from 绝对时间（YYYY-MM-DD hh:mm:ss）或相对时间语法（now、now/d、now/w-1w 等）中的有效时间字符串。

参数行为：
- 当 时间段 未设置时，支持
- 如果设置了 time_period.to，则为 必需
到 1 time_period.to 绝对时间（YYYY-MM-DD hh:mm:ss）或相对时间语法（now、now/d、now/w-1w 等）中的有效时间字符串。

参数行为：
- 当 时间段 未设置时，支持
- 如果设置了 time_period.from，则为 必需
显示图例 0 show_legend 0 - 禁用；
1 - (默认) 启用。
覆盖主机 1 override_hostid._reference ABCDE._hostid - 将兼容部件（其 引用 参数设置为“ABCDE”）设置为主机的数据源；
DASHBOARD._hostid - 将仪表板主机选择器设置为主机的数据源。

如果在模板仪表板上配置该部件，则不支持此参数。
列数 0 columns 可能的值范围为 1-24。

默认值：2。
行数 0 rows 可能的值范围为 1-16。

默认值：1。
引用 1 reference 由 5 个字符组成的任意字符串值（例如 ABCDE 或 JBPNL）。该值在部件所属的仪表板内必须唯一。

参数行为：
- 必需

示例

以下示例仅用于介绍如何在仪表盘组件字段对象中配置 图表原型组件。 更多信息，请参考 创建仪表盘。

配置一个图表原型组件

配置一个图表原型组件，用于展示由低级别自动发现的监控项目原型 (ID: "42316") 创建的图表，同时设置布局为 3 个图表(即 3 列，1行)。

请求:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "graphprototype",
                        "name": "Graph prototype",
                        "x": 0,
                        "y": 0,
                        "width": 48,
                        "height": 5,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 0,
                                "name": "source_type",
                                "value": 3
                            },
                            {
                                "type": 5,
                                "name": "itemid.0",
                                "value": 42316
                            },
                            {
                                "type": 0,
                                "name": "columns",
                                "value": 3
                            },
                            {
                                "type": 1,
                                "name": "reference",
                                "value": "OPQWX"
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

响应：

{
    "jsonrpc": "2.0",
    "result": {
        "dashboardids": [
            "3"
        ]
    },
    "id": 1
}

参考