Scripting API / dashboard/retrievals/RetrievalApi / External

External

Classes

PreventDefaultScriptEvent

Extends

• ScriptEvent

Extended by

• RetrievalBeforeScriptEvent
• SubInspectionBeforeEndScriptEvent

Properties

Property	Type	Default value	Inherited from
data	any	undefined	ScriptEvent.data

Accessors

isDefaultPrevented

Get Signature

get isDefaultPrevented(): boolean

Returns

boolean

isPropagationStopped

Get Signature

get isPropagationStopped(): boolean

Returns

boolean

Inherited from

ScriptEvent.isPropagationStopped

Methods

preventDefault()

preventDefault(): void

Stop this event from taking the action that it normally would. This does not prevent future event handlers from executing on this event

Returns

void

stopPropagation()

stopPropagation(): void

Stop this event from continuing to the next event handler. This does not prevent any default behaviors from occurring

Returns

void

Inherited from

ScriptEvent.stopPropagation

---

RetrievalBeforeScriptEvent

Extends

• PreventDefaultScriptEvent

Properties

Property	Modifier	Type	Inherited from
data	public	RetrievalEventData	PreventDefaultScriptEvent.data

Accessors

isDefaultPrevented

Get Signature

get isDefaultPrevented(): boolean

Returns

boolean

Inherited from

PreventDefaultScriptEvent.isDefaultPrevented

isPropagationStopped

Get Signature

get isPropagationStopped(): boolean

Returns

boolean

Inherited from

PreventDefaultScriptEvent.isPropagationStopped

Methods

preventDefault()

preventDefault(): void

Stop this event from taking the action that it normally would. This does not prevent future event handlers from executing on this event

Returns

void

Inherited from

PreventDefaultScriptEvent.preventDefault

stopPropagation()

stopPropagation(): void

Stop this event from continuing to the next event handler. This does not prevent any default behaviors from occurring

Returns

void

Inherited from

PreventDefaultScriptEvent.stopPropagation

Type Aliases

AccountabilityDataWorkerRetrievalSettings

AccountabilityDataWorkerRetrievalSettings = NonSPCChartWorkerRetrievalSettings & object

Type Declaration

Name	Type
type	"accountabilityData"

---

AccountabilityWorkerRetrievalSettings

AccountabilityWorkerRetrievalSettings = AccountabilityDataWorkerRetrievalSettings

---

ChartWorkerRetrievalSettings

ChartWorkerRetrievalSettings = SPCWorkerRetrievalSettings | DMSWorkerRetrievalSettings | OEEWorkerRetrievalSettings | TaskWorkerRetrievalSettings | AccountabilityWorkerRetrievalSettings | StatsGridWorkerRetrievalSettings

---

ChartWorkerRetrievalSettings

ChartWorkerRetrievalSettings = object

Properties

Property	Type	Description
id	string	Used to uniquely identify additional retrieval settings. Data returned for this retrieval setting will be listed under the same id. For example, const additionalRetrievalApi = await gsApi.dashboard.retrieval('myRetrieval').alsoRetrieveWhenRefreshed([{ id: 'myAdditionalRetrieval', type: 'control', splitBy: ['characteristic'], groupBy: 'anchorPoint' }]); additionalRetrievalApi.onRetrieved(event => { // Fired when the retrieval is fetched, containing data with the provided ID console.log(event.data.response.control?.myAdditionalRetrieval) });gsApi.retrieval('my retrieval').

---

ControlChartWorkerRetrievalSettings

ControlChartWorkerRetrievalSettings = SPCChartWorkerRetrievalSettings & object

Type Declaration

Name	Type	Description
groupBy?	ControlChartGroupBy	How the data is grouped in each Control Detail. If no group by is provided, each Control Detail will only contain a single group.
type	"control"	-

---

DMSDataWorkerRetrievalSettings

DMSDataWorkerRetrievalSettings = NonSPCChartWorkerRetrievalSettings & object

Type Declaration

Name	Type
type	"dmsData"

---

DMSWorkerRetrievalSettings

DMSWorkerRetrievalSettings = ParetoWorkerRetrievalSettings | TrendWorkerRetrievalSettings | DMSDataWorkerRetrievalSettings

---

HistogramChartWorkerRetrievalSettings

HistogramChartWorkerRetrievalSettings = SPCChartWorkerRetrievalSettings & object

Type Declaration

Name	Type
type	"histogram"

---

NonSPCChartWorkerRetrievalSettings

NonSPCChartWorkerRetrievalSettings = ChartWorkerRetrievalSettings & object

Type Declaration

Name	Type	Description
splitBy	NonSPCSplitBy[]	Controls how the data retrieved from the server will be split into Details. Numbers are treated as Traceability IDs. For example, when set to ['process', 3], given that the Traceability with ID 3 is "Shift", a separate Detail will be returned for each Process / Shift combination.

---

OEEChartWorkerRetrievalSettings

OEEChartWorkerRetrievalSettings = NonSPCChartWorkerRetrievalSettings & object

Type Declaration

Name	Type	Description
groupBy?	TrendGroupBy	How the retrieved data will be grouped within each detail. Numbers are treated as Traceability IDs. If a number is provided which does not correspond to an existing Traceability ID, an error will be thrown.
groupByTime?	TimeGroupByType	How the data is aggregated by time.
type	"oee"	-

---

OEEDataWorkerRetrievalSettings

OEEDataWorkerRetrievalSettings = NonSPCChartWorkerRetrievalSettings & object

Type Declaration

Name	Type
type	"oeeData"

---

OEEWorkerRetrievalSettings

OEEWorkerRetrievalSettings = OEEChartWorkerRetrievalSettings | OEEDataWorkerRetrievalSettings

---

ParetoWorkerRetrievalSettings

ParetoWorkerRetrievalSettings = NonSPCChartWorkerRetrievalSettings & object

Type Declaration

Name	Type	Description
barMethod	ParetoBarMethodType	Controls how the data will be sorted within each detail.
groupBy	ParetoGroupBy	How the data should be grouped inside each detail.
type	"pareto"	-

---

RetrievalEventData

RetrievalEventData = object

Properties

Property	Type
retrievalId	string

---

RetrievalWorkerGet

RetrievalWorkerGet = object

Properties

Property	Type	Description
datePeriod	FixedDatePeriod | RelativeDatePeriod	The date period to retrieve data over. Either a fixed date range, or a dynamic date period.
filter?	number | FilterExpression	A filter to apply to the data. If it is a number, it will use a saved filter. If it is an object, then it is a quick filter.
includeBypassedData	RetrieveBypassType	How to include data which has been marked as 'bypassed.'
items	object[]	The script id and type of all the items on this retrieval.
maxRecords	number	The maximum number of records to fetch per standard. Will be a number between 1 and 1,000.
name	string	The retrieval name.
standards	{ characteristicIds: number[]; type: "characteristic"; } | { partIds?: number[]; processIds?: number[]; type: "partProcess"; } | { filter: FilterExpression; type: "advancedMode"; }	The standards to retrieve.

---

RetrievalWorkerUpdate

RetrievalWorkerUpdate = object

Properties

Property	Type	Description
datePeriod?	FixedDatePeriod | RelativeDatePeriod	Update the date period to retrieve data over. Either a fixed date range, or a dynamic date period.
filter?	number | FilterExpression | null	Update the filter to apply to the data. If it is a number, it will use a saved filter. If it is an object, then it is a quick filter. If it is null, then no filter will be used.
includeBypassedData?	RetrieveBypassType	Update how to include data which has been marked as 'bypassed.'
maxRecords?	number	Update the maximum number of records to fetch per standard. Must be a number between 1 and 1,000.
standards?	WorkerRetrievalStandards	Update the standards to retrieve. The retrieval standard type may not be changed, and the provided value must match the current standard type.

---

SPCChartWorkerRetrievalSettings

SPCChartWorkerRetrievalSettings = ChartWorkerRetrievalSettings & object

Type Declaration

Name	Type	Description
splitBy	SplitBy[]	Controls how the data retrieved from the server will be split into Details. Numbers are treated as Traceability IDs. For example, when set to ['process', 3], given that the Traceability with ID 3 is "Shift", a separate Detail will be returned for each Process / Shift combination.

---

SPCDataWorkerRetrievalSettings

SPCDataWorkerRetrievalSettings = SPCChartWorkerRetrievalSettings & object

Type Declaration

Name	Type
type	"spcData"

---

SPCWorkerRetrievalSettings

SPCWorkerRetrievalSettings = ControlChartWorkerRetrievalSettings | HistogramChartWorkerRetrievalSettings | SPCDataWorkerRetrievalSettings

---

StatsGridWorkerRetrievalSettings

StatsGridWorkerRetrievalSettings = SPCChartWorkerRetrievalSettings & object

Type Declaration

Name	Type	Description
stats	object	The stats to retrieve. Stats for one or more data types may be retrieved.
stats.accountability?	AccountabilityStatType[]	-
stats.dms?	DMSStatType[]	-
stats.oee?	OEEStatType[]	-
stats.spc?	SPCStatType[]	-
stats.task?	TaskStatType[]	-
type	"stats"	-

---

TaskDataWorkerRetrievalSettings

TaskDataWorkerRetrievalSettings = NonSPCChartWorkerRetrievalSettings & object

Type Declaration

Name	Type
type	"taskData"

---

TaskWorkerRetrievalSettings

TaskWorkerRetrievalSettings = TaskDataWorkerRetrievalSettings

---

TrendWorkerRetrievalSettings

TrendWorkerRetrievalSettings = NonSPCChartWorkerRetrievalSettings & object

Type Declaration

Name	Type	Description
groupBy?	TrendGroupBy	How the data is grouped in the DMS Trend Detail. When provided, DMS Trend Details will contain each combination of provided grouping and time grouping. For example, when grouping by 'process' and 'hour', each DMS Trend Detail would contain a group for 'hour 1: process 1', 'hour 2: process 1, 'hour 1: process 2', etc.
groupByTime	TimeGroupByType	How the data is aggregated by time.
type	"trend"	-