[comment]: # ({7a3d2bf9-70237fe9})
# 11 Honeycomb

[comment]: # ({/7a3d2bf9-70237fe9})

[comment]: # ({19fe6913-24cd2015})
### 说明

各个仪表盘组件字段对象中的这些参数和可用属性值允许在`dashboard.create` 和 `dashboard.update` 方法中配置[*蜂窝图*](/manual/web_interface/frontend_sections/dashboards/widgets/honeycomb)组件。

::: noteimportant
在创建或更新仪表盘期间不会验证组件的 `fields` 属性。
这个方法允许用户修改[内置组件](/manual/web_interface/frontend_sections/dashboards/widgets)和创建[自定义组件](/devel/modules/tutorials/widget)，但也会导致存在错误创建或更新组件的风险。
为确保成功创建或更新*蜂窝图*组件，请参阅下表中概述的参数行为。
:::

[comment]: # ({/19fe6913-24cd2015})

[comment]: # ({082a0ee8-7a40ed57})
### 参数

以下参数适用于 *Honeycomb* 部件。

|参数|<|[type](/manual/api/reference/dashboard/object#dashboard-widget-field)|名称|值|
|-|--------|--|--------|-------------------------------|
|*刷新间隔*|<|0|rf_rate|0 - 不刷新；<br>10 - 10 秒；<br>30 - 30 秒；<br>60 - *(默认)* 1 分钟；<br>120 - 2 分钟；<br>600 - 10 分钟；<br>900 - 15 分钟。|
|*主机组*|<|2|groupids.0|[主机组](/manual/api/reference/hostgroup/get) ID。<br><br>注意：要配置多个主机组，请为每个主机组创建一个仪表板部件字段对象，并在属性名称中使用递增的编号。<br><br>如果在[模板仪表板](/manual/api/reference/templatedashboard/object)上配置该部件，则不支持此参数。|
|<|*主机组（部件）*|1|groupids.\_reference|用于代替 [主机组](/manual/api/reference/hostgroup/get) ID：<br>`ABCDE._hostgroupids` - 将[兼容部件](/manual/web_interface/frontend_sections/dashboards/widgets#widget-compatibility)（其 *Reference* 参数设置为 "`ABCDE`"）设为主机组的数据源。<br><br>如果在[模板仪表板](/manual/api/reference/templatedashboard/object)上配置该部件，则不支持此参数。|
|*主机*|<|3|hostids.0|[主机](/manual/api/reference/host/get) ID。<br><br>注意：要配置多个主机，请为每个主机创建一个仪表板部件字段对象，并在属性名称中使用递增的编号。对于多个主机，参数 *主机组* 必须要么完全不配置，要么至少配置一个包含所配置主机的主机组。<br><br>如果在[模板仪表板](/manual/api/reference/templatedashboard/object)上配置该部件，则不支持此参数。|
|<|*主机（部件/仪表板）*|1|hostids.\_reference|用于代替 [主机](/manual/api/reference/host/get) ID：<br>`DASHBOARD.hostids` - 将仪表板[主机选择器](/manual/web_interface/frontend_sections/dashboards/widgets#override-host)设为主机的数据源；<br>`ABCDE._hostids` - 将[兼容部件](/manual/web_interface/frontend_sections/dashboards/widgets#widget-compatibility)（其 *Reference* 参数设置为 "`ABCDE`"）设为主机的数据源。<br><br>如果在[模板仪表板](/manual/api/reference/templatedashboard/object)上配置该部件，则不支持此参数。|
|*主机标签*|<|<|<|<|
|<|*评估类型*|0|evaltype_host|0 - *(默认)* And/Or；<br>2 - Or。<br><br>如果在[模板仪表板](/manual/api/reference/templatedashboard/object)上配置该部件，则不支持此参数。|
|^|*标签名称*|1|host_tags.0.tag|任意字符串值。<br><br>注意：属性名称中的数字表示标签评估列表中的标签顺序。<br><br>[参数行为](/manual/api/reference_commentary#parameter-behavior)：<br>- 如果配置了 *主机标签*，则为 *必填*<br><br>如果在[模板仪表板](/manual/api/reference/templatedashboard/object)上配置该部件，则不支持此参数。|
|^|*运算符*|0|host_tags.0.operator|0 - 包含；<br>1 - 等于；<br>2 - 不包含；<br>3 - 不等于；<br>4 - 存在；<br>5 - 不存在。<br><br>注意：属性名称中的数字表示标签评估列表中的标签顺序。<br><br>[参数行为](/manual/api/reference_commentary#parameter-behavior)：<br>- 如果配置了 *主机标签*，则为 *必填*<br><br>如果在[模板仪表板](/manual/api/reference/templatedashboard/object)上配置该部件，则不支持此参数。|
|^|*标签值*|1|host_tags.0.value|任意字符串值。<br><br>注意：属性名称中的数字表示标签评估列表中的标签顺序。<br><br>[参数行为](/manual/api/reference_commentary#parameter-behavior)：<br>- 如果配置了 *主机标签*，则为 *必填*<br><br>如果在[模板仪表板](/manual/api/reference/templatedashboard/object)上配置该部件，则不支持此参数。|
|*监控项模式*|<|1|items.0|[监控项](/manual/api/reference/item/get)名称或模式。<br><br>注意：要配置多个监控项模式，请为每个监控项模式创建一个仪表板部件字段对象，并在属性名称中使用递增的编号。<br><br>[参数行为](/manual/api/reference_commentary#parameter-behavior)：<br>- *必填*|
|*监控项标签*|<|<|<|<|
|<|*评估类型*|0|evaltype_item|0 - *(默认)* And/Or；<br>2 - Or。|
|^|*标签名称*|1|item_tags.0.tag|任意字符串值。<br><br>注意：属性名称中的数字表示标签评估列表中的标签顺序。<br><br>[参数行为](/manual/api/reference_commentary#parameter-behavior)：<br>- 如果配置了 *监控项标签*，则为 *必填*|
|^|*运算符*|0|item_tags.0.operator|0 - 包含；<br>1 - 等于；<br>2 - 不包含；<br>3 - 不等于；<br>4 - 存在；<br>5 - 不存在。<br><br>注意：属性名称中的数字表示标签评估列表中的标签顺序。<br><br>[参数行为](/manual/api/reference_commentary#parameter-behavior)：<br>- 如果配置了 *监控项标签*，则为 *必填*|
|^|*标签值*|1|item_tags.0.value|任意字符串值。<br><br>注意：属性名称中的数字表示标签评估列表中的标签顺序。<br><br>[参数行为](/manual/api/reference_commentary#parameter-behavior)：<br>- 如果配置了 *监控项标签*，则为 *必填*|
|*显示维护中的主机*|<|0|maintenance|0 - *(默认)* 禁用；<br>1 - 启用。|
|*显示*|<|0|show.0|1 - 主标签；<br>2 - 次标签。<br><br>注意：要配置多个值，请为每个值创建一个仪表板部件字段对象，并在属性名称中使用递增的编号。<br><br>默认值：1, 2。|
|*Reference*|<|1|reference|由 5 个字符组成的任意字符串值（例如 `ABCDE` 或 `JBPNL`）。该值在部件所属的仪表板内必须唯一。<br><br>[参数行为](/manual/api/reference_commentary#parameter-behavior)：<br>- *必填*|

[comment]: # ({/082a0ee8-7a40ed57})

[comment]: # ({aaafe403-d25c8205})
#### 高级配置

以下高级配置参数适用于 *Honeycomb* 部件。

::: noteclassic
*Thresholds* 属性名称中的数字（例如 thresholds.0.color）表示按升序排序的列表中的阈值位置。
但是，如果阈值按不同顺序配置，则在 Zabbix 前端中更新部件配置后，这些值将按升序排序
（例如，`"thresholds.0.threshold":"5"` → `"thresholds.0.threshold":"1"`；`"thresholds.1.threshold":"1"` → `"thresholds.1.threshold": "5"`）。
:::

|参数|[type](/manual/api/reference/dashboard/object#dashboard-widget-field)|name|value|
|-----|-|-----|-------------------|
|***主标签***|<|<|<|
|*类型*|0|primary_label_type|0 - *(默认)* 文本；<br>1 - 值。|
|*文本*|1|primary_label|任意字符串值，包括宏。<br>支持的宏：{HOST.\*}、{ITEM.\*}、{INVENTORY.\*}、用户宏。<br><br>默认值：{HOST.NAME}<br><br>[参数行为](/manual/api/reference_commentary#parameter-behavior)：<br>- 当 *类型* 设置为“文本”时，*支持*|
|*小数位数*|0|primary_label_decimal_places|可选值范围为 0-6。<br><br>默认值：2。<br><br>[参数行为](/manual/api/reference_commentary#parameter-behavior)：<br>- 当 *类型* 设置为“值”时，*支持*|
|*大小*（类型）|0|primary_label_size_type|0 - *(默认)* 自动；<br>1 - 自定义。|
|*大小*|0|primary_label_size|可选值范围为 1-100。<br><br>默认值：20。<br><br>[参数行为](/manual/api/reference_commentary#parameter-behavior)：<br>- 当 *大小*（类型）设置为“自定义”时，*支持*|
|*加粗*|0|primary_label_bold|0 - *(默认)* 禁用；<br>1 - 启用。|
|*颜色*|1|primary_label_color|十六进制颜色代码（例如 `FF0000`）。<br><br>默认值：基于 [Settings object](/manual/api/reference/settings/object#settings) 和 [User object](/manual/api/reference/user/object#user) 的 `theme`：<br>“blue-theme”、“blue-classic-theme” 或 “hc-light” 为 `1F2C33`；<br>“dark-theme”、“dark-classic-theme” 或 “hc-dark” 为 `EEEEEE`。|
|*单位*（复选框）|0|primary_label_units_show|0 - 禁用；<br>1 - *(默认)* 启用。<br><br>[参数行为](/manual/api/reference_commentary#parameter-behavior)：<br>- 当 *类型* 设置为“值”时，*支持*|
|*单位*（值）|1|primary_label_units|任意字符串值。<br><br>`""`（空）<br><br>[参数行为](/manual/api/reference_commentary#parameter-behavior)：<br>- 当 *类型* 设置为“值”且 *单位*（复选框）设置为“启用”时，*支持*|
|*位置*|0|primary_label_units_pos|0 - 值前；<br>1 - *(默认)* 值后。<br><br>[参数行为](/manual/api/reference_commentary#parameter-behavior)：<br>- 当 *类型* 设置为“值”且 *单位*（复选框）设置为“启用”时，*支持*<br><br>如果设置为以下[时间相关单位](/manual/config/items/item#configuration)之一，则忽略此参数：unixtime、uptime、s。|
|***次标签***|<|<|<|
|*类型*|0|secondary_label_type|0 - 文本；<br>1 - *(默认)* 值。|
|*文本*|1|secondary_label|任意字符串值，包括宏。<br>支持的宏：{HOST.\*}、{ITEM.\*}、{INVENTORY.\*}、用户宏。<br><br>默认值：{{ITEM.LASTVALUE}.fmtnum(2)}<br><br>[参数行为](/manual/api/reference_commentary#parameter-behavior)：<br>- 当 *类型* 设置为“文本”时，*支持*|
|*小数位数*|0|secondary_label_decimal_places|可选值范围为 0-6。<br><br>默认值：2。<br><br>[参数行为](/manual/api/reference_commentary#parameter-behavior)：<br>- 当 *类型* 设置为“值”时，*支持*|
|*大小*（类型）|0|secondary_label_size_type|0 - *(默认)* 自动；<br>1 - 自定义。|
|*大小*|0|secondary_label_size|可选值范围为 1-100。<br><br>默认值：30。<br><br>[参数行为](/manual/api/reference_commentary#parameter-behavior)：<br>- 当 *大小*（类型）设置为“自定义”时，*支持*|
|*加粗*|0|secondary_label_bold|0 - 禁用；<br>1 - *(默认)* 启用。|
|*颜色*|1|secondary_label_color|十六进制颜色代码（例如 `FF0000`）。<br><br>默认值：基于 [Settings object](/manual/api/reference/settings/object#settings) 和 [User object](/manual/api/reference/user/object#user) 的 `theme`：<br>“blue-theme”、“blue-classic-theme” 或 “hc-light” 为 `1F2C33`；<br>“dark-theme”、“dark-classic-theme” 或 “hc-dark” 为 `EEEEEE`。|
|*单位*（复选框）|0|secondary_label_units_show|0 - 禁用；<br>1 - *(默认)* 启用。<br><br>[参数行为](/manual/api/reference_commentary#parameter-behavior)：<br>- 当 *类型* 设置为“值”时，*支持*|
|*单位*（值）|1|secondary_label_units|任意字符串值。<br><br>`""`（空）<br><br>[参数行为](/manual/api/reference_commentary#parameter-behavior)：<br>- 当 *类型* 设置为“值”且 *单位*（复选框）设置为“启用”时，*支持*|
|*位置*|0|secondary_label_position|0 - 值前；<br>1 - *(默认)* 值后。<br><br>[参数行为](/manual/api/reference_commentary#parameter-behavior)：<br>- 当 *类型* 设置为“值”且 *单位*（复选框）设置为“启用”时，*支持*<br><br>如果设置为以下[时间相关单位](/manual/config/items/item#configuration)之一，则忽略此参数：unixtime、uptime、s。|
|***背景颜色***|<|<|<|
|*背景颜色*|1|bg_color|十六进制颜色代码（例如 `FF0000`）。<br><br>默认值：基于 [Settings object](/manual/api/reference/settings/object#settings) 和 [User object](/manual/api/reference/user/object#user) 的 `theme`：<br>“blue-theme”和“blue-classic-theme”为 `D9E7ED`；<br>“dark-theme”和“dark-classic-theme”为 `3D5059`；<br>“hc-light”为 `AAD7E9`；<br>“hc-dark”为 `335463`。|
|***阈值***|<|<|<|
|*颜色插值*|0|interpolation|0 - 禁用；<br>1 - *(默认)* 启用。|
|*颜色*|1|thresholds.0.color|十六进制颜色代码（例如 `FF0000`）。|
|*阈值*|1|thresholds.0.threshold|任意数值。支持[后缀](/manual/appendix/suffixes)（例如 “1d”、“2w”、“4K”、“8G”）。|

[comment]: # ({/aaafe403-d25c8205})

[comment]: # ({05e301d7-c6f49883})
### 示例

以下示例仅用于介绍如何在仪表盘组件字段对象中配置 *蜂窝图* 组件。
更多信息，请参考 [创建仪表盘](/manual/api/reference/dashboard/create)。

[comment]: # ({/05e301d7-c6f49883})

[comment]: # ({18033898-0cace4a6})
#### 配置一个*蜂窝图*组件

配置一个*蜂窝图*组件，用于展示Zabbix server进程使用率，此外，更改蜂窝单元的主要标签，并使用阈值对组件进行视觉微调。

[请求](/manual/api#执行请求):

```json
{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": "30",
        "auto_start": "1",
        "pages": [
            {
                "widgets": [
                    {
                        "type": "honeycomb",
                        "name": "Honeycomb",
                        "x": "0",
                        "y": "0",
                        "width": "24",
                        "height": "5",
                        "view_mode": "0",
                        "fields": [
                            {
                                "type": 2,
                                "name": "groupids.0",
                                "value": 4
                            },
                            {
                                "type": 3,
                                "name": "hostids.0",
                                "value": 10084
                            },
                            {
                                "type": 1,
                                "name": "items.0",
                                "value": "Zabbix server: Utilization*"
                            },
                            {
                                "type": 1,
                                "name": "primary_label",
                                "value": "{ITEM.NAME}"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.0.color",
                                "value": "0EC9AC"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.0.threshold",
                                "value": "0"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.1.color",
                                "value": "FFD54F"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.1.threshold",
                                "value": "70"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.2.color",
                                "value": "FF465C"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.2.threshold",
                                "value": "90"
                            },
                            {
                                "type": 1,
                                "name": "reference",
                                "value": "KSTMQ"
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}
```

响应：

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

[comment]: # ({/18033898-0cace4a6})

[comment]: # ({e9d30322-b52eec61})
### 参考

-   [仪表盘组件字段](/manual/api/reference/dashboard/object#仪表盘组件字段)
-   [创建仪表盘](/manual/api/reference/dashboard/create)
-   [更新仪表盘](/manual/api/reference/dashboard/update)

[comment]: # ({/e9d30322-b52eec61})
