These parameters and the possible property values for the respective dashboard widget field objects allow to configure the Plain text widget in dashboard.create
and dashboard.update
methods.
Widget fields
properties are not validated during the creation or update of a dashboard. This allows users to modify built-in widgets and create custom widgets, but also introduces the risk of creating or updating widgets incorrectly. To ensure the successful creation or update of the Plain text widget, please refer to the parameter behavior outlined in the tables below.
The following parameters are supported for the Plain text 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. |
Items | 4 | itemids.0 | Item ID. Note: To configure multiple items, create a dashboard widget field object for each item with an incremented number in the property name. Parameter behavior: - required |
Items location | 0 | style | 0 - (default) Left; 1 - Top. |
Show lines | 0 | show_lines | Possible values range from 1-100. Default: 25. |
Show text as HTML | 0 | show_as_html | 0 - (default) Disabled; 1 - Enabled. |
Override host | 1 | override_hostid._reference | ABCDE._hostid - set a compatible widget (Host navigator with its Reference parameter set to "ABCDE ") as the data source containing the host.DASHBOARD._hostid - set the dashboard Host selector as the data source containing the host.This parameter is not supported if configuring the widget on a template dashboard. |
The following examples aim to only describe the configuration of the dashboard widget field objects for the Plain text widget. For more information on configuring a dashboard, see dashboard.create
.
Configure a Plain text widget that displays latest data for items "42269" and "42253". In addition, configure the item names to be located at the top of the data columns, and only 15 lines of data to be displayed.
{
"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.0",
"value": 42269
},
{
"type": 4,
"name": "itemids.1",
"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
}
]
},
"id": 1
}
Response: