2 Clock

説明

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

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

パラメーター

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

パラメーター タイプ 名前
Refresh interval 0 rf_rate 0 - 更新なし
10 - 10秒
30 - 30秒
60 - 1分
120 - 2分
600 - 10分
900 - (デフォルト) 15分
Time type 0 time_type 0 - (デフォルト) ローカル時刻
1 - サーバー時刻
2 - ホスト時刻
Clock type 0 clock_type 0 - (デフォルト) アナログ
1 - デジタル

Time typeが"ホスト時刻"に設定されている場合、以下のパラメーターがサポートされます。

パラメーター タイプ 名前
Item 4 itemid.0 アイテムID。

パラメーターの動作:
- 必須

Clock typeが"デジタル"に設定されている場合、以下のパラメーターがサポートされます。

パラメーター タイプ 名前
Show 0 show.0 1 - 日付
2 - (デフォルト) 時刻
3 - タイムゾーン

注意: 複数の値を構成するには、プロパティ名に増分番号を付けた各値のダッシュボードウィジェットフィールドオブジェクトを作成します。

詳細設定

Clock typeが"デジタル"に設定されている場合、以下の詳細設定パラメーターがサポートされます。

パラメーター タイプ 名前
Background color 1 bg_color 16進数の色コード(例: FF0000)。

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

Clock typeが"デジタル"に設定され、Showが"日付"に設定されている場合、以下の詳細設定パラメーターがサポートされます。

パラメーター タイプ 名前
Size 0 date_size 有効な値の範囲は1-100です。

デフォルト: 20。
Bold 0 date_bold 0 - (デフォルト) 無効
1 - 有効
Color 1 date_color 16進数のカラーコード(例: FF0000)。

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

Clock typeが"デジタル"に設定され、Showが"時刻"に設定されている場合、以下の詳細設定パラメーターがサポートされます。

パラメーター タイプ 名前
Size 0 time_size 指定可能な値の範囲は1-100です。

デフォルト: 30。
Bold 0 time_bold 0 - (デフォルト) 無効
1 - 有効
Color 1 time_color 16進数のカラーコード(例: FF0000)。

デフォルト: "" (空)。
Seconds 0 time_sec 0 - 無効
1 - (デフォルト) 有効
Format 0 time_format 0 - (デフォルト) 24時間
1 - 12時間
タイムゾーン

Clock typeが"デジタル"に設定され、Showが"タイムゾーン"に設定されている場合、以下の詳細設定パラメーターがサポートされます。

パラメーター タイプ 名前
Size 0 tzone_size 有効な値の範囲は1-100です。

デフォルト: 20。
Bold 0 tzone_bold 0 - (デフォルト) 無効
1 - 有効
Color 1 tzone_color 16進数のカラーコード(例: FF0000)。

デフォルト: "" (空)。
Time zone 1 tzone_timezone 有効なタイムゾーン文字列(例: Europe/RigasystemUTCなど)。サポートされているタイムゾーンの完全なリストについては、PHPドキュメントを参照してください。

デフォルト: local

パラメータの動作:
- Time typeが"Local time"または"Server time"に設定されている場合はサポート
Format 0 tzone_format 0 - (デフォルト) 短縮形式
1 - 完全形式

パラメータの動作:
- Time typeが"Local time"または"Server time"に設定されている場合はサポート

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

時計ウィジェットの設定

カスタマイズされたデジタル時計にローカルの日付、時間、およびタイムゾーンを表示する時計ウィジェットを設定します。

リクエスト:

{
           "jsonrpc": "2.0",
           "method": "dashboard.create",
           "params": {
               "name": "My dashboard",
               "display_period": 30,
               "auto_start": 1,
               "pages": [
                   {
                       "widgets": [
                           {
                               "type": "clock",
                               "name": "Clock",
                               "x": 0,
                               "y": 0,
                               "width": 12,
                               "height": 3,
                               "view_mode": 0,
                               "fields": [
                                   {
                                       "type": 0,
                                       "name": "clock_type",
                                       "value": 1
                                   },
                                   {
                                       "type": 0,
                                       "name": "show.0",
                                       "value": 1
                                   },
                                   {
                                       "type": 0,
                                       "name": "show.1",
                                       "value": 2
                                   },
                                   {
                                       "type": 0,
                                       "name": "show.2",
                                       "value": 3
                                   },
                                   {
                                       "type": 0,
                                       "name": "date_size",
                                       "value": 20
                                   },
                                   {
                                       "type": 1,
                                       "name": "date_color",
                                       "value": "E1E1E1"
                                   },
                                   {
                                       "type": 0,
                                       "name": "time_bold",
                                       "value": 1
                                   },
                                   {
                                       "type": 0,
                                       "name": "tzone_size",
                                       "value": 10
                                   },
                                   {
                                       "type": 1,
                                       "name": "tzone_color",
                                       "value": "E1E1E1"
                                   },
                                   {
                                       "type": 1,
                                       "name": "tzone_timezone",
                                       "value": "Europe/Riga"
                                   },
                                   {
                                       "type": 0,
                                       "name": "tzone_format",
                                       "value": 1
                                   }
                               ]
                           }
                       ]
                   }
               ],
               "userGroups": [
                   {
                       "usrgrpid": 7,
                       "permission": 2
                   }
               ],
               "users": [
                   {
                       "userid": 1,
                       "permission": 3
                   }
               ]
           },
           "id": 1
       }

レスポンス:

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

参照