Scripting API / inspection/tests/TestApi

inspection/tests/TestApi

Modules

Module	Description
External	-

Classes

ButtonTestApi

Implements

IHasTestFocusEvents

Implements

IFocusableTest

Implements

IClickableTest

Implements

IUpdateablePropertyTest

Extends

• TestApi

Implements

• IHasTestFocusEvents
• IFocusableTest
• IClickableTest
• IUpdateablePropertyTest

Properties

Property	Type	Inherited from
scriptId	string	TestApi.scriptId
testType	InspectionTest	TestApi.testType

Methods

focus()

focus(): Promise<void>

Moves the focus to this test. This does nothing if the test is not in the currently-running sub-inspection or the global tag area.

Returns

Promise<void>

Implementation of

IFocusableTest.focus

getProperties()

getProperties(): Promise<ButtonTestWorkerGet>

Gets the test's properties

Returns

Promise<ButtonTestWorkerGet>

Implementation of

IUpdateablePropertyTest.getProperties

onClick()

onClick(fn): ScriptEventSubscription

Bind a function to fire after a button test was clicked.

Parameters

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

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

IClickableTest.onClick

onFocusIn()

onFocusIn(fn): ScriptEventSubscription

Bind a function to fire after a test gained focus.

Parameters

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

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

IHasTestFocusEvents.onFocusIn

onFocusOut()

onFocusOut(fn): ScriptEventSubscription

Bind a function to fire after a test lost focus.

Parameters

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

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

IHasTestFocusEvents.onFocusOut

updateProperties()

updateProperties(newProps): Promise<void>

Updates the test with new values.

Parameters

Parameter	Type	Description
newProps	ButtonTestWorkerUpdate	Object with new properties to use

Returns

Promise<void>

Implementation of

IUpdateablePropertyTest.updateProperties

---

ChartTestApi

Implements

IUpdateablePropertyTest

Extends

• TestApi

Implements

• IUpdateablePropertyTest

Properties

Property	Type	Inherited from
scriptId	string	TestApi.scriptId
testType	InspectionTest	TestApi.testType

Methods

getProperties()

getProperties(): Promise<ChartTestWorkerGet>

Gets the test's properties

Returns

Promise<ChartTestWorkerGet>

Implementation of

IUpdateablePropertyTest.getProperties

updateProperties()

updateProperties(newProps): Promise<any>

Updates the test with new values.

Parameters

Parameter	Type	Description
newProps	ChartTestWorkerUpdate	Object with new properties to use

Returns

Promise<any>

Implementation of

IUpdateablePropertyTest.updateProperties

---

DataCanvasTestApi

Implements

IUpdateablePropertyTest

Extends

• TestApi

Type Parameters

Type Parameter
T extends string

Implements

• IUpdateablePropertyTest

Properties

Property	Type	Overrides	Inherited from
scriptId	string	-	TestApi.scriptId
subInspectionId	string	TestApi.subInspectionId	-
testType	InspectionTest	-	TestApi.testType

Methods

addInputTest()

addInputTest(testProperties, location): Promise<void>

AddDataCanvass an Input test with the given properties to this group test

Parameters

Parameter	Type	Description
testProperties	CopyableCreate<InputTestDataCanvasWorkerCreate, string>	The properties with which the test will be initialized
location	DataCanvasItemLocation	The location to place the test at as a percentage. Optionally includes a width as a percentage.

Returns

Promise<void>

addLabelTest()

addLabelTest(testProperties, location): Promise<void>

Adds a Label test with the given properties to this group test

Parameters

Parameter	Type	Description
testProperties	CopyableCreate<LabelTestDataCanvasWorkerCreate, string>	The properties with which the test will be initialized
location	DataCanvasItemLocation	-

Returns

Promise<void>

addPassFailTest()

addPassFailTest(testProperties, location): Promise<void>

AddDataCanvass a Pass/Fail test with the given properties to this group test

Parameters

Parameter	Type	Description
testProperties	CopyableCreate<PassFailTestDataCanvasWorkerCreate, string>	The properties with which the test will be initialized
location	DataCanvasItemLocation	The location to place the test at as a percentage. Optionally includes a width as a percentage.

Returns

Promise<void>

addSPCTest()

addSPCTest(testProperties, location): Promise<void>

AddDataCanvass an SPC test with the given properties to this group test

Parameters

Parameter	Type	Description
testProperties	CopyableCreate<SPCTestDataCanvasWorkerCreate, string>	The properties with which the test will be initialized
location	DataCanvasItemLocation[]	The locations to place the test inputs as a percentage. Optionally includes a width as a percentage. If the array has fewer elements than the subgroup size, the first element will be used for the remaining inputs. If the array has more elements than the subgroup size, the extra elements will be ignored.

Returns

Promise<void>

addTaskTest()

addTaskTest(testProperties, location): Promise<void>

AddDataCanvass a Task test with the given properties to this group test

Parameters

Parameter	Type	Description
testProperties	CopyableCreate<TaskTestDataCanvasWorkerCreate, string>	The properties with which the test will be initialized
location	DataCanvasItemLocation	The location to place the test at as a percentage. Optionally includes a width as a percentage.

Returns

Promise<void>

getProperties()

getProperties(): Promise<DataCanvasTestWorkerGet>

Gets the test's properties

Returns

Promise<DataCanvasTestWorkerGet>

Implementation of

IUpdateablePropertyTest.getProperties

updateProperties()

updateProperties(newProps): Promise<any>

Updates the test with new values.

Parameters

Parameter	Type	Description
newProps	DataCanvasTestWorkerUpdate	Object with new properties to use

Returns

Promise<any>

Implementation of

IUpdateablePropertyTest.updateProperties

---

DateTimeTestApi

Implements

IHasTestFocusEvents

Implements

IFocusableTest

Implements

IUpdateablePropertyTest

Implements

IValueTest

Extends

• TestApi

Implements

• IHasTestFocusEvents
• IFocusableTest
• IUpdateablePropertyTest
• IValueTest

Properties

Property	Type	Inherited from
scriptId	string	TestApi.scriptId
testType	InspectionTest	TestApi.testType

Methods

clearValue()

clearValue(): Promise<void>

Clears a currently-running test's value. This throws an error if the test is not in the currently-running sub-inspection or the global tag area.

Returns

Promise<void>

Implementation of

IValueTest.clearValue

focus()

focus(): Promise<void>

Moves the focus to this test. This does nothing if the test is not in the currently-running sub-inspection or the global tag area.

Returns

Promise<void>

Implementation of

IFocusableTest.focus

getProperties()

getProperties(): Promise<DateTimeTestWorkerGet>

Gets the test's properties

Returns

Promise<DateTimeTestWorkerGet>

Implementation of

IUpdateablePropertyTest.getProperties

onFocusIn()

onFocusIn(fn): ScriptEventSubscription

Bind a function to fire after a test gained focus.

Parameters

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

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

IHasTestFocusEvents.onFocusIn

onFocusOut()

onFocusOut(fn): ScriptEventSubscription

Bind a function to fire after a test lost focus.

Parameters

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

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

IHasTestFocusEvents.onFocusOut

updateProperties()

updateProperties(newProps): Promise<any>

Updates the test with new values.

Parameters

Parameter	Type	Description
newProps	DateTimeTestWorkerUpdate	Object with new properties to use

Returns

Promise<any>

Implementation of

IUpdateablePropertyTest.updateProperties

---

DefectListTestApi

Implements

IHasTestFocusEvents

Implements

IFocusableTest

Implements

IUpdateablePropertyTest

Implements

IValueTest

Implements

IDataTest

Extends

• TestApi

Implements

• IHasTestFocusEvents
• IFocusableTest
• IDataTest
• IUpdateablePropertyTest
• IValueTest

Properties

Property	Type	Inherited from
scriptId	string	TestApi.scriptId
testType	InspectionTest	TestApi.testType

Methods

clearValue()

clearValue(): Promise<void>

Clears a currently-running test's value. This throws an error if the test is not in the currently-running sub-inspection or the global tag area.

Returns

Promise<void>

Implementation of

IValueTest.clearValue

focus()

focus(): Promise<void>

Moves the focus to this test. This does nothing if the test is not in the currently-running sub-inspection or the global tag area.

Returns

Promise<void>

Implementation of

IFocusableTest.focus

getProperties()

getProperties(): Promise<DefectListTestWorkerGet>

Gets the test's properties

Returns

Promise<DefectListTestWorkerGet>

Implementation of

IUpdateablePropertyTest.getProperties

onFocusIn()

onFocusIn(fn): ScriptEventSubscription

Bind a function to fire after a test gained focus.

Parameters

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

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

IHasTestFocusEvents.onFocusIn

onFocusOut()

onFocusOut(fn): ScriptEventSubscription

Bind a function to fire after a test lost focus.

Parameters

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

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

IHasTestFocusEvents.onFocusOut

onRTFChanged()

onRTFChanged(fn): ScriptEventSubscription

Bind a function to fire after a real-time failure has changed.

Parameters

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

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

IDataTest.onRTFChanged

updateProperties()

updateProperties(newProps): Promise<any>

Updates the test with new values.

Parameters

Parameter	Type	Description
newProps	DefectListTestWorkerUpdate	Object with new properties to use

Returns

Promise<any>

Implementation of

IUpdateablePropertyTest.updateProperties

---

FileTestApi

Implements

IUpdateablePropertyTest

Extends

• TestApi

Implements

• IUpdateablePropertyTest

Properties

Property	Type	Inherited from
scriptId	string	TestApi.scriptId
testType	InspectionTest	TestApi.testType

Methods

getProperties()

getProperties(): Promise<FileTestWorkerGet>

Gets the test's properties

Returns

Promise<FileTestWorkerGet>

Implementation of

IUpdateablePropertyTest.getProperties

updateProperties()

updateProperties(newProps): Promise<any>

Updates the test with new values.

Parameters

Parameter	Type	Description
newProps	FileTestWorkerUpdate	Object with new properties to use

Returns

Promise<any>

Implementation of

IUpdateablePropertyTest.updateProperties

---

GroupTestApi

Implements

IUpdateablePropertyTest

Extends

• TestApi

Type Parameters

Type Parameter
T extends string

Implements

• IUpdateablePropertyTest

Properties

Property	Type	Inherited from
scriptId	string	TestApi.scriptId
testType	InspectionTest	TestApi.testType

Methods

addButtonTest()

addButtonTest(testProperties): Promise<void>

Adds a button test with the given properties to this group test

Parameters

Parameter	Type
testProperties	CopyableCreate<ButtonTestWorkerCreate, string>

Returns

Promise<void>

addChartTest()

addChartTest(testProperties): Promise<void>

Adds a Chart test with the given properties to this group test

Parameters

Parameter	Type	Description
testProperties	CopyableCreate<ChartTestWorkerCreate, string>	The properties with which the test will be initialized

Returns

Promise<void>

addDateTimeTest()

addDateTimeTest(testProperties): Promise<void>

Adds a Date/Time test with the given properties to this group test

Parameters

Parameter	Type	Description
testProperties	DateTimeTestWorkerCreate	The properties with which the test will be initialized

Returns

Promise<void>

addDefectListTest()

addDefectListTest(testProperties): Promise<void>

Adds a Defect List test with the given properties to this group test

Parameters

Parameter	Type	Description
testProperties	CopyableCreate<DefectListTestWorkerCreate, string>	The properties with which the test will be initialized

Returns

Promise<void>

addFileTest()

addFileTest(testProperties): Promise<void>

Adds a File/URL test with the given properties to this group test

Parameters

Parameter	Type	Description
testProperties	CopyableCreate<FileTestWorkerCreate, string>	The properties with which the test will be initialized

Returns

Promise<void>

addGroupTest()

addGroupTest(testProperties): Promise<void>

Adds a Group test with the given properties to this group test

Parameters

Parameter	Type	Description
testProperties	CopyableCreate<GroupTestWorkerCreate, string>	The properties with which the test will be initialized

Returns

Promise<void>

addInputTest()

addInputTest(testProperties): Promise<void>

Adds an Input test with the given properties to this group test

Parameters

Parameter	Type	Description
testProperties	CopyableCreate<InputTestWorkerCreate, string>	The properties with which the test will be initialized

Returns

Promise<void>

addLabelTest()

addLabelTest(testProperties): Promise<void>

Adds a Label test with the given properties to this group test

Parameters

Parameter	Type	Description
testProperties	CopyableCreate<LabelTestWorkerCreate, string>	The properties with which the test will be initialized

Returns

Promise<void>

addOEETest()

addOEETest(testProperties): Promise<void>

Adds an OEE test with the given properties to this group test

Parameters

Parameter	Type	Description
testProperties	CopyableCreate<OEETestWorkerCreate, string>	The properties with which the test will be initialized

Returns

Promise<void>

addPartTest()

addPartTest(testProperties): Promise<void>

Adds a Part test with the given properties to this group test

Parameters

Parameter	Type	Description
testProperties	PartTestWorkerCreate	The properties with which the test will be initialized

Returns

Promise<void>

addPassFailTest()

addPassFailTest(testProperties): Promise<void>

Adds a Pass/Fail test with the given properties to this group test

Parameters

Parameter	Type	Description
testProperties	CopyableCreate<PassFailTestWorkerCreate, string>	The properties with which the test will be initialized

Returns

Promise<void>

addProcessTest()

addProcessTest(testProperties): Promise<void>

Adds a Process test with the given properties to this group test

Parameters

Parameter	Type	Description
testProperties	ProcessTestWorkerCreate	The properties with which the test will be initialized

Returns

Promise<void>

addRatingTest()

addRatingTest(testProperties): Promise<void>

Adds a Rating test with the given properties to this group test

Parameters

Parameter	Type	Description
testProperties	CopyableCreate<RatingTestWorkerCreate, string>	The properties with which the test will be initialized

Returns

Promise<void>

addSPCTest()

addSPCTest(testProperties): Promise<void>

Adds an SPC test with the given properties to this group test

Parameters

Parameter	Type	Description
testProperties	CopyableCreate<SPCTestWorkerCreate, string>	The properties with which the test will be initialized

Returns

Promise<void>

addTaskTest()

addTaskTest(testProperties): Promise<void>

Adds a Task test with the given properties to this group test

Parameters

Parameter	Type	Description
testProperties	CopyableCreate<TaskTestWorkerCreate, string>	The properties with which the test will be initialized

Returns

Promise<void>

addTraceabilityTest()

addTraceabilityTest(testProperties): Promise<void>

Adds a Traceability test with the given properties to this group test

Parameters

Parameter	Type	Description
testProperties	CopyableCreate<TraceabilityTestWorkerCreate, string>	The properties with which the test will be initialized

Returns

Promise<void>

getProperties()

getProperties(): Promise<GroupTestWorkerGet>

Gets the test's properties

Returns

Promise<GroupTestWorkerGet>

Implementation of

IUpdateablePropertyTest.getProperties

updateProperties()

updateProperties(newProps): Promise<void>

Updates the test with new values.

Parameters

Parameter	Type	Description
newProps	GroupTestWorkerUpdate	Object with new properties to use

Returns

Promise<void>

Implementation of

IUpdateablePropertyTest.updateProperties

---

InputTestApi

Implements

IHasTestFocusEvents

Implements

IFocusableTest

Implements

ISelectableTest

Implements

IUpdateablePropertyTest

Implements

IValueTest

Extends

• TestApi

Implements

• IPaginatableTest
• IHasTestFocusEvents
• IFocusableTest
• ISelectableTest
• IUpdateablePropertyTest
• IValueTest

Properties

Property	Type	Inherited from
scriptId	string	TestApi.scriptId
testType	InspectionTest	TestApi.testType

Methods

clearValue()

clearValue(): Promise<void>

Clears a currently-running test's value. This throws an error if the test is not in the currently-running sub-inspection or the global tag area.

Returns

Promise<void>

Implementation of

IValueTest.clearValue

focus()

focus(): Promise<void>

Moves the focus to this test. This does nothing if the test is not in the currently-running sub-inspection or the global tag area.

Returns

Promise<void>

Implementation of

IFocusableTest.focus

getProperties()

getProperties(): Promise<InputTestWorkerGet>

Gets the test's properties

Returns

Promise<InputTestWorkerGet>

Implementation of

IUpdateablePropertyTest.getProperties

onFocusIn()

onFocusIn(fn): ScriptEventSubscription

Bind a function to fire after a test gained focus.

Parameters

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

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

IHasTestFocusEvents.onFocusIn

onFocusOut()

onFocusOut(fn): ScriptEventSubscription

Bind a function to fire after a test lost focus.

Parameters

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

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

IHasTestFocusEvents.onFocusOut

onOptionSelected()

onOptionSelected(fn): ScriptEventSubscription

Bind a function to fire when an option was selected on a selectable test.

Parameters

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

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

ISelectableTest.onOptionSelected

onPaginate()

onPaginate(fn): ScriptEventSubscription

Bind a function to fire whenever pagination is requested. To return the pagination data, call setResponse() on the event. This expects a ListApiResponse.

Parameters

Parameter	Type	Description
fn	(event) => Promise<void>	The function to fire. The event data will be a ListRequestOptions.

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

IPaginatableTest.onPaginate

updateProperties()

updateProperties(newProps): Promise<any>

Updates the test with new values.

Parameters

Parameter	Type	Description
newProps	InputTestWorkerUpdate	Object with new properties to use

Returns

Promise<any>

Implementation of

IUpdateablePropertyTest.updateProperties

---

LabelTestApi

Implements

IHasTestFocusEvents

Implements

IFocusableTest

Implements

IUpdateablePropertyTest

Extends

• TestApi

Implements

• IHasTestFocusEvents
• IFocusableTest
• IUpdateablePropertyTest

Properties

Property	Type	Inherited from
scriptId	string	TestApi.scriptId
testType	InspectionTest	TestApi.testType

Methods

focus()

focus(): Promise<void>

Moves the focus to this test. This does nothing if the test is not in the currently-running sub-inspection or the global tag area.

Returns

Promise<void>

Implementation of

IFocusableTest.focus

getProperties()

getProperties(): Promise<LabelTestWorkerGet>

Gets the test's properties

Returns

Promise<LabelTestWorkerGet>

Implementation of

IUpdateablePropertyTest.getProperties

onFocusIn()

onFocusIn(fn): ScriptEventSubscription

Bind a function to fire after a test gained focus.

Parameters

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

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

IHasTestFocusEvents.onFocusIn

onFocusOut()

onFocusOut(fn): ScriptEventSubscription

Bind a function to fire after a test lost focus.

Parameters

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

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

IHasTestFocusEvents.onFocusOut

updateProperties()

updateProperties(newProps): Promise<any>

Updates the test with new values.

Parameters

Parameter	Type	Description
newProps	LabelTestWorkerUpdate	Object with new properties to use

Returns

Promise<any>

Implementation of

IUpdateablePropertyTest.updateProperties

---

OEETestApi

Implements

IHasTestFocusEvents

Implements

IFocusableTest

Implements

ISelectableTest

Implements

IUpdateablePropertyTest

Implements

IValueTest

Implements

IDataTest

Extends

• TestApi

Implements

• IHasTestFocusEvents
• IFocusableTest
• IDataTest
• IUpdateablePropertyTest
• IValueTest

Properties

Property	Type	Inherited from
scriptId	string	TestApi.scriptId
testType	InspectionTest	TestApi.testType

Methods

clearValue()

clearValue(): Promise<void>

Clears a currently-running test's value. This throws an error if the test is not in the currently-running sub-inspection or the global tag area.

Returns

Promise<void>

Implementation of

IValueTest.clearValue

focus()

focus(): Promise<void>

Moves the focus to this test. This does nothing if the test is not in the currently-running sub-inspection or the global tag area.

Returns

Promise<void>

Implementation of

IFocusableTest.focus

getProperties()

getProperties(): Promise<OEETestWorkerGet>

Gets the test's properties

Returns

Promise<OEETestWorkerGet>

Implementation of

IUpdateablePropertyTest.getProperties

onFocusIn()

onFocusIn(fn): ScriptEventSubscription

Bind a function to fire after a test gained focus.

Parameters

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

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

IHasTestFocusEvents.onFocusIn

onFocusOut()

onFocusOut(fn): ScriptEventSubscription

Bind a function to fire after a test lost focus.

Parameters

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

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

IHasTestFocusEvents.onFocusOut

onRTFChanged()

onRTFChanged(fn): ScriptEventSubscription

Bind a function to fire after a real-time failure has changed.

Parameters

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

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

IDataTest.onRTFChanged

updateProperties()

updateProperties(newProps): Promise<any>

Updates the test with new values.

Parameters

Parameter	Type	Description
newProps	OEETestWorkerUpdate	Object with new properties to use

Returns

Promise<any>

Implementation of

IUpdateablePropertyTest.updateProperties

---

PartTestApi

Implements

IFocusableTest

Implements

IUpdateablePropertyTest

Implements

ISelectableTest

Extends

• TestApi

Implements

• IFocusableTest
• IUpdateablePropertyTest
• ISelectableTest

Properties

Property	Type	Inherited from
scriptId	string	TestApi.scriptId
testType	InspectionTest	TestApi.testType

Methods

focus()

focus(): Promise<void>

Moves the focus to this test. This does nothing if the test is not in the currently-running sub-inspection or the global tag area.

Returns

Promise<void>

Implementation of

IFocusableTest.focus

getProperties()

getProperties(): Promise<PartTestWorkerGet>

Gets the test's properties

Returns

Promise<PartTestWorkerGet>

Implementation of

IUpdateablePropertyTest.getProperties

onOptionSelected()

onOptionSelected(fn): ScriptEventSubscription

Bind a function to fire when an option was selected on a selectable test.

Parameters

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

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

ISelectableTest.onOptionSelected

updateProperties()

updateProperties(newProps): Promise<any>

Updates the test with new values.

Parameters

Parameter	Type	Description
newProps	PartTestWorkerUpdate	Object with new properties to use

Returns

Promise<any>

Implementation of

IUpdateablePropertyTest.updateProperties

---

PassFailTestApi

Implements

IHasTestFocusEvents

Implements

IFocusableTest

Implements

ISelectableTest

Implements

IDataTest

Implements

IUpdateablePropertyTest

Implements

IValueTest

Extends

• TestApi

Implements

• IHasTestFocusEvents
• IFocusableTest
• ISelectableTest
• IDataTest
• IUpdateablePropertyTest
• IValueTest

Properties

Property	Type	Inherited from
scriptId	string	TestApi.scriptId
testType	InspectionTest	TestApi.testType

Methods

clearValue()

clearValue(): Promise<void>

Clears a currently-running test's value. This throws an error if the test is not in the currently-running sub-inspection or the global tag area.

Returns

Promise<void>

Implementation of

IValueTest.clearValue

focus()

focus(): Promise<void>

Moves the focus to this test. This does nothing if the test is not in the currently-running sub-inspection or the global tag area.

Returns

Promise<void>

Implementation of

IFocusableTest.focus

getProperties()

getProperties(): Promise<PassFailTestWorkerGet>

Gets the test's properties

Returns

Promise<PassFailTestWorkerGet>

Implementation of

IUpdateablePropertyTest.getProperties

onFocusIn()

onFocusIn(fn): ScriptEventSubscription

Bind a function to fire after a test gained focus.

Parameters

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

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

IHasTestFocusEvents.onFocusIn

onFocusOut()

onFocusOut(fn): ScriptEventSubscription

Bind a function to fire after a test lost focus.

Parameters

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

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

IHasTestFocusEvents.onFocusOut

onOptionSelected()

onOptionSelected(fn): ScriptEventSubscription

Bind a function to fire when an option was selected on a selectable test.

Parameters

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

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

ISelectableTest.onOptionSelected

onRTFChanged()

onRTFChanged(fn): ScriptEventSubscription

Bind a function to fire after a real-time failure has changed.

Parameters

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

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

IDataTest.onRTFChanged

updateProperties()

updateProperties(newProps): Promise<any>

Updates the test with new values.

Parameters

Parameter	Type	Description
newProps	PassFailTestWorkerUpdate	Object with new properties to use

Returns

Promise<any>

Implementation of

IUpdateablePropertyTest.updateProperties

---

ProcessTestApi

Implements

IHasTestFocusEvents

Implements

IFocusableTest

Implements

ISelectableTest

Implements

IUpdateablePropertyTest

Implements

IValueTest

Extends

• TestApi

Implements

• IHasTestFocusEvents
• IFocusableTest
• ISelectableTest
• IUpdateablePropertyTest
• IValueTest

Properties

Property	Type	Inherited from
scriptId	string	TestApi.scriptId
testType	InspectionTest	TestApi.testType

Methods

clearValue()

clearValue(): Promise<void>

Clears a currently-running test's value. This throws an error if the test is not in the currently-running sub-inspection or the global tag area.

Returns

Promise<void>

Implementation of

IValueTest.clearValue

focus()

focus(): Promise<void>

Moves the focus to this test. This does nothing if the test is not in the currently-running sub-inspection or the global tag area.

Returns

Promise<void>

Implementation of

IFocusableTest.focus

getProperties()

getProperties(): Promise<ProcessTestWorkerGet>

Gets the test's properties

Returns

Promise<ProcessTestWorkerGet>

Implementation of

IUpdateablePropertyTest.getProperties

onFocusIn()

onFocusIn(fn): ScriptEventSubscription

Bind a function to fire after a test gained focus.

Parameters

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

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

IHasTestFocusEvents.onFocusIn

onFocusOut()

onFocusOut(fn): ScriptEventSubscription

Bind a function to fire after a test lost focus.

Parameters

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

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

IHasTestFocusEvents.onFocusOut

onOptionSelected()

onOptionSelected(fn): ScriptEventSubscription

Bind a function to fire when an option was selected on a selectable test.

Parameters

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

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

ISelectableTest.onOptionSelected

updateProperties()

updateProperties(newProps): Promise<any>

Updates the test with new values.

Parameters

Parameter	Type	Description
newProps	ProcessTestWorkerUpdate	Object with new properties to use

Returns

Promise<any>

Implementation of

IUpdateablePropertyTest.updateProperties

---

RatingTestApi

Implements

IHasTestFocusEvents

Implements

IFocusableTest

Implements

ISelectableTest

Implements

IUpdateablePropertyTest

Implements

IValueTest

Implements

IDataTest

Extends

• TestApi

Implements

• IHasTestFocusEvents
• IFocusableTest
• ISelectableTest
• IDataTest
• IUpdateablePropertyTest
• IValueTest

Properties

Property	Type	Inherited from
scriptId	string	TestApi.scriptId
testType	InspectionTest	TestApi.testType

Methods

clearValue()

clearValue(): Promise<void>

Clears a currently-running test's value. This throws an error if the test is not in the currently-running sub-inspection or the global tag area.

Returns

Promise<void>

Implementation of

IValueTest.clearValue

focus()

focus(): Promise<void>

Moves the focus to this test. This does nothing if the test is not in the currently-running sub-inspection or the global tag area.

Returns

Promise<void>

Implementation of

IFocusableTest.focus

getProperties()

getProperties(): Promise<RatingTestWorkerGet>

Gets the test's properties

Returns

Promise<RatingTestWorkerGet>

Implementation of

IUpdateablePropertyTest.getProperties

onFocusIn()

onFocusIn(fn): ScriptEventSubscription

Bind a function to fire after a test gained focus.

Parameters

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

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

IHasTestFocusEvents.onFocusIn

onFocusOut()

onFocusOut(fn): ScriptEventSubscription

Bind a function to fire after a test lost focus.

Parameters

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

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

IHasTestFocusEvents.onFocusOut

onOptionSelected()

onOptionSelected(fn): ScriptEventSubscription

Bind a function to fire when an option was selected on a selectable test.

Parameters

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

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

ISelectableTest.onOptionSelected

onRTFChanged()

onRTFChanged(fn): ScriptEventSubscription

Bind a function to fire after a real-time failure has changed.

Parameters

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

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

IDataTest.onRTFChanged

updateProperties()

updateProperties(newProps): Promise<any>

Updates the test with new values.

Parameters

Parameter	Type	Description
newProps	RatingTestWorkerUpdate	Object with new properties to use

Returns

Promise<any>

Implementation of

IUpdateablePropertyTest.updateProperties

---

SPCTestApi

Implements

IHasTestFocusEvents

Implements

IFocusableTest

Implements

IUpdateablePropertyTest

Implements

IValueTest

Implements

IDataTest

Extends

• TestApi

Implements

• IHasTestFocusEvents
• IFocusableTest
• IDataTest
• IUpdateablePropertyTest
• IValueTest

Properties

Property	Type	Inherited from
scriptId	string	TestApi.scriptId
testType	InspectionTest	TestApi.testType

Methods

clearValue()

clearValue(): Promise<void>

Clears a currently-running test's value. This throws an error if the test is not in the currently-running sub-inspection or the global tag area.

Returns

Promise<void>

Implementation of

IValueTest.clearValue

focus()

focus(): Promise<void>

Moves the focus to this test. This does nothing if the test is not in the currently-running sub-inspection or the global tag area.

Returns

Promise<void>

Implementation of

IFocusableTest.focus

getProperties()

getProperties(): Promise<SPCTestWorkerGet>

Gets the test's properties

Returns

Promise<SPCTestWorkerGet>

Implementation of

IUpdateablePropertyTest.getProperties

onFocusIn()

onFocusIn(fn): ScriptEventSubscription

Bind a function to fire after a test gained focus.

Parameters

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

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

IHasTestFocusEvents.onFocusIn

onFocusOut()

onFocusOut(fn): ScriptEventSubscription

Bind a function to fire after a test lost focus.

Parameters

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

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

IHasTestFocusEvents.onFocusOut

onRTFChanged()

onRTFChanged(fn): ScriptEventSubscription

Bind a function to fire after a real-time failure has changed.

Parameters

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

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

IDataTest.onRTFChanged

updateProperties()

updateProperties(newProps): Promise<any>

Updates the test with new values.

Parameters

Parameter	Type	Description
newProps	SPCTestWorkerUpdate	Object with new properties to use

Returns

Promise<any>

Implementation of

IUpdateablePropertyTest.updateProperties

---

TaskTestApi

Implements

IHasTestFocusEvents

Implements

IFocusableTest

Implements

ISelectableTest

Implements

IUpdateablePropertyTest

Implements

IValueTest

Extends

• TestApi

Implements

• IHasTestFocusEvents
• IFocusableTest
• ISelectableTest
• IUpdateablePropertyTest
• IValueTest

Properties

Property	Type	Inherited from
scriptId	string	TestApi.scriptId
testType	InspectionTest	TestApi.testType

Methods

clearValue()

clearValue(): Promise<void>

Clears a currently-running test's value. This throws an error if the test is not in the currently-running sub-inspection or the global tag area.

Returns

Promise<void>

Implementation of

IValueTest.clearValue

focus()

focus(): Promise<void>

Moves the focus to this test. This does nothing if the test is not in the currently-running sub-inspection or the global tag area.

Returns

Promise<void>

Implementation of

IFocusableTest.focus

getProperties()

getProperties(): Promise<TaskTestWorkerGet>

Gets the test's properties

Returns

Promise<TaskTestWorkerGet>

Implementation of

IUpdateablePropertyTest.getProperties

onFocusIn()

onFocusIn(fn): ScriptEventSubscription

Bind a function to fire after a test gained focus.

Parameters

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

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

IHasTestFocusEvents.onFocusIn

onFocusOut()

onFocusOut(fn): ScriptEventSubscription

Bind a function to fire after a test lost focus.

Parameters

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

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

IHasTestFocusEvents.onFocusOut

onOptionSelected()

onOptionSelected(fn): ScriptEventSubscription

Bind a function to fire when an option was selected on a selectable test.

Parameters

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

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

ISelectableTest.onOptionSelected

updateProperties()

updateProperties(newProps): Promise<any>

Updates the test with new values.

Parameters

Parameter	Type	Description
newProps	TaskTestWorkerUpdate	Object with new properties to use

Returns

Promise<any>

Implementation of

IUpdateablePropertyTest.updateProperties

---

abstract TestApi

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

Extends

• CoreTestApi

Extended by

• PassFailTestApi
• TraceabilityTestApi
• ProcessTestApi
• DateTimeTestApi
• SPCTestApi
• DefectListTestApi
• RatingTestApi
• TaskTestApi
• OEETestApi
• FileTestApi
• LabelTestApi
• InputTestApi
• ButtonTestApi
• ChartTestApi
• PartTestApi
• DataCanvasTestApi
• GroupTestApi

Properties

Property	Type	Overrides
scriptId	string	CoreTestApi.scriptId
testType	InspectionTest	CoreTestApi.testType

---

TraceabilityTestApi

Implements

IHasTestFocusEvents

Implements

IFocusableTest

Implements

ISelectableTest

Implements

IUpdateablePropertyTest

Implements

IValueTest

Extends

• TestApi

Implements

• IHasTestFocusEvents
• IFocusableTest
• ISelectableTest
• IUpdateablePropertyTest
• IValueTest

Properties

Property	Type	Inherited from
scriptId	string	TestApi.scriptId
testType	InspectionTest	TestApi.testType

Methods

clearValue()

clearValue(): Promise<void>

Clears a currently-running test's value. This throws an error if the test is not in the currently-running sub-inspection or the global tag area.

Returns

Promise<void>

Implementation of

IValueTest.clearValue

focus()

focus(): Promise<void>

Moves the focus to this test. This does nothing if the test is not in the currently-running sub-inspection or the global tag area.

Returns

Promise<void>

Implementation of

IFocusableTest.focus

getProperties()

getProperties(): Promise<TraceabilityTestWorkerGet>

Gets the test's properties

Returns

Promise<TraceabilityTestWorkerGet>

Implementation of

IUpdateablePropertyTest.getProperties

onFocusIn()

onFocusIn(fn): ScriptEventSubscription

Bind a function to fire after a test gained focus.

Parameters

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

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

IHasTestFocusEvents.onFocusIn

onFocusOut()

onFocusOut(fn): ScriptEventSubscription

Bind a function to fire after a test lost focus.

Parameters

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

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

IHasTestFocusEvents.onFocusOut

onOptionSelected()

onOptionSelected(fn): ScriptEventSubscription

Bind a function to fire when an option was selected on a selectable test.

Parameters

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

Returns

ScriptEventSubscription

ScriptEventSubscription

Implementation of

ISelectableTest.onOptionSelected

updateProperties()

updateProperties(newProps): Promise<any>

Updates the test with new values.

Parameters

Parameter	Type	Description
newProps	TraceabilityTestWorkerUpdate	Object with new properties to use

Returns

Promise<any>

Implementation of

IUpdateablePropertyTest.updateProperties