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

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

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

These parameters and the possible property values for the respective dashboard widget field objects allow to configure
the [*Honeycomb*](/manual/web_interface/frontend_sections/dashboards/widgets/honeycomb) widget in `dashboard.create` and `dashboard.update` methods.

::: noteimportant
Widget `fields` properties are not validated during the creation or update of a dashboard.
This allows users to modify [built-in widgets](/manual/web_interface/frontend_sections/dashboards/widgets) and create [custom widgets](/devel/modules/tutorials/widget), but also introduces the risk of creating or updating widgets incorrectly.
To ensure the successful creation or update of the *Honeycomb* widget, please refer to the parameter behavior outlined in the tables below.
:::

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

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

The following parameters are supported for the *Honeycomb* widget.

|Parameter|<|[type](/manual/api/reference/dashboard/object#dashboard-widget-field)|name|value|
|-|--------|--|--------|-------------------------------|
|*Refresh interval*|<|0|rf_rate|0 - No refresh;<br>10 - 10 seconds;<br>30 - 30 seconds;<br>60 - *(default)* 1 minute;<br>120 - 2 minutes;<br>600 - 10 minutes;<br>900 - 15 minutes.|
|*Host groups*|<|2|groupids.0|[Host group](/manual/api/reference/hostgroup/get) ID.<br><br>Note: To configure multiple host groups, create a dashboard widget field object for each host group with an incremented number in the property name.<br><br>This parameter is not supported if configuring the widget on a [template dashboard](/manual/api/reference/templatedashboard/object).|
|<|*Host groups (Widget)*|1|groupids.\_reference|Instead of [Host group](/manual/api/reference/hostgroup/get) ID:<br>`ABCDE._hostgroupids` - set a [compatible widget](/manual/web_interface/frontend_sections/dashboards/widgets#widget-compatibility) (with its *Reference* parameter set to "`ABCDE`") as the data source for host groups.<br><br>This parameter is not supported if configuring the widget on a [template dashboard](/manual/api/reference/templatedashboard/object).|
|*Hosts*|<|3|hostids.0|[Host](/manual/api/reference/host/get) ID.<br><br>Note: To configure multiple hosts, create a dashboard widget field object for each host with an incremented number in the property name. For multiple hosts, the parameter *Host groups* must either be not configured at all or configured with at least one host group that the configured hosts belong to.<br><br>This parameter is not supported if configuring the widget on a [template dashboard](/manual/api/reference/templatedashboard/object).|
|<|*Hosts (Widget/Dashboard)*|1|hostids.\_reference|Instead of [Host](/manual/api/reference/host/get) ID:<br>`DASHBOARD.hostids` - set the [*Host* selector](/manual/web_interface/frontend_sections/dashboards/widgets#override-host) as the data source for hosts;<br>`ABCDE._hostids` - set a [compatible widget](/manual/web_interface/frontend_sections/dashboards/widgets#widget-compatibility) (with its *Reference* parameter set to "`ABCDE`") as the data source for hosts.<br><br>This parameter is not supported if configuring the widget on a [template dashboard](/manual/api/reference/templatedashboard/object).|
|*Host tags*|<|<|<|<|
|<|*Evaluation type*|0|evaltype_host|0 - *(default)* And/Or;<br>2 - Or.<br><br>This parameter is not supported if configuring the widget on a [template dashboard](/manual/api/reference/templatedashboard/object).|
|^|*Tag name*|1|host_tags.0.tag|Any string value.<br><br>Note: The number in the property name references tag order in the tag evaluation list.<br><br>[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):<br>- *required* if configuring *Host tags*<br><br>This parameter is not supported if configuring the widget on a [template dashboard](/manual/api/reference/templatedashboard/object).|
|^|*Operator*|0|host_tags.0.operator|0 - Contains;<br>1 - Equals;<br>2 - Does not contain;<br>3 - Does not equal;<br>4 - Exists;<br>5 - Does not exist.<br><br>Note: The number in the property name references tag order in the tag evaluation list.<br><br>[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):<br>- *required* if configuring *Host tags*<br><br>This parameter is not supported if configuring the widget on a [template dashboard](/manual/api/reference/templatedashboard/object).|
|^|*Tag value*|1|host_tags.0.value|Any string value.<br><br>Note: The number in the property name references tag order in the tag evaluation list.<br><br>[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):<br>- *required* if configuring *Host tags*<br><br>This parameter is not supported if configuring the widget on a [template dashboard](/manual/api/reference/templatedashboard/object).|
|*Item patterns*|<|1|items.0|[Item](/manual/api/reference/item/get) name or pattern.<br><br>Note: To configure multiple item patterns, create a dashboard widget field object for each item pattern with an incremented number in the property name.<br><br>[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):<br>- *required*|
|*Item tags*|<|<|<|<|
|<|*Evaluation type*|0|evaltype_item|0 - *(default)* And/Or;<br>2 - Or.|
|^|*Tag name*|1|item_tags.0.tag|Any string value.<br><br>Note: The number in the property name references tag order in the tag evaluation list.<br><br>[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):<br>- *required* if configuring *Item tags*|
|^|*Operator*|0|item_tags.0.operator|0 - Contains;<br>1 - Equals;<br>2 - Does not contain;<br>3 - Does not equal;<br>4 - Exists;<br>5 - Does not exist.<br><br>Note: The number in the property name references tag order in the tag evaluation list.<br><br>[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):<br>- *required* if configuring *Item tags*|
|^|*Tag value*|1|item_tags.0.value|Any string value.<br><br>Note: The number in the property name references tag order in the tag evaluation list.<br><br>[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):<br>- *required* if configuring *Item tags*|
|*Show hosts in maintenance*|<|0|maintenance|0 - *(default)* Disabled;<br>1 - Enabled.|
|*Show*|<|0|show.0|1 - Primary label;<br>2 - Secondary label.<br><br>Note: To configure multiple values, create a dashboard widget field object for each value with an incremented number in the property name.<br><br>Default: 1, 2.|
|*Reference*|<|1|reference|Any string value consisting of 5 characters (e.g., `ABCDE` or `JBPNL`). This value must be unique within the dashboard to which the widget belongs.<br><br>[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):<br>- *required*|

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

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

The following advanced configuration parameters are supported for the *Honeycomb* widget.

::: noteclassic
The number in the *Thresholds* property name (e.g. thresholds.0.color) references the threshold place in a list, sorted in ascending order.
However, if thresholds are configured in a different order, the values will be sorted in ascending order after updating widget configuration in Zabbix frontend
(e.g. `"thresholds.0.threshold":"5"` → `"thresholds.0.threshold":"1"`; `"thresholds.1.threshold":"1"` → `"thresholds.1.threshold": "5"`).
:::

|Parameter|[type](/manual/api/reference/dashboard/object#dashboard-widget-field)|name|value|
|-----|-|-----|-------------------|
|***Primary label***|<|<|<|
|*Type*|0|primary_label_type|0 - *(default)* Text;<br>1 - Value.|
|*Text*|1|primary_label|Any string value, including macros.<br>Supported macros: {HOST.\*}, {ITEM.\*}, {INVENTORY.\*}, user macros.<br><br>Default: {HOST.NAME}<br><br>[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):<br>- *supported* if *Type* is set to "Text"|
|*Decimal places*|0|primary_label_decimal_places|Possible values range from 0-6.<br><br>Default: 2.<br><br>[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):<br>- *supported* if *Type* is set to "Value"|
|*Size* (type)|0|primary_label_size_type|0 - *(default)* Auto;<br>1 - Custom.|
|*Size*|0|primary_label_size|Possible values range from 1-100.<br><br>Default: 20.<br><br>[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):<br>- *supported* if *Size* (type) is set to "Custom"|
|*Bold*|0|primary_label_bold|0 - *(default)* Disabled;<br>1 - Enabled.|
|*Color*|1|primary_label_color|Hexadecimal color code (e.g. `FF0000`).<br><br>Default: based on `theme` of [Settings object](/manual/api/reference/settings/object#settings) and [User object](/manual/api/reference/user/object#user):<br>`1F2C33` for "blue-theme" or "hc-light";<br>`EEEEEE` for "dark-theme" or "hc-dark".|
|*Units* (checkbox)|0|primary_label_units_show|0 - Disabled;<br>1 - *(default)* Enabled.<br><br>[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):<br>- *supported* if *Type* is set to "Value"|
|*Units* (value)|1|primary_label_units|Any string value.<br><br>`""` (empty)<br><br>[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):<br>- *supported* if *Type* is set to "Value" and *Units* (checkbox) is set to "Enabled"|
|*Position*|0|primary_label_units_pos|0 - Before value;<br>1 - *(default)* After value.<br><br>[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):<br>- *supported* if *Type* is set to "Value" and *Units* (checkbox) is set to "Enabled"<br><br>This parameter is ignored if set to one of the following [time-related units](/manual/config/items/item#configuration): unixtime, uptime, s.|
|***Secondary label***|<|<|<|
|*Type*|0|secondary_label_type|0 - Text;<br>1 - *(default)* Value.|
|*Text*|1|secondary_label|Any string value, including macros.<br>Supported macros: {HOST.\*}, {ITEM.\*}, {INVENTORY.\*}, user macros.<br><br>Default: {{ITEM.LASTVALUE}.fmtnum(2)}<br><br>[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):<br>- *supported* if *Type* is set to "Text"|
|*Decimal places*|0|secondary_label_decimal_places|Possible values range from 0-6.<br><br>Default: 2.<br><br>[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):<br>- *supported* if *Type* is set to "Value"|
|*Size* (type)|0|secondary_label_size_type|0 - *(default)* Auto;<br>1 - Custom.|
|*Size*|0|secondary_label_size|Possible values range from 1-100.<br><br>Default: 30.<br><br>[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):<br>- *supported* if *Size* (type) is set to "Custom"|
|*Bold*|0|secondary_label_bold|0 - Disabled;<br>1 - *(default)* Enabled.|
|*Color*|1|secondary_label_color|Hexadecimal color code (e.g. `FF0000`).<br><br>Default: based on `theme` of [Settings object](/manual/api/reference/settings/object#settings) and [User object](/manual/api/reference/user/object#user):<br>`1F2C33` for "blue-theme" or "hc-light";<br>`EEEEEE` for "dark-theme" or "hc-dark".|
|*Units* (checkbox)|0|secondary_label_units_show|0 - Disabled;<br>1 - *(default)* Enabled.<br><br>[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):<br>- *supported* if *Type* is set to "Value"|
|*Units* (value)|1|secondary_label_units|Any string value.<br><br>`""` (empty)<br><br>[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):<br>- *supported* if *Type* is set to "Value" and *Units* (checkbox) is set to "Enabled"|
|*Position*|0|secondary_label_position|0 - Before value;<br>1 - *(default)* After value.<br><br>[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):<br>- *supported* if *Type* is set to "Value" and *Units* (checkbox) is set to "Enabled"<br><br>This parameter is ignored if set to one of the following [time-related units](/manual/config/items/item#configuration): unixtime, uptime, s.|
|***Background color***|<|<|<|
|*Background color*|1|bg_color|Hexadecimal color code (e.g. `FF0000`).<br><br>Default: based on `theme` of [Settings object](/manual/api/reference/settings/object#settings) and [User object](/manual/api/reference/user/object#user):<br>`D9E7ED` for "blue-theme";<br>`3D5059` for "dark-theme";<br>`AAD7E9` for "hc-light";<br>`335463` for "hc-dark".|
|***Thresholds***|<|<|<|
|*Color interpolation*|0|interpolation|0 - Disabled;<br>1 - *(default)* Enabled.|
|*Color*|1|thresholds.0.color|Hexadecimal color code (e.g. `FF0000`).|
|*Threshold*|1|thresholds.0.threshold|Any numeric value. [Suffixes](/manual/appendix/suffixes) (e.g. "1d", "2w", "4K", "8G") are supported.|

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

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

The following examples aim to only describe the configuration of the dashboard widget field objects for the *Honeycomb* widget.
For more information on configuring a dashboard, see [`dashboard.create`](/manual/api/reference/dashboard/create).

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

[comment]: # ({18033898-0cace4a6})
#### Configuring a *Honeycomb* widget

Configure a *Honeycomb* widget that displays the utilization of Zabbix server processes.
In addition, change the primary label of honeycomb cells and visually fine-tune the widget with thresholds.

[Request](/manual/api#performing-requests):

```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
}
```

Response:

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

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

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

-   [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})