Documentation
Table of Contents
15 アイテムカード
説明
これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、dashboard.createメソッドおよびdashboard.updateメソッドでアイテムカードウィジェットを設定できます。
ウィジェットのfieldsプロパティは、ダッシュボードの作成または更新時に検証されません。 これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新してしまうリスクも生じます。 アイテムカードウィジェットを正常に作成または更新するには、以下の表に記載されているパラメーターの動作を参照してください。
パラメーター
アイテムカードウィジェットでは、以下のパラメーターがサポートされています。
| パラメーター | type | name | value | |
|---|---|---|---|---|
| 更新間隔 | 0 | rf_rate | 0 - 更新なし; 10 - 10秒; 30 - 30秒; 60 - (デフォルト) 1分; 120 - 2分; 600 - 10分; 900 - 15分 |
|
| Item | 4 | itemid.0 | Item ID。 パラメーターの動作: - Item (Widget) が設定されていない場合は 必須 です。 |
|
| Item (Widget) | 1 | itemid._reference | Item ID:ABCDE._itemid の代わりに、アイテムのデータソースとして 互換性のあるウィジェット (Reference パラメーターが "ABCDE に設定されている) を設定します。パラメーターの動作: - Item が設定されていない場合は 必須 です。 |
|
| 表示 | 0 | セクション.0 | 0 - 説明; 1 - エラーテキスト; 2 - メトリクス; 3 - 最新データ; 4 - 情報の種類; 5 - トリガー; 6 - ホストインターフェース; 7 - タイプ; 8 - ホストインベントリ; 9 - タグ. 注: プロパティ名の数字は、セクションリスト内のセクションの順序を示します。複数のセクションを構成するには、プロパティ名に増分番号を付けたダッシュボードウィジェットフィールドオブジェクトをセクションごとに作成します。 |
|
| ホストの上書き | 1 | override_hostid._reference | ABCDE._hostid - 互換性のあるウィジェット (その Reference パラメータが "ABCDE に設定されている) をホストのデータ ソースとして設定します。DASHBOARD._hostid - ダッシュボードの ホスト セレクター をホストのデータ ソースとして設定します。デフォルト: "" (空)テンプレート ダッシュボード でウィジェットを構成する場合、このパラメータはサポートされません。 |
|
スパークライン
表示が "最新データ" に設定されている場合、以下のパラメータがサポートされます。
| パラメータ | type | 名前 | 値 | |
|---|---|---|---|---|
| 幅 | 0 | sparkline.width | 指定可能な値の範囲は0～10です。 デフォルト: 1 |
|
| 塗りつぶし | 0 | sparkline.fill | 指定可能な値の範囲は0～10です。 デフォルト: 3 |
|
| 色 | 1 | sparkline.color | 16進数のカラーコード（例: FF0000）。デフォルト: 42A5F5 |
|
| 期間 | 1 | sparkline.time_period._reference | DASHBOARD._timeperiod - 期間セレクターをデータソースとして設定します。ABCDE._timeperiod - 互換性のあるウィジェット（referenceパラメータがABCDEに等しい）をデータソースとして設定します。デフォルト: "" (空)または、FromパラメータとToパラメータでのみ期間を設定することもできます。 |
|
| From | 1 | sparkline.time_period.from | 絶対時刻 (YYYY-MM-DD hh:mm:ss) または 相対時刻 構文 (now、now/d、now/w-1w など) の有効な時刻文字列。デフォルト: now-1h。 パラメーターの動作: - 期間 が設定されていない場合は サポートされます |
|
| 終了 | 1 | sparkline.time_period.to | 絶対時刻 (YYYY-MM-DD hh:mm:ss) または 相対時刻 構文 (now、now/d、now/w-1w など) の有効な時刻文字列。デフォルト: now。 パラメーターの動作: - 期間 が設定されていない場合は サポートされます |
|
| 履歴データ | 0 | sparkline.history | 0 - (デフォルト) 自動; 1 - 履歴; 2 - 傾向 |
|
例
次の例は、Item cardウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。 ダッシュボードの設定の詳細については、dashboard.createを参照してください。
アイテムカード ウィジェットの設定
"説明"、"最新データ"、"トリガー"、"タグ" の各セクションを表示する アイテムカード ウィジェットを設定します。
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "itemcard",
"name": "Item card",
"x": 0,
"y": 0,
"width": 14,
"height": 7,
"view_mode": 0,
"fields": [
{
"type": 4,
"name": "itemid.0",
"value": 42257
},
{
"type": 0,
"name": "sections.0",
"value": 0
},
{
"type": 0,
"name": "sections.1",
"value": 3
},
{
"type": 0,
"name": "sections.2",
"value": 5
},
{
"type": 0,
"name": "sections.3",
"value": 9
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}Response: