Scripting API / dashboard/DashboardApi / External
External
Type Aliases
AccountabilityChartType
AccountabilityChartType = "accountabilityData"
ChartType
ChartType = SPCChartType | DMSChartType | OEEChartType | TaskChartType | AccountabilityChartType | "statsGrid" | "box" | "scatter" | "scriptedChart"
DashboardItemType
DashboardItemType = NonDataDashboardItemType | ChartType
DashboardWorkerGet
DashboardWorkerGet = object
Properties
| Property |
Type |
Description |
autoRefresh? |
number |
How frequently the dashboard should automatically refresh, in minutes. If undefined, the dashboard will never automatically refresh. |
fitToScreen |
boolean |
When set, charts will automatically shrink to fit onto a single screen without scrolling. |
items |
object[] |
The script id and type of all the items on this dashboard. |
name |
string |
The dashboard name. |
retrievals |
string[] |
The script ids of all the retrievals on this dashboard. |
DashboardWorkerUpdate
DashboardWorkerUpdate = object
Properties
| Property |
Type |
Description |
autoRefresh? |
number | null |
Change how frequently the dashboard should automatically refresh, in minutes. Set to null to disable automatic refreshes. |
fitToScreen? |
boolean |
Change whether the charts will automatically shrink to fit onto a single screen without scrolling. |
name? |
string |
Change the dashboard name. |
DMSChartType
DMSChartType = "pareto" | "trend" | "dmsData"
NonDataDashboardItemType
NonDataDashboardItemType = "button" | "label"
OEEChartType
OEEChartType = "oee" | "oeeData"
SPCChartType
SPCChartType = "control" | "histogram" | "spcData"
TaskChartType
TaskChartType = "taskData"