Scripting API / dashboard/DashboardApi

dashboard/DashboardApi

Modules

Module	Description
External	-

Classes

DashboardApi

Methods

accountabilityDataChart()

accountabilityDataChart(scriptId): AccountabilityDataChartApi

Allows modification, refresh, and event binding of an Accountability Data Chart with the given id.

Parameters

Parameter	Type
scriptId	string

Returns

AccountabilityDataChartApi

button()

button(scriptId): ButtonDashboardItemApi

Allows modification, and event binding of a Button Dashboard Item with the given id.

Parameters

Parameter	Type
scriptId	string

Returns

ButtonDashboardItemApi

controlChart()

controlChart(scriptId): ControlChartApi

Allows modification, refresh, and event binding of a Control Chart with the given id.

Parameters

Parameter	Type
scriptId	string

Returns

ControlChartApi

dmsDataChart()

dmsDataChart(scriptId): DMSDataChartApi

Allows modification, refresh, and event binding of a DMS Data Chart with the given id.

Parameters

Parameter	Type
scriptId	string

Returns

DMSDataChartApi

dmsTrendChart()

dmsTrendChart(scriptId): DMSTrendChartApi

Allows modification, refresh, and event binding of a DMS Trend Chart with the given id.

Parameters

Parameter	Type
scriptId	string

Returns

DMSTrendChartApi

getProperties()

getProperties(): Promise<DashboardWorkerGet>

Gets the Dashboard's properties

Returns

Promise<DashboardWorkerGet>

histogramChart()

histogramChart(scriptId): HistogramChartApi

Allows modification, refresh, and event binding of a Histogram Chart with the given id.

Parameters

Parameter	Type
scriptId	string

Returns

HistogramChartApi

label()

label(scriptId): LabelDashboardItemApi

Allows modification, and event binding of a Label Dashboard Item with the given id.

Parameters

Parameter	Type
scriptId	string

Returns

LabelDashboardItemApi

oeeChart()

oeeChart(scriptId): OEEChartApi

Allows modification, refresh, and event binding of an OEE Chart with the given id.

Parameters

Parameter	Type
scriptId	string

Returns

OEEChartApi

oeeDataChart()

oeeDataChart(scriptId): OEEDataChartApi

Allows modification, refresh, and event binding of an OEE Data Chart with the given id.

Parameters

Parameter	Type
scriptId	string

Returns

OEEDataChartApi

onReady()

onReady(fn): ScriptEventSubscription

Bind a function to fire when the Dashboard is ready.

Parameters

Parameter	Type	Description
fn	(event) => void	The function to fire.

Returns

ScriptEventSubscription

ScriptEventSubscription

onRefresh()

onRefresh(fn): ScriptEventSubscription

Bind a function to fire when the Dashboard refreshes

Parameters

Parameter	Type	Description
fn	(event) => void	The function to fire.

Returns

ScriptEventSubscription

ScriptEventSubscription

paretoChart()

paretoChart(scriptId): ParetoChartApi

Allows modification, refresh, and event binding of a Pareto Chart with the given id.

Parameters

Parameter	Type
scriptId	string

Returns

ParetoChartApi

refresh()

refresh(): Promise<void>

Refreshes all retrievals on the Dashboard

Returns

Promise<void>

retrieval()

retrieval(retrievalId): RetrievalApi

Allows modification, refresh, and event binding of a retrieval with the given id.

Parameters

Parameter	Type
retrievalId	string

Returns

RetrievalApi

scriptedChart()

scriptedChart(scriptId): ScriptedChartApi

Allows modification, refresh, and event binding of a Scripted Chart with the given id.

Parameters

Parameter	Type
scriptId	string

Returns

ScriptedChartApi

spcDataChart()

spcDataChart(scriptId): SPCDataChartApi

Allows modification, refresh, and event binding of an SPC Data Chart with the given id.

Parameters

Parameter	Type
scriptId	string

Returns

SPCDataChartApi

statsGrid()

statsGrid(scriptId): StatsGridChartApi

Allows modification, refresh, and event binding of a Stats Grid with the given id.

Parameters

Parameter	Type
scriptId	string

Returns

StatsGridChartApi

taskDataChart()

taskDataChart(scriptId): TaskDataChartApi

Allows modification, refresh, and event binding of a Task Data Chart with the given id.

Parameters

Parameter	Type
scriptId	string

Returns

TaskDataChartApi

updateProperties()

updateProperties(newProps): Promise<void>

Updates the Dashboard with new values.

Parameters

Parameter	Type	Description
newProps	DashboardWorkerUpdate	Object with new properties to use

Returns

Promise<void>