Scripting API / dashboard/dashitems/DashboardItemApi
dashboard/dashitems/DashboardItemApi
Modules
| Module | Description |
|---|---|
| External | - |
Classes
AccountabilityDataChartApi
Extends
Implements
Methods
getProperties()
getProperties():
Promise<AccountabilityDataChartWorkerGet>
Gets the dashboard item's properties
Returns
Promise<AccountabilityDataChartWorkerGet>
Implementation of
IUpdateablePropertyDashboardItem.getProperties
isReady()
isReady():
Promise<void>
Returns a promise which resolves when the chart is ready to be interacted with.
If the chart is currently loading, this promise will resolve when it has finished.
Returns
Promise<void>
Inherited from
onBeforeDraw()
onBeforeDraw(
fn):ScriptEventSubscription
Bind a function to fire before the chart draws with new data.
Any changes to event.data will not be reflected in the drawn chart.
Parameters
| Parameter | Type | Description |
|---|---|---|
fn |
(event) => void |
The function to fire. |
Returns
ScriptEventSubscription
Implementation of
IBeforeDrawableChart.onBeforeDraw
refresh()
refresh():
Promise<void>
Refreshes this chart without retrieving data for the rest of the retrieval.
When called, onBeforeRetrieval will only contain data for this chart.
Returns
Promise<void>
Inherited from
updateProperties()
updateProperties(
newProps):Promise<void>
Updates the dashboard item with new values.
Parameters
| Parameter | Type | Description |
|---|---|---|
newProps |
AccountabilityDataChartWorkerUpdate |
Object with new properties to use |
Returns
Promise<void>
Implementation of
IUpdateablePropertyDashboardItem.updateProperties
ButtonDashboardItemApi
Extends
Implements
Methods
getProperties()
getProperties():
Promise<ButtonDashboardItemWorkerGet>
Gets the dashboard item's properties
Returns
Promise<ButtonDashboardItemWorkerGet>
Implementation of
IUpdateablePropertyDashboardItem.getProperties
onClick()
onClick(
fn):ScriptEventSubscription
Bind a function to fire when the button is clicked.
Parameters
| Parameter | Type | Description |
|---|---|---|
fn |
(event) => void |
The function to fire. |
Returns
ScriptEventSubscription
updateProperties()
updateProperties(
newProps):Promise<void>
Updates the dashboard item with new values.
Parameters
| Parameter | Type | Description |
|---|---|---|
newProps |
ButtonDashboardItemWorkerUpdate |
Object with new properties to use |
Returns
Promise<void>
Implementation of
IUpdateablePropertyDashboardItem.updateProperties
abstract ChartApi
Extends
Extended by
Methods
isReady()
isReady():
Promise<void>
Returns a promise which resolves when the chart is ready to be interacted with.
If the chart is currently loading, this promise will resolve when it has finished.
Returns
Promise<void>
abstract ChartWithRefreshApi
Extends
Extended by
ControlChartApiHistogramChartApiSPCDataChartApiParetoChartApiDMSTrendChartApiDMSDataChartApiOEEChartApiOEEDataChartApiTaskDataChartApiAccountabilityDataChartApiStatsGridChartApi
Methods
isReady()
isReady():
Promise<void>
Returns a promise which resolves when the chart is ready to be interacted with.
If the chart is currently loading, this promise will resolve when it has finished.
Returns
Promise<void>
Inherited from
refresh()
refresh():
Promise<void>
Refreshes this chart without retrieving data for the rest of the retrieval.
When called, onBeforeRetrieval will only contain data for this chart.
Returns
Promise<void>
ControlChartApi
Extends
Implements
Methods
getProperties()
getProperties():
Promise<ControlChartWorkerGet>
Gets the dashboard item's properties
Returns
Promise<ControlChartWorkerGet>
Implementation of
IUpdateablePropertyDashboardItem.getProperties
isReady()
isReady():
Promise<void>
Returns a promise which resolves when the chart is ready to be interacted with.
If the chart is currently loading, this promise will resolve when it has finished.
Returns
Promise<void>
Inherited from
onBeforeDraw()
onBeforeDraw(
fn):ScriptEventSubscription
Bind a function to fire before the chart draws with new data.
Any changes to event.data.plotlyData will be reflected in the drawn chart.
Changing any of the plots in event.data.plotlyData will cause the click events to no longer fire on this chart.
Parameters
| Parameter | Type | Description |
|---|---|---|
fn |
(event) => void |
The function to fire. |
Returns
ScriptEventSubscription
Implementation of
IBeforeDrawUpdatableChart.onBeforeDraw
refresh()
refresh():
Promise<void>
Refreshes this chart without retrieving data for the rest of the retrieval.
When called, onBeforeRetrieval will only contain data for this chart.
Returns
Promise<void>
Inherited from
updateProperties()
updateProperties(
newProps):Promise<void>
Updates the dashboard item with new values.
Parameters
| Parameter | Type | Description |
|---|---|---|
newProps |
ControlChartWorkerUpdate |
Object with new properties to use |
Returns
Promise<void>
Implementation of
IUpdateablePropertyDashboardItem.updateProperties
abstract DashboardItemApi
Extended by
DMSDataChartApi
Extends
Implements
Methods
getProperties()
getProperties():
Promise<DMSDataChartWorkerGet>
Gets the dashboard item's properties
Returns
Promise<DMSDataChartWorkerGet>
Implementation of
IUpdateablePropertyDashboardItem.getProperties
isReady()
isReady():
Promise<void>
Returns a promise which resolves when the chart is ready to be interacted with.
If the chart is currently loading, this promise will resolve when it has finished.
Returns
Promise<void>
Inherited from
onBeforeDraw()
onBeforeDraw(
fn):ScriptEventSubscription
Bind a function to fire before the chart draws with new data.
Any changes to event.data will not be reflected in the drawn chart.
Parameters
| Parameter | Type | Description |
|---|---|---|
fn |
(event) => void |
The function to fire. |
Returns
ScriptEventSubscription
Implementation of
IBeforeDrawableChart.onBeforeDraw
refresh()
refresh():
Promise<void>
Refreshes this chart without retrieving data for the rest of the retrieval.
When called, onBeforeRetrieval will only contain data for this chart.
Returns
Promise<void>
Inherited from
updateProperties()
updateProperties(
newProps):Promise<void>
Updates the dashboard item with new values.
Parameters
| Parameter | Type | Description |
|---|---|---|
newProps |
DMSDataChartWorkerUpdate |
Object with new properties to use |
Returns
Promise<void>
Implementation of
IUpdateablePropertyDashboardItem.updateProperties
DMSTrendChartApi
Extends
Implements
Methods
getProperties()
getProperties():
Promise<DMSTrendChartWorkerGet>
Gets the dashboard item's properties
Returns
Promise<DMSTrendChartWorkerGet>
Implementation of
IUpdateablePropertyDashboardItem.getProperties
isReady()
isReady():
Promise<void>
Returns a promise which resolves when the chart is ready to be interacted with.
If the chart is currently loading, this promise will resolve when it has finished.
Returns
Promise<void>
Inherited from
onBeforeDraw()
onBeforeDraw(
fn):ScriptEventSubscription
Bind a function to fire before the chart draws with new data.
Any changes to event.data.plotlyData will be reflected in the drawn chart.
Changing any of the plots in event.data.plotlyData will cause the click events to no longer fire on this chart.
Parameters
| Parameter | Type | Description |
|---|---|---|
fn |
(event) => void |
The function to fire. |
Returns
ScriptEventSubscription
Implementation of
IBeforeDrawUpdatableChart.onBeforeDraw
refresh()
refresh():
Promise<void>
Refreshes this chart without retrieving data for the rest of the retrieval.
When called, onBeforeRetrieval will only contain data for this chart.
Returns
Promise<void>
Inherited from
updateProperties()
updateProperties(
newProps):Promise<void>
Updates the dashboard item with new values.
Parameters
| Parameter | Type | Description |
|---|---|---|
newProps |
DMSTrendChartWorkerUpdate |
Object with new properties to use |
Returns
Promise<void>
Implementation of
IUpdateablePropertyDashboardItem.updateProperties
HistogramChartApi
Extends
Implements
Methods
getProperties()
getProperties():
Promise<HistogramChartWorkerGet>
Gets the dashboard item's properties
Returns
Promise<HistogramChartWorkerGet>
Implementation of
IUpdateablePropertyDashboardItem.getProperties
isReady()
isReady():
Promise<void>
Returns a promise which resolves when the chart is ready to be interacted with.
If the chart is currently loading, this promise will resolve when it has finished.
Returns
Promise<void>
Inherited from
onBeforeDraw()
onBeforeDraw(
fn):ScriptEventSubscription
Bind a function to fire before the chart draws with new data.
Any changes to event.data.plotlyData will be reflected in the drawn chart.
Changing any of the plots in event.data.plotlyData will cause the click events to no longer fire on this chart.
Parameters
| Parameter | Type | Description |
|---|---|---|
fn |
(event) => void |
The function to fire. |
Returns
ScriptEventSubscription
Implementation of
IBeforeDrawUpdatableChart.onBeforeDraw
refresh()
refresh():
Promise<void>
Refreshes this chart without retrieving data for the rest of the retrieval.
When called, onBeforeRetrieval will only contain data for this chart.
Returns
Promise<void>
Inherited from
updateProperties()
updateProperties(
newProps):Promise<void>
Updates the dashboard item with new values.
Parameters
| Parameter | Type | Description |
|---|---|---|
newProps |
HistogramChartWorkerUpdate |
Object with new properties to use |
Returns
Promise<void>
Implementation of
IUpdateablePropertyDashboardItem.updateProperties
LabelDashboardItemApi
Extends
Implements
Methods
getProperties()
getProperties():
Promise<LabelDashboardItemWorkerGet>
Gets the dashboard item's properties
Returns
Promise<LabelDashboardItemWorkerGet>
Implementation of
IUpdateablePropertyDashboardItem.getProperties
updateProperties()
updateProperties(
newProps):Promise<void>
Updates the dashboard item with new values.
Parameters
| Parameter | Type | Description |
|---|---|---|
newProps |
LabelDashboardItemWorkerUpdate |
Object with new properties to use |
Returns
Promise<void>
Implementation of
IUpdateablePropertyDashboardItem.updateProperties
OEEChartApi
Extends
Implements
Methods
getProperties()
getProperties():
Promise<OEEChartWorkerGet>
Gets the dashboard item's properties
Returns
Promise<OEEChartWorkerGet>
Implementation of
IUpdateablePropertyDashboardItem.getProperties
isReady()
isReady():
Promise<void>
Returns a promise which resolves when the chart is ready to be interacted with.
If the chart is currently loading, this promise will resolve when it has finished.
Returns
Promise<void>
Inherited from
onBeforeDraw()
onBeforeDraw(
fn):ScriptEventSubscription
Bind a function to fire before the chart draws with new data.
Any changes to event.data.plotlyData will be reflected in the drawn chart.
Changing any of the plots in event.data.plotlyData will cause the click events to no longer fire on this chart.
Parameters
| Parameter | Type | Description |
|---|---|---|
fn |
(event) => void |
The function to fire. |
Returns
ScriptEventSubscription
Implementation of
IBeforeDrawUpdatableChart.onBeforeDraw
refresh()
refresh():
Promise<void>
Refreshes this chart without retrieving data for the rest of the retrieval.
When called, onBeforeRetrieval will only contain data for this chart.
Returns
Promise<void>
Inherited from
updateProperties()
updateProperties(
newProps):Promise<void>
Updates the dashboard item with new values.
Parameters
| Parameter | Type | Description |
|---|---|---|
newProps |
OEEChartWorkerUpdate |
Object with new properties to use |
Returns
Promise<void>
Implementation of
IUpdateablePropertyDashboardItem.updateProperties
OEEDataChartApi
Extends
Implements
Methods
getProperties()
getProperties():
Promise<OEEDataChartWorkerGet>
Gets the dashboard item's properties
Returns
Promise<OEEDataChartWorkerGet>
Implementation of
IUpdateablePropertyDashboardItem.getProperties
isReady()
isReady():
Promise<void>
Returns a promise which resolves when the chart is ready to be interacted with.
If the chart is currently loading, this promise will resolve when it has finished.
Returns
Promise<void>
Inherited from
onBeforeDraw()
onBeforeDraw(
fn):ScriptEventSubscription
Bind a function to fire before the chart draws with new data.
Any changes to event.data will not be reflected in the drawn chart.
Parameters
| Parameter | Type | Description |
|---|---|---|
fn |
(event) => void |
The function to fire. |
Returns
ScriptEventSubscription
Implementation of
IBeforeDrawableChart.onBeforeDraw
refresh()
refresh():
Promise<void>
Refreshes this chart without retrieving data for the rest of the retrieval.
When called, onBeforeRetrieval will only contain data for this chart.
Returns
Promise<void>
Inherited from
updateProperties()
updateProperties(
newProps):Promise<void>
Updates the dashboard item with new values.
Parameters
| Parameter | Type | Description |
|---|---|---|
newProps |
OEEDataChartWorkerUpdate |
Object with new properties to use |
Returns
Promise<void>
Implementation of
IUpdateablePropertyDashboardItem.updateProperties
ParetoChartApi
Extends
Implements
Methods
getProperties()
getProperties():
Promise<ParetoChartWorkerGet>
Gets the dashboard item's properties
Returns
Promise<ParetoChartWorkerGet>
Implementation of
IUpdateablePropertyDashboardItem.getProperties
isReady()
isReady():
Promise<void>
Returns a promise which resolves when the chart is ready to be interacted with.
If the chart is currently loading, this promise will resolve when it has finished.
Returns
Promise<void>
Inherited from
onBeforeDraw()
onBeforeDraw(
fn):ScriptEventSubscription
Bind a function to fire before the chart draws with new data.
Any changes to event.data.plotlyData will be reflected in the drawn chart.
Changing any of the plots in event.data.plotlyData will cause the click events to no longer fire on this chart.
Parameters
| Parameter | Type | Description |
|---|---|---|
fn |
(event) => void |
The function to fire. |
Returns
ScriptEventSubscription
Implementation of
IBeforeDrawUpdatableChart.onBeforeDraw
refresh()
refresh():
Promise<void>
Refreshes this chart without retrieving data for the rest of the retrieval.
When called, onBeforeRetrieval will only contain data for this chart.
Returns
Promise<void>
Inherited from
updateProperties()
updateProperties(
newProps):Promise<void>
Updates the dashboard item with new values.
Parameters
| Parameter | Type | Description |
|---|---|---|
newProps |
ParetoChartWorkerUpdate |
Object with new properties to use |
Returns
Promise<void>
Implementation of
IUpdateablePropertyDashboardItem.updateProperties
ScriptedChartApi
Extends
Implements
Methods
addLoading()
addLoading():
Promise<void>
Adds a loading overlay to the chart.
Returns
Promise<void>
draw()
draw(
data):Promise<void>
Draws the chart with the given plotly data.
Parameters
| Parameter | Type | Description |
|---|---|---|
data |
GraphData[] |
The plotly (https://plotly.com/javascript/reference/) data to draw. |
Returns
Promise<void>
getProperties()
getProperties():
Promise<DashboardItemWorkerGet>
Gets the dashboard item's properties
Returns
Promise<DashboardItemWorkerGet>
Implementation of
IUpdateablePropertyDashboardItem.getProperties
isReady()
isReady():
Promise<void>
Returns a promise which resolves when the chart is ready to be interacted with.
If the chart is currently loading, this promise will resolve when it has finished.
Returns
Promise<void>
Inherited from
onClick()
onClick(
fn):ScriptEventSubscription
Bind a function to fire when a plot is clicked.
Parameters
| Parameter | Type | Description |
|---|---|---|
fn |
(event) => void |
The function to fire. |
Returns
ScriptEventSubscription
removeLoading()
removeLoading():
Promise<void>
Removes a loading overlay from the chart.
Returns
Promise<void>
updateProperties()
updateProperties(
newProps):Promise<void>
Updates the dashboard item with new values.
Parameters
| Parameter | Type | Description |
|---|---|---|
newProps |
DashboardItemWorkerUpdate |
Object with new properties to use |
Returns
Promise<void>
Implementation of
IUpdateablePropertyDashboardItem.updateProperties
SPCDataChartApi
Extends
Implements
Methods
getProperties()
getProperties():
Promise<SPCDataChartWorkerGet>
Gets the dashboard item's properties
Returns
Promise<SPCDataChartWorkerGet>
Implementation of
IUpdateablePropertyDashboardItem.getProperties
isReady()
isReady():
Promise<void>
Returns a promise which resolves when the chart is ready to be interacted with.
If the chart is currently loading, this promise will resolve when it has finished.
Returns
Promise<void>
Inherited from
onBeforeDraw()
onBeforeDraw(
fn):ScriptEventSubscription
Bind a function to fire before the chart draws with new data.
Any changes to event.data will not be reflected in the drawn chart.
Parameters
| Parameter | Type | Description |
|---|---|---|
fn |
(event) => void |
The function to fire. |
Returns
ScriptEventSubscription
Implementation of
IBeforeDrawableChart.onBeforeDraw
refresh()
refresh():
Promise<void>
Refreshes this chart without retrieving data for the rest of the retrieval.
When called, onBeforeRetrieval will only contain data for this chart.
Returns
Promise<void>
Inherited from
updateProperties()
updateProperties(
newProps):Promise<void>
Updates the dashboard item with new values.
Parameters
| Parameter | Type | Description |
|---|---|---|
newProps |
SPCDataChartWorkerUpdate |
Object with new properties to use |
Returns
Promise<void>
Implementation of
IUpdateablePropertyDashboardItem.updateProperties
StatsGridChartApi
Extends
Implements
Methods
getProperties()
getProperties():
Promise<StatsGridChartWorkerGet>
Gets the dashboard item's properties
Returns
Promise<StatsGridChartWorkerGet>
Implementation of
IUpdateablePropertyDashboardItem.getProperties
isReady()
isReady():
Promise<void>
Returns a promise which resolves when the chart is ready to be interacted with.
If the chart is currently loading, this promise will resolve when it has finished.
Returns
Promise<void>
Inherited from
onBeforeDraw()
onBeforeDraw(
fn):ScriptEventSubscription
Parameters
| Parameter | Type |
|---|---|
fn |
(event) => void |
Returns
refresh()
refresh():
Promise<void>
Refreshes this chart without retrieving data for the rest of the retrieval.
When called, onBeforeRetrieval will only contain data for this chart.
Returns
Promise<void>
Inherited from
updateProperties()
updateProperties(
newProps):Promise<void>
Updates the dashboard item with new values.
Parameters
| Parameter | Type | Description |
|---|---|---|
newProps |
StatsGridChartWorkerUpdate |
Object with new properties to use |
Returns
Promise<void>
Implementation of
IUpdateablePropertyDashboardItem.updateProperties
TaskDataChartApi
Extends
Implements
Methods
getProperties()
getProperties():
Promise<TaskDataChartWorkerGet>
Gets the dashboard item's properties
Returns
Promise<TaskDataChartWorkerGet>
Implementation of
IUpdateablePropertyDashboardItem.getProperties
isReady()
isReady():
Promise<void>
Returns a promise which resolves when the chart is ready to be interacted with.
If the chart is currently loading, this promise will resolve when it has finished.
Returns
Promise<void>
Inherited from
onBeforeDraw()
onBeforeDraw(
fn):ScriptEventSubscription
Bind a function to fire before the chart draws with new data.
Any changes to event.data will not be reflected in the drawn chart.
Parameters
| Parameter | Type | Description |
|---|---|---|
fn |
(event) => void |
The function to fire. |
Returns
ScriptEventSubscription
Implementation of
IBeforeDrawableChart.onBeforeDraw
refresh()
refresh():
Promise<void>
Refreshes this chart without retrieving data for the rest of the retrieval.
When called, onBeforeRetrieval will only contain data for this chart.
Returns
Promise<void>
Inherited from
updateProperties()
updateProperties(
newProps):Promise<void>
Updates the dashboard item with new values.
Parameters
| Parameter | Type | Description |
|---|---|---|
newProps |
TaskDataChartWorkerUpdate |
Object with new properties to use |
Returns
Promise<void>
Implementation of
IUpdateablePropertyDashboardItem.updateProperties
Interfaces
IBeforeDrawableChart
Extended by
Methods
onBeforeDraw()
onBeforeDraw(
fn):ScriptEventSubscription
Bind a function to fire before the chart draws with new data.
Any changes to event.data will not be reflected in the drawn chart.
Parameters
| Parameter | Type | Description |
|---|---|---|
fn |
(event) => void |
The function to fire. |
Returns
ScriptEventSubscription
IBeforeDrawUpdatableChart
Extends
Methods
onBeforeDraw()
onBeforeDraw(
fn):ScriptEventSubscription
Bind a function to fire before the chart draws with new data.
Any changes to event.data.plotlyData will be reflected in the drawn chart.
Changing any of the plots in event.data.plotlyData will cause the click events to no longer fire on this chart.
Parameters
| Parameter | Type | Description |
|---|---|---|
fn |
(event) => void |
The function to fire. |
Returns
ScriptEventSubscription
Overrides
IBeforeDrawableChart.onBeforeDraw
IUpdateablePropertyDashboardItem
Methods
getProperties()
getProperties():
Promise<any>
Gets the dashboard item's properties
Returns
Promise<any>
updateProperties()
updateProperties(
newProps):Promise<any>
Updates the dashboard item with new values.
Parameters
| Parameter | Type | Description |
|---|---|---|
newProps |
Record<string, any> |
Object with new properties to use |
Returns
Promise<any>