15 Plain text

説明

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

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

パラメーター

プレーンテキストウィジェットでは、以下のパラメーターがサポートされています。

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

注: 複数のアイテムを設定するには、アイテムごとにダッシュボードウィジェットフィールドオブジェクトを作成してください。
アイテム名の位置 0 スタイル 0 - (デフォルト) 左
1 - 上
表示する行数 0 show_lines 有効な値の範囲は1～100です。

デフォルト: 25。
HTMLとしてテキストを表示 0 show_as_html 0 - (デフォルト) 無効
1 - 有効
ダイナミックアイテム 0 dynamic 0 - (デフォルト) 無効
1 - 有効

例

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

プレーンテキストウィジェットの設定

アイテム"42269"と"42253"の最新データを表示するプレーンテキストウィジェットを設定します。 さらに、アイテム名をデータ列の先頭に配置し、15行のデータのみを表示するように設定します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "plaintext",
                        "name": "Plain text",
                        "x": 0,
                        "y": 0,
                        "width": 6,
                        "height": 3,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 4,
                                "name": "itemids",
                                "value": 42269
                            },
                            {
                                "type": 4,
                                "name": "itemids",
                                "value": 42253
                            },
                            {
                                "type": 0,
                                "name": "style",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "show_lines",
                                "value": 15
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

レスポンス:

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

参照