Sidebar

10 Graph prototype

Description

These parameters and the possible property values for the respective dashboard widget field objects allow to configure the Graph prototype widget in dashboard.create and dashboard.update methods.

Parameters

The following parameters are supported for the Graph prototype widget.

Parameter type name value
Refresh interval 0 rf_rate 0 - No refresh;
10 - 10 seconds;
30 - 30 seconds;
60 - (default) 1 minute;
120 - 2 minutes;
600 - 10 minutes;
900 - 15 minutes.
Source 0 source_type 2 - (default) Graph prototype;
3 - Simple graph prototype.
Graph prototype 7 graphid Graph prototype ID.

Parameter Graph prototype required if Source is set to "Graph prototype".
Item prototype 5 itemid Item prototype ID.

Parameter Item prototype required if Source is set to "Simple graph prototype".
Show legend 0 show_legend 0 - Disabled;
1 - (default) Enabled.
Dynamic item 0 dynamic 0 - (default) Disabled;
1 - Enabled.
Columns 0 columns Valid values range from 1-24.

Default: 2.
Rows 0 rows Valid values range from 1-16.

Default: 1.

Examples

The following examples aim to only describe the configuration of the dashboard widget field objects for the Graph prototype widget. For more information on configuring a dashboard, see dashboard.create.

Configuring a Graph prototype widget

Configure a Graph prototype widget that displays a grid of 3 graphs (3 columns, 1 row) created from an item prototype (ID: "42316") by low-level discovery.

Request:

{
           "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
       }

Response:

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

See also