[comment]: # ({364afe17-7f83c4c7})
# 6 Gauge
[comment]: # ({/364afe17-7f83c4c7})
[comment]: # ({fc686620-1c93902f})
### 説明
これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、`dashboard.create`メソッドおよび`dashboard.update`メソッドで[*ゲージ*](/manual/web_interface/frontend_sections/dashboards/widgets/gauge)ウィジェットを設定できます。
::: noteimportant
ウィジェットの`fields`プロパティは、ダッシュボードの作成または更新時に検証されません。
これにより、ユーザーは[組み込みウィジェット](/manual/web_interface/frontend_sections/dashboards/widgets)を変更したり、[カスタムウィジェット](/devel/modules/tutorials/widget)を作成したりできますが、ウィジェットを誤って作成または更新してしまうリスクも生じます。
*ゲージ*ウィジェットを正常に作成または更新するには、以下の表に記載されているパラメーターの動作を参照してください。
:::
[comment]: # ({/fc686620-1c93902f})
[comment]: # ({a07c7b8d-2e17e0ed})
### パラメーター
*ゲージ*ウィジェットでサポートされているパラメーターは以下の通りです。
|パラメーター|<|[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分。|
|*アイテム*|<|4|itemid.0|[アイテム](/manual/api/reference/item/get)のID。
[パラメーターの動作](/manual/api/reference_commentary#parameter-behavior):
- *アイテム(ウィジェット)*が設定されていない場合は*必須*|
|<|*アイテム(ウィジェット)*|1|itemid.\_reference|[アイテム](/manual/api/reference/item/get)のIDの代わりに:
`ABCDE._itemid` - [互換性のあるウィジェット](/manual/web_interface/frontend_sections/dashboards/widgets#widget-compatibility)（*参照*パラメーターを"`ABCDE`"に設定）をアイテムのデータソースとして設定します。
[パラメーターの動作](/manual/api/reference_commentary#parameter-behavior):
- *アイテム*が設定されていない場合は*必須*|
|*最小値*|<|1|min|任意の数値。[サフィックス](/manual/appendix/suffixes)（例："1d"、"2w"、"4K"、"8G"）がサポートされています。
デフォルト: "0"。|
|*最大値*|<|1|max|任意の数値。[サフィックス](/manual/appendix/suffixes)（例："1d"、"2w"、"4K"、"8G"）がサポートされています。
デフォルト: "100"。|
|*値アーク*|<|1|value_arc_color|16進数のカラーコード（例: `FF0000`）。
デフォルト: `""`（空）。|
|*アーク背景*|<|1|empty_color|16進数のカラーコード（例: `FF0000`）。
デフォルト: `""`（空）。|
|*背景*|<|1|bg_color|16進数のカラーコード（例: `FF0000`）。
デフォルト: `""`（空）。|
|*表示*|<|0|show.0|1 - 説明;
2 - 値;
3 - 針;
4 - 目盛り;
5 - 値アーク。
注: 複数の値を設定するには、プロパティ名の番号を増やして各値ごとにダッシュボードウィジェットフィールドオブジェクトを作成してください。
デフォルト: 1, 2, 4, 5。
以下の両方の場合、「針」と「目盛り」の値はサポートされません:
- 値「値アーク」の*表示*用のダッシュボードウィジェットフィールドオブジェクトが設定されていない;
- *アーク表示* [詳細設定](#advanced-configuration)パラメーターが「無効」に設定されている。
*表示*オプションの[詳細設定](#advanced-configuration)パラメーターは、該当する値のダッシュボードウィジェットフィールドオブジェクトが設定されていない場合はサポートされません。|
|*ホストの上書き*|<|1|override_hostid.\_reference|`ABCDE._hostid` - [互換性のあるウィジェット](/manual/web_interface/frontend_sections/dashboards/widgets#widget-compatibility)（*参照*パラメーターを"`ABCDE`"に設定）をホストのデータソースとして設定;
`DASHBOARD._hostid` - ダッシュボードの[ホストセレクター](/manual/web_interface/frontend_sections/dashboards/widgets#override-host)をホストのデータソースとして設定。
このパラメーターは[テンプレートダッシュボード](/manual/api/reference/templatedashboard/object)でウィジェットを設定する場合はサポートされません。|
[comment]: # ({/a07c7b8d-2e17e0ed})
[comment]: # ({7886dec5-1db7caf7})
#### Advanced configuration
*Gauge* ウィジェットでは、以下の詳細設定パラメータがサポートされています。
::: 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)|名前|値|
|-----|-|-----|-------------------|
|*角度*|0|角度|指定可能な値: 180 *(デフォルト)* または 270|
|***説明***|<|<|<|
|*説明*|1|説明|マクロを含む任意の文字列値
サポートされているマクロ: {HOST.\*}、{ITEM.\*}、{INVENTORY.\*}、ユーザーマクロ
デフォルト: {ITEM.NAME}|
|*サイズ*|0|desc_size|指定可能な値の範囲は 1-100 です。
デフォルト: 15|
|*垂直位置*|0|desc_v_pos|0 - 上;
1 - *(デフォルト)* 下|
|*太字*|0|desc_bold|0 - *(デフォルト)* 無効;
1 - 有効|
|*色*|1|desc_color|16進数のカラーコード (例: `FF0000`)
デフォルト: `""` (空)|
|***値***|<|<|<|
|*小数点*|0|decimal_places|指定可能な値の範囲は1-10です。
デフォルト: 2|
|*サイズ*|0|value_size|指定可能な値の範囲は1-100です。
デフォルト: 25|
|*太字*|0|value_bold|0 - *(デフォルト)* 無効;
1 - 有効|
|*Color*|1|value_color|16進数のカラーコード（例：`FF0000`）
デフォルト：`""`（空）|
|***単位***|<|<|<|
|*単位*（チェックボックス）|0|units_show|0 - 無効
1 - *（デフォルト）* 有効|
|*単位*（値）|1|units|任意の文字列値
[パラメータの動作](/manual/api/reference_commentary#parameter-behavior):
- *単位*（チェックボックス）が"有効"に設定されている場合に*サポートされます*|
|*サイズ*|0|units_size|有効な値の範囲は1-100です。
デフォルト: 25
[パラメータの動作](/manual/api/reference_commentary#parameter-behavior):
- *単位* (チェックボックス) が"有効"に設定されている場合にサポートされます|
|*太字*|0|units_bold|0 - *(デフォルト)* 無効
1 - 有効
[パラメータの動作](/manual/api/reference_commentary#parameter-behavior):
- *単位* (チェックボックス) が"有効"に設定されている場合にサポートされます|
|*位置*|0|units_pos|0 - 値の前
1 - 値の上
2 - *(デフォルト)* 値の後
3 - 値の下
[パラメータの動作](/manual/api/reference_commentary#parameter-behavior):
- *単位* (チェックボックス) が"有効"に設定されている場合に *サポート* されます。
このパラメータは、次の [時間関連の単位](/manual/config/items/item#configuration) のいずれかに設定されている場合、無視されます。: unixtime、uptime、s|
|*色*|1|units_color|16進数のカラーコード (例: `FF0000`)
デフォルト: `""` (空)|
|***値の円弧***|<|<|<|
|*円弧サイズ*|0|value_arc_size|有効な値の範囲は1-100です。
デフォルト: 20|
|***ニードル***|<|<|<|
|*色*|1|needle_color|16進数のカラーコード（例: `FF0000`）
デフォルト: `""`（空）
[パラメータの動作](/manual/api/reference_commentary#parameter-behavior):
- ダッシュボードウィジェットのフィールドオブジェクトで、*表示*に"値円弧"が設定されている場合、または*表示円弧*が"有効"に設定されている場合に*サポート*されます。|
|***スケール***|<|<|<|
|*単位の表示*|0|scale_show_units|0 - 無効;
1 - *(デフォルト)* 有効
[パラメータの動作](/manual/api/reference_commentary#parameter-behavior):
- *単位* (チェックボックス) が"有効"に設定され、ダッシュボード ウィジェットの *表示* のフィールド オブジェクトで値が"値の円弧"に設定されているか、*表示円弧* が"有効"に設定されている場合に *サポート*されます。|
|*サイズ*|0|scale_size|指定可能な値の範囲は 1-100 です。
デフォルト: 15
[パラメータの動作](/manual/api/reference_commentary#parameter-behavior):
- *表示* のダッシュボード ウィジェットのフィールド オブジェクトで値が"値の円弧"に設定されているか、*表示円弧* が"有効"に設定されている場合に *サポート*されます。|
|*小数点以下の桁数*|0|scale_decimal_places|有効な値の範囲は1-10です。
デフォルト: 0
[パラメータの動作](/manual/api/reference_commentary#parameter-behavior):
- ダッシュボードウィジェットのフィールドオブジェクトで、*表示*に"Value arc"が設定されている場合、または*表示 arc*が"有効"に設定されている場合に*サポート*されます。|
|***しきい値***|<|<|<|
|*色*|1|thresholds.0.color|16進数のカラーコード(例: `FF0000`)|
|*しきい値*|1|thresholds.0.threshold|任意の数値[サフィックス](/manual/appendix/suffixes) (例: "1d"、"2w"、"4K"、"8G") がサポートされています。|
|*ラベルを表示*|0|th_show_labels|0 - *(デフォルト)* 無効;
1 - 有効
[パラメータの動作](/manual/api/reference_commentary#parameter-behavior):
- *しきい値* が設定されており、ダッシュボード ウィジェットの *表示* フィールド オブジェクトに値 "Value arc" が設定されているか、*表示アーク* が "有効" に設定されている場合は *サポート* されます。|
|*円弧`を表示*|0|th_show_arc|0 - *(デフォルト)* 無効;
1 - 有効
[パラメータの動作](/manual/api/reference_commentary#parameter-behavior):
- *しきい値* が設定されている場合は *サポート* されます。|
|*円弧のサイズ*|0|th_arc_size|可能な値の範囲は 1-100 です。
デフォルト: 5
[パラメータの動作](/manual/api/reference_commentary#parameter-behavior):
- *円弧の表示* が "有効" に設定されている場合は *サポート* されます。|
[comment]: # ({/7886dec5-1db7caf7})
[comment]: # ({abd47a5b-f2849ab5})
### 例
次の例は、*ゲージ*ウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。
ダッシュボードの設定の詳細については、[`dashboard.create`](/manual/api/reference/dashboard/create)を参照してください。
[comment]: # ({/abd47a5b-f2849ab5})
[comment]: # ({17a49bae-f3687306})
#### *ゲージ*ウィジェットの設定
アイテム"44474" (インターフェース enp0s3: 送信ビット数)の値を表示する*ゲージ*ウィジェットを設定します。
さらに、しきい値などの複数の詳細オプションを使用して、ウィジェットを視覚的に微調整します。
[リクエスト](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "gauge",
"name": "Gauge",
"x": 0,
"y": 0,
"width": 18,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 4,
"name": "itemid.0",
"value": 44474
},
{
"type": 1,
"name": "min",
"value": "100000"
},
{
"type": 1,
"name": "max",
"value": "1000000"
},
{
"type": 0,
"name": "show.0",
"value": 1
},
{
"type": 0,
"name": "show.1",
"value": 2
},
{
"type": 0,
"name": "show.2",
"value": 3
},
{
"type": 0,
"name": "show.4",
"value": 4
},
{
"type": 0,
"name": "show.5",
"value": 5
},
{
"type": 0,
"name": "angle",
"value": 270
},
{
"type": 0,
"name": "desc_size",
"value": 10
},
{
"type": 0,
"name": "desc_bold",
"value": 1
},
{
"type": 0,
"name": "decimal_places",
"value": 0
},
{
"type": 0,
"name": "value_bold",
"value": 1
},
{
"type": 0,
"name": "units_size",
"value": 15
},
{
"type": 0,
"name": "units_pos",
"value": 3
},
{
"type": 1,
"name": "needle_color",
"value": "3C3C3C"
},
{
"type": 1,
"name": "thresholds.0.color",
"value": "FF465C"
},
{
"type": 1,
"name": "thresholds.0.threshold",
"value": "700000"
},
{
"type": 1,
"name": "thresholds.1.color",
"value": "FFD54F"
},
{
"type": 1,
"name": "thresholds.1.threshold",
"value": "500000"
},
{
"type": 1,
"name": "thresholds.2.color",
"value": "0EC9AC"
},
{
"type": 1,
"name": "thresholds.2.threshold",
"value": "100000"
},
{
"type": 0,
"name": "th_show_labels",
"value": 1
},
{
"type": 0,
"name": "th_show_arc",
"value": 1
},
{
"type": 0,
"name": "th_arc_size",
"value": 15
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}
```
レスポンス:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
[comment]: # ({/17a49bae-f3687306})
[comment]: # ({e9d30322-ced660a5})
### 参照
- [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-ced660a5})