[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)|name|value|
|-|--------|--|--------|-------------------------------|
|*リフレッシュ間隔*|<|0|rf_rate|0 - リフレッシュなし;
10 - 10秒;
30 - 30秒;
60 - *(デフォルト)* 1分;
120 - 2分;
600 - 10分;
900 - 15分。|
|*ホストグループ*|<|2|groupids.0|[ホストグループ](/manual/api/reference/hostgroup/get)のID。
注: 複数のホストグループを設定するには、プロパティ名の番号を増やして各ホストグループごとにダッシュボードウィジェットフィールドオブジェクトを作成します。
このパラメーターは、[テンプレートダッシュボード](/manual/api/reference/templatedashboard/object)でウィジェットを設定する場合はサポートされません。|
|<|*ホストグループ(ウィジェット)*|1|groupids.\_reference|[ホストグループ](/manual/api/reference/hostgroup/get)のIDの代わりに:
`ABCDE._hostgroupids` - [互換性のあるウィジェット](/manual/web_interface/frontend_sections/dashboards/widgets#widget-compatibility)（*Reference*パラメーターを"`ABCDE`"に設定）をホストグループのデータソースとして設定します。
このパラメーターは、[テンプレートダッシュボード](/manual/api/reference/templatedashboard/object)でウィジェットを設定する場合はサポートされません。|
|*ホスト*|<|3|hostids.0|[ホスト](/manual/api/reference/host/get)のID。
注: 複数のホストを設定するには、プロパティ名の番号を増やして各ホストごとにダッシュボードウィジェットフィールドオブジェクトを作成します。複数のホストを指定する場合、*ホストグループ*パラメーターは未設定か、指定したホストが属するホストグループを少なくとも1つ設定する必要があります。
このパラメーターは、[テンプレートダッシュボード](/manual/api/reference/templatedashboard/object)でウィジェットを設定する場合はサポートされません。|
|<|*ホスト(ウィジェット/ダッシュボード)*|1|hostids.\_reference|[ホスト](/manual/api/reference/host/get)のIDの代わりに:
`DASHBOARD.hostids` - ダッシュボードの[ホストセレクター](/manual/web_interface/frontend_sections/dashboards/widgets#override-host)をホストのデータソースとして設定します;
`ABCDE._hostids` - [互換性のあるウィジェット](/manual/web_interface/frontend_sections/dashboards/widgets#widget-compatibility)（*Reference*パラメーターを"`ABCDE`"に設定）をホストのデータソースとして設定します。
このパラメーターは、[テンプレートダッシュボード](/manual/api/reference/templatedashboard/object)でウィジェットを設定する場合はサポートされません。|
|*ホストタグ*|<|<|<|<|
|<|*評価タイプ*|0|evaltype_host|0 - *(デフォルト)* And/Or;
2 - Or。
このパラメーターは、[テンプレートダッシュボード](/manual/api/reference/templatedashboard/object)でウィジェットを設定する場合はサポートされません。|
|^|*タグ名*|1|host_tags.0.tag|任意の文字列値。
注: プロパティ名の番号はタグ評価リスト内のタグの順序を参照します。
[パラメーターの動作](/manual/api/reference_commentary#parameter-behavior):
- *必須*（*ホストタグ*を設定する場合）
このパラメーターは、[テンプレートダッシュボード](/manual/api/reference/templatedashboard/object)でウィジェットを設定する場合はサポートされません。|
|^|*演算子*|0|host_tags.0.operator|0 - 含む;
1 - 等しい;
2 - 含まない;
3 - 等しくない;
4 - 存在する;
5 - 存在しない。
注: プロパティ名の番号はタグ評価リスト内のタグの順序を参照します。
[パラメーターの動作](/manual/api/reference_commentary#parameter-behavior):
- *必須*（*ホストタグ*を設定する場合）
このパラメーターは、[テンプレートダッシュボード](/manual/api/reference/templatedashboard/object)でウィジェットを設定する場合はサポートされません。|
|^|*タグ値*|1|host_tags.0.value|任意の文字列値。
注: プロパティ名の番号はタグ評価リスト内のタグの順序を参照します。
[パラメーターの動作](/manual/api/reference_commentary#parameter-behavior):
- *必須*（*ホストタグ*を設定する場合）
このパラメーターは、[テンプレートダッシュボード](/manual/api/reference/templatedashboard/object)でウィジェットを設定する場合はサポートされません。|
|*アイテムパターン*|<|1|items.0|[アイテム](/manual/api/reference/item/get)名またはパターン。
注: 複数のアイテムパターンを設定するには、プロパティ名の番号を増やして各アイテムパターンごとにダッシュボードウィジェットフィールドオブジェクトを作成します。
[パラメーターの動作](/manual/api/reference_commentary#parameter-behavior):
- *必須*|
|*アイテムタグ*|<|<|<|<|
|<|*評価タイプ*|0|evaltype_item|0 - *(デフォルト)* And/Or;
2 - Or。|
|^|*タグ名*|1|item_tags.0.tag|任意の文字列値。
注: プロパティ名の番号はタグ評価リスト内のタグの順序を参照します。
[パラメーターの動作](/manual/api/reference_commentary#parameter-behavior):
- *必須*（*アイテムタグ*を設定する場合）|
|^|*演算子*|0|item_tags.0.operator|0 - 含む;
1 - 等しい;
2 - 含まない;
3 - 等しくない;
4 - 存在する;
5 - 存在しない。
注: プロパティ名の番号はタグ評価リスト内のタグの順序を参照します。
[パラメーターの動作](/manual/api/reference_commentary#parameter-behavior):
- *必須*（*アイテムタグ*を設定する場合）|
|^|*タグ値*|1|item_tags.0.value|任意の文字列値。
注: プロパティ名の番号はタグ評価リスト内のタグの順序を参照します。
[パラメーターの動作](/manual/api/reference_commentary#parameter-behavior):
- *必須*（*アイテムタグ*を設定する場合）|
|*メンテナンス中のホストを表示*|<|0|maintenance|0 - *(デフォルト)* 無効;
1 - 有効。|
|*表示*|<|0|show.0|1 - プライマリラベル;
2 - セカンダリラベル。
注: 複数の値を設定するには、プロパティ名の番号を増やして各値ごとにダッシュボードウィジェットフィールドオブジェクトを作成します。
デフォルト: 1, 2。|
|*Reference*|<|1|reference|5文字からなる任意の文字列値（例: `ABCDE`や`JBPNL`）。この値は、ウィジェットが属するダッシュボード内で一意でなければなりません。
[パラメーターの動作](/manual/api/reference_commentary#parameter-behavior):
- *必須*|
[comment]: # ({/082a0ee8-7a40ed57})
[comment]: # ({aaafe403-d25c8205})
#### 高度な設定
以下の高度な設定パラメータは、*Honeycomb* ウィジェットでサポートされています。
::: noteclassic
*Thresholds* プロパティ名の番号（例: thresholds.0.color）は、昇順に並べ替えられたリスト内のしきい値の位置を参照します。
ただし、しきい値が異なる順序で設定されている場合、Zabbix Webインターフェースでウィジェット設定を更新した後に、値は昇順に並べ替えられます
（例: `"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 - *(デフォルト)* テキスト;
1 - 値。|
|*テキスト*|1|primary_label|マクロを含む任意の文字列値。
サポートされるマクロ: {HOST.\*}, {ITEM.\*}, {INVENTORY.\*}, ユーザーマクロ。
デフォルト: {HOST.NAME}
[パラメータの動作](/manual/api/reference_commentary#parameter-behavior):
- *Type* が "Text" に設定されている場合に *supported*|
|*小数点以下の桁数*|0|primary_label_decimal_places|指定可能な値の範囲は 0～6 です。
デフォルト: 2。
[パラメータの動作](/manual/api/reference_commentary#parameter-behavior):
- *Type* が "Value" に設定されている場合に *supported*|
|*サイズ* (type)|0|primary_label_size_type|0 - *(デフォルト)* 自動;
1 - カスタム。|
|*サイズ*|0|primary_label_size|指定可能な値の範囲は 1～100 です。
デフォルト: 20。
[パラメータの動作](/manual/api/reference_commentary#parameter-behavior):
- *Size* (type) が "Custom" に設定されている場合に *supported*|
|*太字*|0|primary_label_bold|0 - *(デフォルト)* 無効;
1 - 有効。|
|*色*|1|primary_label_color|16進数のカラーコード（例: `FF0000`）。
デフォルト: [Settings object](/manual/api/reference/settings/object#settings) および [User object](/manual/api/reference/user/object#user) の `theme` に基づきます:
`1F2C33` - "blue-theme"、"blue-classic-theme"、または "hc-light" の場合;
`EEEEEE` - "dark-theme"、"dark-classic-theme"、または "hc-dark" の場合。|
|*単位* (checkbox)|0|primary_label_units_show|0 - 無効;
1 - *(デフォルト)* 有効。
[パラメータの動作](/manual/api/reference_commentary#parameter-behavior):
- *Type* が "Value" に設定されている場合に *supported*|
|*単位* (value)|1|primary_label_units|任意の文字列値。
`""` (空)
[パラメータの動作](/manual/api/reference_commentary#parameter-behavior):
- *Type* が "Value" に設定され、かつ *Units* (checkbox) が "Enabled" に設定されている場合に *supported*|
|*位置*|0|primary_label_units_pos|0 - 値の前;
1 - *(デフォルト)* 値の後。
[パラメータの動作](/manual/api/reference_commentary#parameter-behavior):
- *Type* が "Value" に設定され、かつ *Units* (checkbox) が "Enabled" に設定されている場合に *supported*
このパラメータは、次の [時間関連の単位](/manual/config/items/item#configuration) のいずれかに設定されている場合は無視されます: unixtime, uptime, s。|
|***セカンダリラベル***|<|<|<|
|*タイプ*|0|secondary_label_type|0 - テキスト;
1 - *(デフォルト)* 値。|
|*テキスト*|1|secondary_label|マクロを含む任意の文字列値。
サポートされるマクロ: {HOST.\*}, {ITEM.\*}, {INVENTORY.\*}, ユーザーマクロ。
デフォルト: {{ITEM.LASTVALUE}.fmtnum(2)}
[パラメータの動作](/manual/api/reference_commentary#parameter-behavior):
- *Type* が "Text" に設定されている場合に *supported*|
|*小数点以下の桁数*|0|secondary_label_decimal_places|指定可能な値の範囲は 0～6 です。
デフォルト: 2。
[パラメータの動作](/manual/api/reference_commentary#parameter-behavior):
- *Type* が "Value" に設定されている場合に *supported*|
|*サイズ* (type)|0|secondary_label_size_type|0 - *(デフォルト)* 自動;
1 - カスタム。|
|*サイズ*|0|secondary_label_size|指定可能な値の範囲は 1～100 です。
デフォルト: 30。
[パラメータの動作](/manual/api/reference_commentary#parameter-behavior):
- *Size* (type) が "Custom" に設定されている場合に *supported*|
|*太字*|0|secondary_label_bold|0 - 無効;
1 - *(デフォルト)* 有効。|
|*色*|1|secondary_label_color|16進数のカラーコード（例: `FF0000`）。
デフォルト: [Settings object](/manual/api/reference/settings/object#settings) および [User object](/manual/api/reference/user/object#user) の `theme` に基づきます:
`1F2C33` - "blue-theme"、"blue-classic-theme"、または "hc-light" の場合;
`EEEEEE` - "dark-theme"、"dark-classic-theme"、または "hc-dark" の場合。|
|*単位* (checkbox)|0|secondary_label_units_show|0 - 無効;
1 - *(デフォルト)* 有効。
[パラメータの動作](/manual/api/reference_commentary#parameter-behavior):
- *Type* が "Value" に設定されている場合に *supported*|
|*単位* (value)|1|secondary_label_units|任意の文字列値。
`""` (空)
[パラメータの動作](/manual/api/reference_commentary#parameter-behavior):
- *Type* が "Value" に設定され、かつ *Units* (checkbox) が "Enabled" に設定されている場合に *supported*|
|*位置*|0|secondary_label_position|0 - 値の前;
1 - *(デフォルト)* 値の後。
[パラメータの動作](/manual/api/reference_commentary#parameter-behavior):
- *Type* が "Value" に設定され、かつ *Units* (checkbox) が "Enabled" に設定されている場合に *supported*
このパラメータは、次の [時間関連の単位](/manual/config/items/item#configuration) のいずれかに設定されている場合は無視されます: unixtime, uptime, s。|
|***背景色***|<|<|<|
|*背景色*|1|bg_color|16進数のカラーコード（例: `FF0000`）。
デフォルト: [Settings object](/manual/api/reference/settings/object#settings) および [User object](/manual/api/reference/user/object#user) の `theme` に基づきます:
`D9E7ED` - "blue-theme" および "blue-classic-theme" の場合;
`3D5059` - "dark-theme" および "dark-classic-theme" の場合;
`AAD7E9` - "hc-light" の場合;
`335463` - "hc-dark" の場合。|
|***しきい値***|<|<|<|
|*色の補間*|0|interpolation|0 - 無効;
1 - *(デフォルト)* 有効。|
|*色*|1|thresholds.0.color|16進数のカラーコード（例: `FF0000`）。|
|*しきい値*|1|thresholds.0.threshold|任意の数値。 [接尾辞](/manual/appendix/suffixes)（例: "1d", "2w", "4K", "8G"）をサポートしています。|
[comment]: # ({/aaafe403-d25c8205})
[comment]: # ({05e301d7-c6f49883})
### 例
次の例は、*ハニカム*ウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。
ダッシュボードの設定の詳細については、[`dashboard.create`](/manual/api/reference/dashboard/create)を参照してください。
[comment]: # ({/05e301d7-c6f49883})
[comment]: # ({18033898-0cace4a6})
#### *ハニカム*ウィジェットの設定
Zabbixサーバープロセスの使用率を表示する*ハニカム*ウィジェットを設定します。
さらに、ハニカムセルのプライマリラベルを変更し、しきい値を設定してウィジェットを視覚的に微調整します。
[リクエスト](/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
}
```
レスポンス:
```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})