[comment]: # ({d8592bb6-70237fe9})
# 12 蜂窝结构

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

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

这些参数以及相应仪表板 widget 字段的可能属性值 objects 可用于配置
[*Honeycomb*](/manual/web_interface/frontend_sections/dashboards/widgets/honeycomb) widget 在 `dashboard.create` 和 `dashboard.update` 方法中。

::: noteimportant
widget `fields` 属性在仪表板创建或 update 期间不会被验证。
这允许用户修改 [built-in widgets](/manual/web_interface/frontend_sections/dashboards/widgets) 和 create [custom widgets](/devel/modules/tutorials/widget)，但也存在创建或更新部件不正确的风险。
为确保成功创建或 update *Honeycomb* 部件，请参考下表中列出的参数行为。
:::

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

[comment]: # ({03089a26-7a40ed57})
### 参数

*Honeycomb*小组件支持以下参数。

| 参数 | <   | [仪表板小部件字段](/manual/api/reference/dashboard/object#仪表板小部件字段) | 名称 | 值 |
|-|--------|--|--------|-------------------------------|
| *Refresh interval* | <   | 0 | rf_rate | 0 - 无刷新；<br>10 - 10 秒；<br>30 - 30 秒；<br>60 - *(默认)* 1 分钟；<br>120 - 2 分钟；<br>600 - 10 分钟；<br>900 - 15 分钟。 |
| *Host groups* | <   | 2 | groupids.0 | [Host group](/manual/api/reference/hostgroup/get) ID。<br><br>注意：要配置多个 主机 组，需为每个 主机组 使用递增的属性名称 create 仪表板 widget 字段 object。<br><br>如果在 [template dashboard](/manual/api/reference/templatedashboard/object) 上配置 widget，则不支持此参数。
| < | *主机 组（小部件）* | 1 | groupids.\_reference | 无需使用 [Host group](/manual/api/reference/hostgroup/get) ID：<br>`ABCDE._hostgroupids` - 设置一个 [部件兼容性](/manual/web_interface/frontend_sections/dashboards/widgets#部件兼容性)（将其 *Reference* 参数设置为 "`ABCDE`"）作为 主机 组的数据源。<br><br>如果在 [template dashboard](/manual/api/reference/templatedashboard/object) 上配置小get，则不支持此参数。 |
| *Hosts* | <   | 3 | hostids.0 | [Host](/manual/api/reference/host/get) ID。<br><br>注意：要配置多个 主机，请 create 一个仪表板 widget 字段 object，并为每个 主机 在属性名称中使用递增的编号。<br><br>对于多个 主机，参数 *主机 组* 必须要么完全不配置，要么至少配置一个 主机组，且该组必须包含所配置的 主机。<br><br>如果在 [template dashboard](/manual/api/reference/templatedashboard/object) 上配置 widget，则不支持此参数。 |
| < | *主机（Widget/Dashboard）* | 1 | hostids.\_reference | 无需使用 [Host](/manual/api/reference/host/get) ID：<br>`DASHBOARD.hostids` - 将 [覆盖主机](/manual/web_interface/frontend_sections/dashboards/widgets#覆盖主机) 设置为 主机 的数据源；<br>`ABCDE._hostids` - 将一个 [部件兼容性](/manual/web_interface/frontend_sections/dashboards/widgets#部件兼容性)（将其 *Reference* 参数设置为 "`ABCDE`"）设置为 主机 的数据源。<br><br>如果在 [template dashboard](/manual/api/reference/templatedashboard/object) 上配置 widget，则不支持此参数。 |
| *Host tags* | <   | < | < | <     |
| < | *评估类型* | 0 | evaltype_host | 0 - *(默认)* And/Or;<br>2 - Or。<br><br>如果在[template dashboard](/manual/api/reference/templatedashboard/object)上配置widget，则不支持此参数。 |
| ^ | *标签名称* | 1 | host_tags.0.tag | 任意 string 值。<br><br>注意：属性名称中的数字表示标签在标签评估列表中的顺序。<br><br>[参数行为](/manual/api/reference_commentary#参数行为):<br>- 在配置 *主机 标签* 时为必填项<br><br>如果在 [template dashboard](/manual/api/reference/templatedashboard/object) 上配置 widget，则不支持此参数。 |
| ^ | *操作符* | 0 | host_tags.0.operator | 0 - 包含;<br>1 - 等于;<br>2 - 不包含;<br>3 - 不等于;<br>4 - 存在;<br>5 - 不存在。<br><br>注意：属性名称中的数字引用标签评估列表中的标签顺序。<br><br>[参数行为](/manual/api/reference_commentary#参数行为):<br>- 如果配置 *主机 标签* 则为必填项<br><br>如果在 [template dashboard](/manual/api/reference/templatedashboard/object) 上配置 widget，则不支持此参数。 |
| ^ | *标签值* | 1 | host_tags.0.value | 任意 string 值。<br><br>注意：属性名称中的数字表示标签评估列表中的标签顺序。<br><br>[参数行为](/manual/api/reference_commentary#参数行为):<br>- 在配置 *主机 标签* 时为必填项<br><br>在配置 widget 于 [template dashboard](/manual/api/reference/templatedashboard/object) 上时不支持此参数。 |
| *Item patterns* | <   | 1 | items.0 | [Item](/manual/api/reference/item/get) 名称或模式。<br><br>注意：要配置多个 监控项 模式，每个 监控项 模式需使用属性名称中递增的编号，create 仪表板 widget 字段 object。<br><br>[参数行为](/manual/api/reference_commentary#参数行为):<br>- *必填* |
| *Item tags* | <   | < | < | <     |
| < | *评估类型* | 0 | evaltype_item | 0 - *(默认)* And/Or;<br>2 - Or。 |
| ^ | *标签名称* | 1 | item_tags.0.tag | 任意 string 值。<br><br>注意：属性名称中的数字引用的是标签评估列表中的标签顺序。<br><br>[参数行为](/manual/api/reference_commentary#参数行为):<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#参数行为):<br>- 如果配置 *监控项标签* 则为必填项。|
| ^ | *标签值* | 1 | item_tags.0.value | 任意 string 值。<br><br>注意：属性名称中的数字引用了标签评估列表中的标签顺序。<br><br>[参数行为](/manual/api/reference_commentary#参数行为)：<br>- 如果配置 *监控项标签* 则为必填项 |
| *Show hosts in maintenance* | <   | 0 | maintenance | 0 - *(默认)* 已禁用；<br>1 - 已启用。 |
| *Show* | <   | 0 | show.0 | 1 - 主标签；<br>2 - 次标签。<br><br>注意：要配置多个值，请create一个仪表板小部件get字段object，并为每个值在属性名称中使用递增的数字。<br><br>默认值：1，2。 |
| *Reference* | <   | 1 | reference | 任何由 5 个字符组成的 string 值（例如 `ABCDE` 或 `JBPNL`）。此值在该 widget 所属的仪表板内必须唯一。<br><br>[参数行为](/manual/api/reference_commentary#参数行为):<br>- *必填* |

[comment]: # ({/03089a26-7a40ed57})

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

*Honeycomb* 部件支持以下高级配置参数。

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

| 参数 | [仪表板小部件字段](/manual/api/reference/dashboard/object#仪表板小部件字段) | 名称 | 值 |
|-----|-|-----|-------------------|
| ***Primary label*** | < | < | <     |
| *Type* | 0 | primary_label_type | 0 - *（默认）* 文本；<br>1 - 数值。 |
| *Text* | 1 | primary_label | 任意string值（可含宏）。<br>支持的宏：{主机.\*}, {监控项.\*}、{INVENTORY.\*}、用户宏。<br><br>默认值：{HOST.NAME}<br><br>[参数行为](/manual/api/reference_commentary#参数行为)：<br>- 当*类型*设为"文本"时*支持*该功能 |
| *Decimal places* | 0 | primary_label_decimal_places | 取值范围为0-6.<br><br>默认值：2.<br><br>[参数行为](/manual/api/reference_commentary#参数行为):<br>- 当*类型*设为"值"时*支持*该功能 |
| *Size* (type) | 0 | primary_label_size_type | 0 - *（默认）* 自动；<br>1 - 自定义。 |
| *Size* | 0 | primary_label_size | 取值范围为1-100。<br><br>默认值：20.<br><br>[参数行为](/manual/api/reference_commentary#参数行为):<br>- 当*Size*（类型）设为"Custom"时*支持*该功能 |
| *Bold* | 0 | primary_label_bold | 0 - *(默认)* 禁用；<br>1 - 启用。 |
| *Color* | 1 | primary_label_color | 十六进制颜色代码（例如 `FF0000`）。<br><br>默认值基于 [设置](/manual/api/reference/settings/object#设置) 和 [User object](/manual/api/reference/user/object#user) 的 `theme`：<br>`1F2C33` 对应 "blue-theme" 或 "hc-light"；<br>`EEEEEE` 对应 "dark-theme" 或 "hc-dark"。 |
| *Units* (checkbox) | 0 | primary_label_units_show | 0 - 已禁用；<br>1 - *（默认）* 已启用。<br><br>[参数行为](/manual/api/reference_commentary#参数行为)：<br>- 当*类型*设为"值"时*支持* |
| *Units* (value) | 1 | primary_label_units | 任意string值。<br><br>`""`（空值）<br><br>[参数行为](/manual/api/reference_commentary#参数行为):<br>- 当*类型*设为"数值"且*单位*（复选框）设为"启用"时*支持*该功能 |
| *Position* | 0 | primary_label_units_pos | 0 - 数值前;<br>1 - *(默认)* 数值后。<br><br>[参数行为](/manual/api/reference_commentary#参数行为):<br>- 当*类型*设为"数值"且*单位*(复选框)设为"启用"时*支持*<br><br>若设为以下[配置](/manual/config/items/item#配置)之一则忽略此参数: unixtime, uptime, s。 |
| ***Secondary label*** | < | < | <     |
| *Type* | 0 | secondary_label_type | 0 - 文本；<br>1 - *（默认）* 值。 |
| *Text* | 1 | secondary_label | 任意string值（支持宏）。<br>支持的宏：{主机.\*}, {监控项.\*}、{INVENTORY.\*}及用户宏。<br><br>默认值：{{ITEM.LASTVALUE}.fmtnum(2)}<br><br>[参数行为](/manual/api/reference_commentary#参数行为):<br>- 当*类型*设为"文本"时*支持*该功能 |
| *Decimal places* | 0 | secondary_label_decimal_places | 取值范围为 0-6.<br><br>默认值：2.<br><br>[参数行为](/manual/api/reference_commentary#参数行为):<br>- 当*类型*设为"值"时*支持*该功能 |
| *Size* (type) | 0 | secondary_label_size_type | 0 - *（默认）* 自动；<br>1 - 自定义。 |
| *Size* | 0 | secondary_label_size | 取值范围为1-100。<br><br>默认值：30.<br><br>[参数行为](/manual/api/reference_commentary#参数行为):<br>- 当*尺寸*（类型）设为"自定义"时*支持*该功能 |
| *Bold* | 0 | secondary_label_bold | 0 - 已禁用；<br>1 - *（默认）* 已启用。 |
| *Color* | 1 | secondary_label_color | 十六进制颜色代码（例如 `FF0000`）。<br><br>默认值：基于 [设置](/manual/api/reference/settings/object#设置) 和 [User object](/manual/api/reference/user/object#user) 的 `theme`：<br>`1F2C33` 用于 "blue-theme" 或 "hc-light"；<br>`EEEEEE` 用于 "dark-theme" 或 "hc-dark"。 |
| *Units* (checkbox) | 0 | secondary_label_units_show | 0 - 已禁用；<br>1 - *（默认）* 已启用。<br><br>[参数行为](/manual/api/reference_commentary#参数行为):<br>- 当*类型*设置为"值"时*支持* |
| *Units* (value) | 1 | secondary_label_units | 任意string值。<br><br>`""`（空值）<br><br>[参数行为](/manual/api/reference_commentary#参数行为):<br>- 当*类型*设为"值"且*单位*（复选框）设为"启用"时*支持* |
| *Position* | 0 | secondary_label_position | 0 - 数值前；<br>1 - *（默认）* 数值后。<br><br>[参数行为](/manual/api/reference_commentary#参数行为):<br>- 当*类型*设为"数值"且*单位*（复选框）设为"启用"时*支持*<br><br>若设为以下[配置](/manual/config/items/item#配置)之一则忽略此参数：unixtime、uptime、秒。 |
| ***Background color*** | < | < | <     |
| *Background color* | 1 | bg_color | 十六进制颜色代码（例如`FF0000`）。<br><br>默认值基于[设置](/manual/api/reference/settings/object#设置)和[User object](/manual/api/reference/user/object#user)的`theme`：<br>`D9E7ED`对应"blue-theme"；<br>`3D5059`对应"dark-theme"；<br>`AAD7E9`对应"hc-light"；<br>`335463`对应"hc-dark"。 |
| ***Thresholds*** | < | < | <     |
| *Color interpolation* | 0 | interpolation | 0 - 已禁用；<br>1 - *（默认）* 已启用。 |
| *Color* | 1 | thresholds.0.color | 十六进制颜色代码（例如`FF0000`）。 |
| *Threshold* | 1 | thresholds.0.threshold | 任意数值。支持[Suffixes](/manual/appendix/suffixes)格式（例如"1d"、"2w"、"4K"、"8G"）。 |

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

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

以下示例仅用于描述为 *Honeycomb* 小部件配置仪表板 widget 字段 objects 的过程。
有关配置仪表板的更多信息，请参阅 [`dashboard.create`](/manual/api/reference/dashboard/create)。

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

[comment]: # ({18033898-0cace4a6})
#### 配置 *Honeycomb* 小组件

配置一个显示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})
### 另请参阅

-   [Dashboard widget field](/manual/api/reference/dashboard/object#dashboard-widget-field)
-   [`dashboard.create`](/manual/api/reference/dashboard/create)
-   [`dashboard.update`](/manual/api/reference/dashboard/update)

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