21 パイチャート

説明

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

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

パラメーター

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

パラメーター type name value
リフレッシュ間隔 0 rf_rate 0 - 更新なし
10 - 10秒
30 - 30秒
60 - (デフォルト) 1分
120 - 2分
600 - 10分
900 - 15分

データセット

以下のパラメーターは、データセット の設定に使用できます。

プロパティ名の最初の数字(例: ds.0.hosts.0、ds.0.items.0)は特定のデータセットを表し、2番目の数字がある場合は、設定されたホストまたはアイテムを表します。

Parameter type name value
データセットタイプ 0 ds.0.dataset_type 0 - アイテムリスト;
1 - (デフォルト) アイテムパターン。
アイテム 4 ds.0.itemids.0 アイテム ID。
ウィジェットを テンプレートダッシュボード 上で設定する場合は、テンプレートで設定されたアイテムのみを設定してください。

注: 複数のアイテムを設定するには、プロパティ名の番号を増やして、アイテムごとに dashboard widget field オブジェクトを作成します。

パラメーターの動作:
- 必須 (データセットタイプ が "アイテムリスト" に設定され、かつ アイテム (ウィジェット) が設定されていない場合)
アイテム (ウィジェット) 1 ds.0.itemids.0._reference アイテム ID の代わりに:
ABCDE._itemid - Reference パラメーターを "ABCDE" に設定した 互換ウィジェット を、アイテムのデータソースとして設定します。

注: 複数のウィジェットを設定するには、プロパティ名の番号を増やして、ウィジェットごとに dashboard widget field オブジェクトを作成します。

パラメーターの動作:
- 必須 (データセットタイプ が "アイテムリスト" に設定され、かつ アイテム が設定されていない場合)
1 ds.0.color.0 16進数のカラーコード(例: FF0000)。

パラメーターの動作:
- 必須 (データセットタイプ が "アイテムリスト" に設定されている場合)
アイテムタイプ 0 ds.0.type.0 0 - (デフォルト) 通常;
1 - 合計。

"合計" の値は、チャート全体で1つのアイテムにのみ設定できます。

パラメーターの動作:
- サポート対象 (データセットタイプ が "アイテムリスト" に設定されている場合)
ホストパターン 1 ds.0.hosts.0 ホスト 名またはパターン(例: "Zabbix*")。

パラメーターの動作:
- 必須 (データセットタイプ が "アイテムパターン" に設定されている場合)

このパラメーターは、テンプレートダッシュボード 上でウィジェットを設定する場合はサポートされません。
アイテムパターン 1 ds.0.items.0 アイテム 名またはパターン(例: "*: Number of processed *values per second")。

ウィジェットを テンプレートダッシュボード 上で設定する場合は、テンプレートで設定されたアイテムのパターンのみを設定してください。

パラメーターの動作:
- 必須 (データセットタイプ が "アイテムパターン" に設定されている場合)
1 ds.0.color 16進数のカラーコード(例: FF0000)。

パラメーターの動作:
- サポート対象 (データセットタイプ が "アイテムパターン" に設定され、かつ Color palette が設定されていない場合)
カラーパレット 0 ds.0.color_palette カラーパレットのインデックス。

指定可能な値の範囲は 0-11 です。

デフォルト: 0。

パラメーターの動作:
- サポート対象 (データセットタイプ が "アイテムパターン" に設定され、かつ が設定されていない場合)
集計関数 0 ds.0.aggregate_function 1 - 最小;
2 - 最大;
3 - 平均;
4 - 件数;
5 - 合計;
6 - 最初;
7 - (デフォルト) 最後。
データセット集計 0 ds.0.dataset_aggregation 0 - (デフォルト) なし;
1 - 最小;
2 - 最大;
3 - 平均;
4 - 件数;
5 - 合計。

パラメーターの動作:
- サポート対象 (アイテムタイプ が "合計" に設定されている場合)
データセットラベル 1 ds.0.data_set_label 任意の文字列値。

デフォルト: ""(空)。

Displaying options

表示オプションの設定には、以下のパラメータがサポートされています。

パラメータ type name value
履歴データの選択 0 source 0 - (default) 自動;
1 - 履歴;
2 - トレンド
描画 0 draw_type 0 - (default) 円グラフ;
1 - ドーナツグラフ
0 width 20 - 半径の 20%。
30 - 半径の 30%。
40 - 半径の 40%。
50 - (デフォルト) 半径の 50%

パラメータの動作:
- Draw が "Doughnut" に設定されている場合に サポートされます
ストローク幅 0 stroke 設定可能な値の範囲は 0~10 です。

デフォルト: 0

パラメータの動作:
- Draw が "Doughnut" に設定されている場合に サポートされます
合計値を表示 0 total_show 0 - (デフォルト) 無効;
1 - 有効。

パラメータの動作:
- Draw が"ドーナツ"に設定されている場合に サポートされます
Size 0 value_size_type 0 - (デフォルト) 自動;
1 - カスタム

パラメータの動作:
- 合計値を表示 が"有効"に設定されている場合に サポートされます
サイズ (カスタムサイズの値) 0 value_size 有効な値の範囲は 1~100 です。

デフォルト: 20

パラメータの動作:
- 合計値の表示 が"有効"に設定されている場合に サポートされます
小数点以下の桁数 0 decimal_places 有効な値の範囲は 0~6 です。

デフォルト: 2

パラメータの動作:
- 合計値の表示 が"有効"に設定されている場合に サポートされます
単位 (チェックボックス) 0 units_show 0 - (デフォルト) 無効;
1 - 有効

パラメータの動作:
- 合計値の表示 が"有効"に設定されている場合に サポートされます
単位 (値) 1 units 任意の文字列値

パラメータの動作:
- 単位 (チェックボックス) が"有効"に設定されている場合に サポートされます
太字 0 value_bold 0 - (デフォルト) 無効;
1 - 有効。

パラメータの動作:
- 合計値の表示 が"有効"に設定されている場合に サポートされます
1 value_color 16進数のカラーコード (例: FF0000)。

パラメータの動作:
- 合計値の表示 が"有効"に設定されている場合に サポートされます
セクター間のスペース 0 space 指定可能な値の範囲は0~10です。

デフォルト: 1。
N% 未満のセクターをマージ (チェックボックス) 0 merge 0 - (デフォルト) 無効;
1 - 有効。
N% 未満のセクターをマージ (値) 0 merge_percent 指定可能な値の範囲は 1~10 です。

デフォルト: 1。

パラメータの動作:
- N% 未満のセクターをマージ (チェックボックス) が"有効"に設定されている場合に サポート されます。
N% 未満のセクターをマージ (色) 1 merge_color 16 進数のカラー コード (例: FF0000)。

パラメーターの動作:
- N% 未満のセクターをマージ (チェックボックス) が "有効" に設定されている場合に サポート されます

時間期間

時間期間 を設定するために、以下のパラメータがサポートされています。

Parameter type name value
Time period 1 time_period._reference DASHBOARD._timeperiod - Time period セレクター をデータソースとして設定します。
ABCDE._timeperiod - 互換性のあるウィジェットReference パラメータが "ABCDE" に設定されているもの)をデータソースとして設定します。

デフォルト: DASHBOARD._timeperiod

または、FromTo パラメータのみで時間期間を設定することもできます。
From 1 time_period.from 絶対時間 (YYYY-MM-DD hh:mm:ss) または 相対 時刻構文 (now, now/d, now/w-1w など) で指定された有効な時間文字列。

パラメータの動作:
- Time period が設定されていない場合は supported
- time_period.to が設定されている場合は required
To 1 time_period.to 絶対時間 (YYYY-MM-DD hh:mm:ss) または 相対 時刻構文 (now, now/d, now/w-1w など) で指定された有効な時間文字列。

パラメータの動作:
- Time period が設定されていない場合は supported
- time_period.from が設定されている場合は required

Legend

凡例の設定では、以下のパラメータがサポートされています。

パラメータ type name value
凡例の表示 0 legend 0 - 無効;
1 - (デフォルト) 有効
値の表示 0 legend_value 0 - (デフォルト) 無効;
1 - 有効

パラメータの動作:
- 凡例の表示が"有効"に設定されている場合にサポートされます。
集計関数を表示 0 legend_aggregation 0 - (デフォルト) 無効;
1 - 有効

パラメータの動作:
- 凡例の表示が"有効"に設定されている場合にサポートされます
0 legend_lines_mode 0 - (デフォルト) 固定;
1 - 可変

パラメータの動作:
- 凡例の表示が"有効"に設定されている場合にサポートされます
行数/
最大行数
0 legend_lines 有効な値の範囲は 1~10 です。

デフォルト: 1.

パラメータの動作:
- 凡例の表示が"有効"に設定されている場合に サポートされます
列数 0 legend_columns 有効な値の範囲は 1~4 です。

デフォルト: 4.

パラメータの動作:
- 凡例の表示が"有効"に設定され、値の表示が"無効"に設定されている場合に サポートされます

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

円グラフウィジェットの設定

円グラフウィジェットは次のように設定します。

  • 1つのホストに合計9つのアイテムの2つのデータセット。
  • 最初のデータセットは「アイテムリスト」タイプで、すべて「通常」タイプで異なる色で表現される3つのアイテムで構成されます。
  • 2番目のデータセットは「アイテムパターン」タイプで、6つのアイテムで構成され、各アイテムに集計が設定され、カスタムカラーで表現されます。
  • 2番目のデータセットにはカスタムデータセットラベルもあります。
  • 円グラフのデータは、カスタム幅と中央に単位付きの合計値を持つドーナツグラフとして表示されます。
  • 円グラフのデータは、直近3時間のカスタム期間で表示および集計されます。
  • 円グラフの凡例には、設定されたアイテムが4行で表示されます。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "piechart",
                        "name": "Pie chart",
                        "x": 0,
                        "y": 0,
                        "width": 24,
                        "height": 5,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 0,
                                "name": "ds.0.dataset_type",
                                "value": 0
                            },
                            {
                                "type": 4,
                                "name": "ds.0.itemids.0",
                                "value": 23264
                            },
                            {
                                "type": 1,
                                "name": "ds.0.color.0",
                                "value": "FF0000"
                            },
                            {
                                "type": 0,
                                "name": "ds.0.type.0",
                                "value": 0
                            },
                            {
                                "type": 4,
                                "name": "ds.0.itemids.1",
                                "value": 23269
                            },
                            {
                                "type": 1,
                                "name": "ds.0.color.1",
                                "value": "BF00FF"
                            },
                            {
                              "type": 0,
                              "name": "ds.0.type.1",
                              "value": 0
                            },
                            {
                                "type": 4,
                                "name": "ds.0.itemids.2",
                                "value": 23257
                            },
                            {
                                "type": 1,
                                "name": "ds.0.color.2",
                                "value": "0040FF"
                            },
                            {
                              "type": 0,
                              "name": "ds.0.type.2",
                              "value": 0
                            },
                            {
                                "type": 1,
                                "name": "ds.1.hosts.0",
                                "value": "Zabbix server"
                            },
                            {
                                "type": 1,
                                "name": "ds.1.items.0",
                                "value": "*: Number of processed *values per second"
                            },
                            {
                                "type": 1,
                                "name": "ds.1.color",
                                "value": "000000"
                            },
                            {
                                "type": 0,
                                "name": "ds.1.aggregate_function",
                                "value": 3
                            },
                            {
                                "type": 1,
                                "name": "ds.1.data_set_label",
                                "value": "Number of processed values per second"
                            },
                            {
                                "type": 0,
                                "name": "draw_type",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "width",
                                "value": 30
                            },
                            {
                                "type": 0,
                                "name": "total_show",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "units_show",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "graph_time",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "time_period.from",
                                "value": "now-3h"
                            },
                            {
                                "type": 1,
                                "name": "time_period.to",
                                "value": "now"
                            },
                            {
                                "type": 0,
                                "name": "legend_lines",
                                "value": 4
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

レスポンス:

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

参照