10 Graph prototype

説明

これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、dashboard.createメソッドおよびdashboard.updateメソッドでグラフのプロトタイプウィジェットを設定できます。

ウィジェットのfieldsプロパティは、ダッシュボードの作成または更新時に検証されません。 これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新してしまうリスクも生じます。 グラフのプロトタイプウィジェットを正常に作成または更新するには、以下の表に記載されているパラメーター要件を参照してください。

パラメーター

グラフプロトタイプウィジェットでは、以下のパラメーターがサポートされています。

パラメーター type name value
更新間隔 0 rf_rate 0 - 更新なし;
10 - 10秒;
30 - 30秒;
60 - (デフォルト) 1分;
120 - 2分;
600 - 10分;
900 - 15分
ソース 0 source_type 2 - (デフォルト) グラフプロトタイプ;
3 - シンプルグラフプロトタイプ
グラフ プロトタイプ 7 graphid グラフ プロトタイプ ID

ソースが「グラフ プロトタイプ」に設定されている場合は、パラメーター グラフ プロトタイプ が必要です。
アイテム プロトタイプ 5 itemid アイテム プロトタイプ ID

ソースが「シンプル グラフ プロトタイプ」に設定されている場合は、パラメーター アイテム プロトタイプ が必要です。
凡例の表示 0 show_legend 0 - 無効
1 - (デフォルト) 有効
動的アイテム 0 dynamic 0 - (デフォルト) 無効
1 - 有効
列 0 列 有効な値の範囲は 1～24 です。

デフォルト: 2
行 0 行 有効な値の範囲は 1 ～ 16 です。

デフォルト: 1

例

次の例は、グラフのプロトタイプウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。 ダッシュボードの設定の詳細については、dashboard.createを参照してください。

グラフのプロトタイプウィジェットの設定

ローレベルディスカバリによってアイテムのプロトタイプ(ID: "42316")から作成された3つのグラフ(3列、1行)のグリッドを表示するグラフのプロトタイプウィジェットを設定します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "graphprototype",
                        "name": "Graph prototype",
                        "x": 0,
                        "y": 0,
                        "width": 16,
                        "height": 5,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 0,
                                "name": "source_type",
                                "value": 3
                            },
                            {
                                "type": 5,
                                "name": "itemid",
                                "value": 42316
                            },
                            {
                                "type": 0,
                                "name": "columns",
                                "value": 3
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

レスポンス:

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

参照