Class DataCanvasTestApi<T>

Implements

IUpdateablePropertyTest

Type Parameters

T extends string

Hierarchy (view full)

TestApi
- DataCanvasTestApi

Implements

IUpdateablePropertyTest

Index

Properties

scriptId subInspectionId testType

Methods

addInputTest addLabelTest addPassFailTest addSPCTest addTaskTest getProperties updateProperties

Properties

scriptId

scriptId: string

subInspectionId

subInspectionId: string

testType

testType: InspectionTest

Methods

addInputTest

addInputTest(testProperties, location): Promise<void>
AddDataCanvass an Input test with the given properties to this group test
Parameters
- 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
- 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
- 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
- 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
- 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
- newProps: DataCanvasTestWorkerUpdate
  Object with new properties to use
Returns Promise<any>
Implementation of IUpdateablePropertyTest.updateProperties