[comment]: # aside: 1
[comment]: # translation:outdated
[comment]: # ({02b4b5b1-1d7fc2e5})
# 模版仪表盘对象
以下对象与 `templatedashboard` API 直接相关。
[comment]: # ({/02b4b5b1-1d7fc2e5})
[comment]: # ({06d621db-e0343baf})
### 模版仪表盘
模版仪表盘对象有下列属性。
|属性|[类型](/manual/api/reference_commentary#数据类型)|描述|
|--|--|------|
|dashboardid|ID|模版仪表板的ID。
[属性行为](/manual/api/reference_commentary#属性行为):
- *只读*
- 对于更新操作是*必需* 的|
|name|string|模版仪表盘的名称。
[属性行为](/manual/api/reference_commentary#属性行为r):
- 对于创建操作是*必需* 的|
|templateid|ID|仪表板所属模板的ID。
[属性行为](/manual/api/reference_commentary#属性行为):
- *常量*
- 对于创建操作是*必需* 的|
|display\_period|integer|默认页面显示时段 (单位是秒).
可能的值: 10, 30, 60, 120, 600, 1800, 3600.
默认: 30.|
|auto\_start|integer|自动开始幻灯片播放.
可能的值:
0 - 关闭自动开始幻灯片播放;
1 - *(默认)* 打开自动开始幻灯片播放。|
|uuid|string|用于将导入的模板仪表板链接到已有仪表板的通用唯一标识符。如果未提供，将自动生成。|
[comment]: # ({/06d621db-e0343baf})
[comment]: # ({07911138-69f1df50})
### 模版仪表盘页面
模板仪表盘页面对象具有以下属性。
|属性|[类型](/manual/api/reference_commentary#数据类型)|描述|
|--|--|------|
|dashboard\_pageid|ID|仪表盘页面的 ID 。
[属性行为](/manual/api/reference_commentary#属性行为):
- *只读*|
|name|string|仪表盘页面名称。
默认: 空的字符串。|
|display\_period|integer|仪表盘页面显示时段 (单位是秒)。
可能的值: 0, 10, 30, 60, 120, 600, 1800, 3600.
默认: 0 (会使用页面默认显示时段)。|
|widgets|array|[模版仪表盘组件](object#模版仪表盘组件) 对象的数组。|
[comment]: # ({/07911138-69f1df50})
[comment]: # ({40cd5b41-9c7cc873})
### 模版仪表盘组件
模板仪表板组件对象具有以下属性。
|属性|[类型](/manual/api/reference_commentary#数据类型)|描述|
|--|--|------|
|widgetid|ID|仪表盘组件的 ID 。
[属性行为](/manual/api/reference_commentary#属性行为):
- *只读*|
|type|string|仪表盘组件的类型。
可能的值:
actionlog - 操作日志;
clock - 时钟;
*(已弃用)* dataover - 数据概览;
discovery - 发现状态;
favgraphs - 收藏的图表;
favmaps - 收藏的拓扑图;
gauge - 仪表;
graph - 图形 (经典);
graphprototype - 图形原型;
honeycomb - 蜂窝;
hostavail - 主机可用性;
hostnavigator - 主机导航;
itemnavigator - 监控项导航;
item - 监控项的值;
map - 地理地图;
navtree - 拓扑图导航树;
piechart - 饼图;
plaintext - 纯文本;
problemhosts - 问题主机;
problems - 问题;
problemsbysv - 问题严重性;
slareport - SLA 报告;
svggraph - Graph;
systeminfo - 系统信息;
tophosts - Top 主机;
toptriggers - Top 触发器;
trigover - 触发器概述;
url - 网址;
web - Web 监控.
[属性行为](/manual/api/reference_commentary#属性行为):
- *必需*|
|name|string|自定义组件名称。|
|x|integer|仪表盘左侧的水平位置。
可能值的范围从 0 到 71。|
|y|integer|仪表盘顶部的垂直位置。
可能值的范围从 0 到 63。|
|width|integer|组件的宽度。
可能值的范围从 1 到 72。|
|height|integer|组件的高度。
可能值的范围从 1 到 64。|
|view\_mode|integer|组件视图模式。
可能的值:
0 - *(默认)* 默认组件视图;
1 - 隐藏标题;|
|fields|array|[模版仪表盘组件字段](object#模版仪表盘组件字段) 对象的数组。|
[comment]: # ({/40cd5b41-9c7cc873})
[comment]: # ({95c3b01e-76d2eb3b})
### 模版仪表盘组件字段
模版仪表盘组件字段对象有下列属性。
|属性|[类型](/manual/api/reference_commentary#数据类型)|描述|
|--|--|------|
|type|integer|组件字段类型。
可能的值:
0 - 整数;
1 - 字符串;
4 - 监控项;
5 - 监控项原型;
6 - 图形;
7 - 图形原型;
8 - 地图;
9 - 服务;
10 - 服务水平协议 SLA;
11 - 用户;
12 - 动作;
13 - 媒介类型。
[属性行为](/manual/api/reference_commentary#属性行为):
- *必需*|
|name|string|组件字段名称。
可能的值: 查看 [仪表盘组件字段](/manual/api/reference/dashboard/widget_fields)。请注意，在模版仪表盘上配置组件时，某些与主机相关的参数 (例如，*主机组*、*排除主机组* 和 *主机* 在 [*问题*](/manual/api/reference/dashboard/widget_fields/problems#参数) 组件中，*主机组* 在 [*主机可用性*](/manual/api/reference/dashboard/widget_fields/host_availability#参数) 组件中，等等。) 可能不可用。这是因为模版仪表盘只显示与模版关联的主机的数据。
[属性行为](/manual/api/reference_commentary#属性行为):
- *必需*|
|value|mixed|组件字段的值取决于类型。
可能的值: 查看 [仪表盘组件字段](/manual/api/reference/dashboard/widget_fields)。请注意，在模版仪表盘上配置组件时，某些与主机相关的参数 (例如，*主机组*、*排除主机组* 和 *主机* 在 [*问题*](/manual/api/reference/dashboard/widget_fields/problems#参数) 组件中，*主机组* 在 [*主机可用性*](/manual/api/reference/dashboard/widget_fields/host_availability#参数) 组件中，等等。) 可能不可用。这是因为模版仪表盘只显示与模版关联的主机的数据。
[属性行为](/manual/api/reference_commentary#属性行为):
- *必需*|
[comment]: # ({/95c3b01e-76d2eb3b})