Class SubInspectionApi<T>

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

Implements

TestContainer

Type Parameters

T extends string

Hierarchy (view full)

CoreSubInspectionApi
- SubInspectionApi

Implements

TestContainer

Methods

addButtonTest

addButtonTest(testProperties): Promise<void>
Adds a button test with the given properties to this sub-inspection
Parameters
- testProperties: CopyableCreate<ButtonTestWorkerCreate, string>
  The properties with which the test will be initialized
Returns Promise<void>

addChartTest

addChartTest(testProperties): Promise<void>
Adds a Chart test with the given properties to this sub-inspection
Parameters
- testProperties: CopyableCreate<ChartTestWorkerCreate, string>
  The properties with which the test will be initialized
Returns Promise<void>

addDataCanvasTest

addDataCanvasTest(testProperties): Promise<void>
Adds a Data Canvas test with the given properties to this sub-inspection
Parameters
- testProperties: CopyableCreate<DataCanvasTestWorkerCreate, 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 sub-inspection
Parameters
- testProperties: DateTimeTestWorkerCreate
  The properties with which the test will be initialized
Returns Promise<void>
Implementation of TestContainer.addDateTimeTest

addDefectListTest

addDefectListTest(testProperties): Promise<void>
Adds a Defect List test with the given properties to this sub-inspection
Parameters
- testProperties: CopyableCreate<DefectListTestWorkerCreate, string>
  The properties with which the test will be initialized
Returns Promise<void>

addFileTest

addFileTest(testProperties): Promise<void>
Adds a File test with the given properties to this sub-inspection
Parameters
- 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 sub-inspection
Parameters
- 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 sub-inspection
Parameters
- 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 sub-inspection
Parameters
- 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 sub-inspection
Parameters
- 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 sub-inspection
Parameters
- 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 sub-inspection
Parameters
- 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 sub-inspection
Parameters
- testProperties: ProcessTestWorkerCreate
  The properties with which the test will be initialized
Returns Promise<void>
Implementation of TestContainer.addProcessTest

addRatingTest

addRatingTest(testProperties): Promise<void>
Adds a Rating test with the given properties to this sub-inspection
Parameters
- 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 sub-inspection
Parameters
- 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 sub-inspection
Parameters
- 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 sub-inspection
Parameters
- testProperties: CopyableCreate<TraceabilityTestWorkerCreate, string>
  The properties with which the test will be initialized
Returns Promise<void>
Implementation of TestContainer.addTraceabilityTest

allTestEvents

allTestEvents(): AllTestEventsApi
Allows event binding to all tests on this sub-inspection.

Returns AllTestEventsApi
An object which allows access to test event bindings.

Implementation of TestContainer.allTestEvents

button

button(scriptId): ButtonTestApi
Allows modification, retrieval, and event binding of a Button test with the given id.
Parameters
- scriptId: string
  Unique id of the test.
Returns ButtonTestApi
An object which allows access to the test methods

chart

chart(scriptId): ChartTestApi
Allows modification and retrieval of a Chart test with the given id.
Parameters
- scriptId: string
  Unique id of the test.
Returns ChartTestApi
An object which allows access to the test methods

dataCanvas

dataCanvas(scriptId): DataCanvasTestApi<T>
Allows modification, retrieval, and event binding of a data canvas test with the given id.
Parameters
- scriptId: string
  Unique id of the test.
Returns DataCanvasTestApi<T>
An object which allows access to the test methods

dateTime

dateTime(scriptId): DateTimeTestApi
Parameters
- scriptId: string
  Unique id of the test.
Returns DateTimeTestApi
Implementation of TestContainer.dateTime

defectList

defectList(scriptId): DefectListTestApi
Allows modification, retrieval, and event binding of a Defect List test with the given id.
Parameters
- scriptId: string
  Unique id of the test.
Returns DefectListTestApi
An object which allows access to the test methods

file

file(scriptId): FileTestApi
Allows modification, retrieval, and event binding of a File test with the given id.
Parameters
- scriptId: string
  Unique id of the test.
Returns FileTestApi
An object which allows access to the test methods

getProperties

getProperties(): Promise<SubInspectionWorkerGet>
Retrieves the properties from the given sub-inspection.

Returns Promise<SubInspectionWorkerGet>

group

group(scriptId): GroupTestApi<T>
Allows modification, retrieval, and event binding of a Group test with the given id.
Parameters
- scriptId: string
  Unique id of the test.
Returns GroupTestApi<T>
An object which allows access to the test methods

input

input(scriptId): InputTestApi
Parameters
- scriptId: string
  Unique id of the test.
Returns InputTestApi
Implementation of TestContainer.input

label

label(scriptId): LabelTestApi
Allows modification, retrieval, and event binding of a Label test with the given id.
Parameters
- scriptId: string
  Unique id of the test.
Returns LabelTestApi
An object which allows access to the test methods

oee

oee(scriptId): OEETestApi
Allows modification, retrieval, and event binding of an OEE test with the given id.
Parameters
- scriptId: string
  Unique id of the test.
Returns OEETestApi
An object which allows access to the test methods

onAfterEnd

onAfterEnd(fn): ScriptEventSubscription
Bind a function to fire after a sub-inspection has ended.
Parameters
- fn: ((event: SubInspectionAfterEndScriptEvent) => void)
  The function to fire.
  - - (event): void
    - Parameters
      event: SubInspectionAfterEndScriptEvent
      Returns void
Returns ScriptEventSubscription
ScriptEventSubscription

Inherited from CoreSubInspectionApi.onAfterEnd

onAfterStart

onAfterStart(fn): ScriptEventSubscription
Bind a function to fire after a sub-inspection has begun.
Parameters
- fn: ((event: SubInspectionAfterStartScriptEvent) => void)
  The function to fire.
  - - (event): void
    - Parameters
      event: SubInspectionAfterStartScriptEvent
      Returns void
Returns ScriptEventSubscription
ScriptEventSubscription

Inherited from CoreSubInspectionApi.onAfterStart

onBeforeEnd

onBeforeEnd(fn): ScriptEventSubscription
Bind a function to fire before a sub-inspection ends. preventDefault can be called on the event to prevent the sub inspection from ending.
Parameters
- fn: ((event: SubInspectionBeforeEndScriptEvent) => void)
  The function to fire.
  - - (event): void
    - Parameters
      event: SubInspectionBeforeEndScriptEvent
      Returns void
Returns ScriptEventSubscription
ScriptEventSubscription

Inherited from CoreSubInspectionApi.onBeforeEnd

part

part(scriptId): PartTestApi
Allows modification and retrieval of a Part test with the given id.
Parameters
- scriptId: string
  Unique id of the test.
Returns PartTestApi
An object which allows access to the test methods

passFail

passFail(scriptId): PassFailTestApi
Allows modification, retrieval, and event binding of a Pass/Fail test with the given id.
Parameters
- scriptId: string
  Unique id of the test.
Returns PassFailTestApi
An object which allows access to the test methods

process

process(scriptId): ProcessTestApi
Parameters
- scriptId: string
  Unique id of the test.
Returns ProcessTestApi
Implementation of TestContainer.process

rating

rating(scriptId): RatingTestApi
Allows modification, retrieval, and event binding of a Rating test with the given id.
Parameters
- scriptId: string
  Unique id of the test.
Returns RatingTestApi
An object which allows access to the test methods

removeTest

removeTest(scriptId): Promise<void>
Parameters
- scriptId: string
  The id of the test to remove.
Returns Promise<void>
Implementation of TestContainer.removeTest

spc

spc(scriptId): SPCTestApi
Allows modification, retrieval, and event binding of a SPC test with the given id.
Parameters
- scriptId: string
  Unique id of the test.
Returns SPCTestApi
An object which allows access to the test methods

task

task(scriptId): TaskTestApi
Allows modification, retrieval, and event binding of a Task test with the given id.
Parameters
- scriptId: string
  Unique id of the test.
Returns TaskTestApi
An object which allows access to the test methods

traceability

traceability(scriptId): TraceabilityTestApi
Parameters
- scriptId: string
  Unique id of the test.
Returns TraceabilityTestApi
Implementation of TestContainer.traceability

updateProperties

updateProperties(newProps): Promise<void>
Updates the inspection with new values.
Parameters
- newProps: SubInspectionWorkerUpdate
  Object with new properties to use
Returns Promise<void>

Class SubInspectionApi<T>

Implements

Type Parameters

Hierarchy (view full)

Implements

Index

Methods

Methods

addButtonTest

Parameters

Returns Promise<void>

addChartTest

Parameters

Returns Promise<void>

addDataCanvasTest

Parameters

Returns Promise<void>

addDateTimeTest

Parameters

Returns Promise<void>

addDefectListTest

Parameters

Returns Promise<void>

addFileTest

Parameters

Returns Promise<void>

addGroupTest

Parameters

Returns Promise<void>

addInputTest

Parameters

Returns Promise<void>

addLabelTest

Parameters

Returns Promise<void>

addOEETest

Parameters

Returns Promise<void>

addPartTest

Parameters

Returns Promise<void>

addPassFailTest

Parameters

Returns Promise<void>

addProcessTest

Parameters

Returns Promise<void>

addRatingTest

Parameters

Returns Promise<void>

addSPCTest

Parameters

Returns Promise<void>

addTaskTest

Parameters

Returns Promise<void>

addTraceabilityTest

Parameters

Returns Promise<void>

allTestEvents

Returns AllTestEventsApi

button

Parameters

Returns ButtonTestApi

chart

Parameters

Returns ChartTestApi

dataCanvas

Parameters

Returns DataCanvasTestApi<T>

dateTime

Parameters

Returns DateTimeTestApi

defectList

Parameters

Returns DefectListTestApi

file

Parameters

Returns FileTestApi

getProperties