Scripting API / utils/type-utils
utils/type-utils
Modules
| Module | Description |
|---|---|
| External | - |
Interfaces
ButtonCopyableCreate
Construct a type with the properties of T except for those in type K.
Extends
Omit<ButtonTestWorkerCreate,"copyFrom"|"copyFromSubInspection">.CopyableCreate
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends SubInspectionId | string & object |
- |
U extends SubInspectionId | undefined |
undefined |
Properties
| Property | Type | Description | Overrides | Inherited from |
|---|---|---|---|---|
backgroundColor? |
string | null |
Change the background color of the button when it is not hovered. Set to null to revert to the default. This may be set to any valid HTML color. | - | Omit.backgroundColor |
borderBottom? |
boolean |
Change whether or not there is a bottom border. | - | Omit.borderBottom |
borderLeft? |
boolean |
Change whether or not there is a left border. | - | Omit.borderLeft |
borderRight? |
boolean |
Change whether or not there is a right border. | - | Omit.borderRight |
borderTop? |
boolean |
Change whether or not there is a top border. | - | Omit.borderTop |
copyFrom? |
U extends string ? string : string |
If set, all properties not explicitly set in this object will be copied from the test with this script ID. Note that the existing test's column and row will not be copied (specify where the test should be created with the location property). The existing test with this script ID must be of the same type where the new test will be created. If the existing test contains other tests, those tests will be copied. If tests with the same script ID already exist, they will be given randomly generated script IDs. Use getProperties() on the new test to retrieve these auto-generated IDs. |
CopyableCreate.copyFrom |
- |
copyFromSubInspection? |
string & object | U |
If set, attempts to copy the test from another sub-inspection, instead of the same sub-inspection targeted by this function. The test will be copied from the currently running sub-inspection if the provided script ID matches the ID of the running sub-inspection. | CopyableCreate.copyFromSubInspection |
- |
frozen? |
boolean |
Change whether a test is frozen in place. | - | Omit.frozen |
fullWidth? |
boolean |
Change whether or not the button should be full width. | - | Omit.fullWidth |
hoverColor? |
string | null |
Change the background color of the button when it is hovered. Set to null to revert to the default. This may be set to any valid HTML color. | - | Omit.hoverColor |
label? |
string |
Change the text that accompanies the test. | - | Omit.label |
location? |
object |
Contains properties to change the location of the test. | - | Omit.location |
location.column? |
number | "default" |
Change the column a test is in, between 0 and 11. | - | - |
location.insertMode? |
TestInsertMode |
If set to 'insertIntoNewRow', the test will be inserted in a new row at the given row index. If set to 'appendToExistingRow' the test will be appended to the existing row at the given row index. Defaults to 'insertIntoNewRow'. | - | - |
location.row? |
number |
Change the row a test is in. If not specified, the last row index will be used. | - | - |
minHeight? |
number |
Change the minimum height of the button in pixels. | - | Omit.minHeight |
scriptId? |
string |
The id used to select this test in scripts. | - | Omit.scriptId |
textColor? |
string | null |
Change the text color of the button. Set to null to revert to the default. This may be set to any valid HTML color. | - | Omit.textColor |
userDefinedVisible? |
boolean |
Change whether a test can be seen. Invisible tests are treated the same as visible tests. | - | Omit.userDefinedVisible |
width? |
number |
Change the number of columns the test occupies. The minimum width for a test is defined by minWidth, and the max width is 12. | - | Omit.width |
ChartCopyableCreate
Construct a type with the properties of T except for those in type K.
Extends
Omit<ChartTestWorkerCreate,"copyFrom"|"copyFromSubInspection">.CopyableCreate
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends SubInspectionId | string & object |
- |
U extends SubInspectionId | undefined |
undefined |
Properties
| Property | Type | Description | Overrides | Inherited from |
|---|---|---|---|---|
borderBottom? |
boolean |
Change whether or not there is a bottom border. | - | Omit.borderBottom |
borderLeft? |
boolean |
Change whether or not there is a left border. | - | Omit.borderLeft |
borderRight? |
boolean |
Change whether or not there is a right border. | - | Omit.borderRight |
borderTop? |
boolean |
Change whether or not there is a top border. | - | Omit.borderTop |
chartType |
DataEntryChartType |
The chart type to display in this test. | - | Omit.chartType |
copyFrom? |
U extends string ? string : string |
If set, all properties not explicitly set in this object will be copied from the test with this script ID. Note that the existing test's column and row will not be copied (specify where the test should be created with the location property). The existing test with this script ID must be of the same type where the new test will be created. If the existing test contains other tests, those tests will be copied. If tests with the same script ID already exist, they will be given randomly generated script IDs. Use getProperties() on the new test to retrieve these auto-generated IDs. |
CopyableCreate.copyFrom |
- |
copyFromSubInspection? |
string & object | U |
If set, attempts to copy the test from another sub-inspection, instead of the same sub-inspection targeted by this function. The test will be copied from the currently running sub-inspection if the provided script ID matches the ID of the running sub-inspection. | CopyableCreate.copyFromSubInspection |
- |
dataType |
DataRecordType |
The data type to display in this test. | - | Omit.dataType |
frozen? |
boolean |
Change whether a test is frozen in place. | - | Omit.frozen |
label? |
string |
Change the text that accompanies the test. | - | Omit.label |
linkedTests? |
string[] |
The list of test script IDs linked to this test. | - | Omit.linkedTests |
location? |
object |
Contains properties to change the location of the test. | - | Omit.location |
location.column? |
number | "default" |
Change the column a test is in, between 0 and 11. | - | - |
location.insertMode? |
TestInsertMode |
If set to 'insertIntoNewRow', the test will be inserted in a new row at the given row index. If set to 'appendToExistingRow' the test will be appended to the existing row at the given row index. Defaults to 'insertIntoNewRow'. | - | - |
location.row? |
number |
Change the row a test is in. If not specified, the last row index will be used. | - | - |
scriptId? |
string |
The id used to select this test in scripts. | - | Omit.scriptId |
userDefinedVisible? |
boolean |
Change whether a test can be seen. Invisible tests are treated the same as visible tests. | - | Omit.userDefinedVisible |
width? |
number |
Change the number of columns the test occupies. The minimum width for a test is defined by minWidth, and the max width is 12. | - | Omit.width |
CopyableCreate
Extended by
ButtonCopyableCreateDefectListCopyableCreateFileCopyableCreateGroupCopyableCreateDataCanvasCopyableCreateLabelCopyableCreateOEECopyableCreatePassFailCopyableCreateRatingCopyableCreateSPCCopyableCreateTaskCopyableCreateInputCopyableCreateTraceabilityCopyableCreateChartCopyableCreate
Properties
DataCanvasCopyableCreate
Construct a type with the properties of T except for those in type K.
Extends
Omit<DataCanvasTestWorkerCreate,"copyFrom"|"copyFromSubInspection">.CopyableCreate
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends SubInspectionId | string & object |
- |
U extends SubInspectionId | undefined |
undefined |
Properties
| Property | Type | Description | Overrides | Inherited from |
|---|---|---|---|---|
aspectRatio? |
number | null |
Change the aspect ratio to display the image with. If the aspect ratio is not the same as the background image, the image will stretch to fit. Use null to unset this value. | - | Omit.aspectRatio |
borderBottom? |
boolean |
Change whether or not there is a bottom border. | - | Omit.borderBottom |
borderLeft? |
boolean |
Change whether or not there is a left border. | - | Omit.borderLeft |
borderRight? |
boolean |
Change whether or not there is a right border. | - | Omit.borderRight |
borderTop? |
boolean |
Change whether or not there is a top border. | - | Omit.borderTop |
copyFrom? |
U extends string ? string : string |
If set, all properties not explicitly set in this object will be copied from the test with this script ID. Note that the existing test's column and row will not be copied (specify where the test should be created with the location property). The existing test with this script ID must be of the same type where the new test will be created. If the existing test contains other tests, those tests will be copied. If tests with the same script ID already exist, they will be given randomly generated script IDs. Use getProperties() on the new test to retrieve these auto-generated IDs. |
CopyableCreate.copyFrom |
- |
copyFromSubInspection? |
string & object | U |
If set, attempts to copy the test from another sub-inspection, instead of the same sub-inspection targeted by this function. The test will be copied from the currently running sub-inspection if the provided script ID matches the ID of the running sub-inspection. | CopyableCreate.copyFromSubInspection |
- |
frozen? |
boolean |
Change whether a test is frozen in place. | - | Omit.frozen |
imageId? |
number |
Change the image used as the background of the data canvas. | - | Omit.imageId |
label? |
string |
Change the text that accompanies the test. | - | Omit.label |
location? |
object |
Contains properties to change the location of the test. | - | Omit.location |
location.column? |
number | "default" |
Change the column a test is in, between 0 and 11. | - | - |
location.insertMode? |
TestInsertMode |
If set to 'insertIntoNewRow', the test will be inserted in a new row at the given row index. If set to 'appendToExistingRow' the test will be appended to the existing row at the given row index. Defaults to 'insertIntoNewRow'. | - | - |
location.row? |
number |
Change the row a test is in. If not specified, the last row index will be used. | - | - |
scriptId? |
string |
The id used to select this test in scripts. | - | Omit.scriptId |
snapToGrid? |
boolean |
Change whether to snap the width and location of moved / added tests to a grid. | - | Omit.snapToGrid |
userDefinedVisible? |
boolean |
Change whether a test can be seen. Invisible tests are treated the same as visible tests. | - | Omit.userDefinedVisible |
width? |
number |
Change the number of columns the test occupies. The minimum width for a test is defined by minWidth, and the max width is 12. | - | Omit.width |
DefectListCopyableCreate
Construct a type with the properties of T except for those in type K.
Extends
Omit<DefectListTestWorkerCreate,"copyFrom"|"copyFromSubInspection">.CopyableCreate
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends SubInspectionId | string & object |
- |
U extends SubInspectionId | undefined |
undefined |
Properties
| Property | Type | Description | Overrides | Inherited from |
|---|---|---|---|---|
alertId? |
number | null |
Change the real-time alert for this test. | - | Omit.alertId |
borderBottom? |
boolean |
Change whether or not there is a bottom border. | - | Omit.borderBottom |
borderLeft? |
boolean |
Change whether or not there is a left border. | - | Omit.borderLeft |
borderRight? |
boolean |
Change whether or not there is a right border. | - | Omit.borderRight |
borderTop? |
boolean |
Change whether or not there is a top border. | - | Omit.borderTop |
copyFrom? |
U extends string ? string : string |
If set, all properties not explicitly set in this object will be copied from the test with this script ID. Note that the existing test's column and row will not be copied (specify where the test should be created with the location property). The existing test with this script ID must be of the same type where the new test will be created. If the existing test contains other tests, those tests will be copied. If tests with the same script ID already exist, they will be given randomly generated script IDs. Use getProperties() on the new test to retrieve these auto-generated IDs. |
CopyableCreate.copyFrom |
- |
copyFromSubInspection? |
string & object | U |
If set, attempts to copy the test from another sub-inspection, instead of the same sub-inspection targeted by this function. The test will be copied from the currently running sub-inspection if the provided script ID matches the ID of the running sub-inspection. | CopyableCreate.copyFromSubInspection |
- |
defectSpecificTraceIds? |
number[] |
Change the traceability which will apply to each defect in the list | - | Omit.defectSpecificTraceIds |
enabled? |
boolean |
Change whether the user is allowed to interact with the test in the UI. | - | Omit.enabled |
enableSampleSize? |
boolean |
Change whether the sample size is adjustable by the operator at run time. | - | Omit.enableSampleSize |
frozen? |
boolean |
Change whether a test is frozen in place. | - | Omit.frozen |
label? |
string |
Change the text that accompanies the test. | - | Omit.label |
location? |
object |
Contains properties to change the location of the test. | - | Omit.location |
location.column? |
number | "default" |
Change the column a test is in, between 0 and 11. | - | - |
location.insertMode? |
TestInsertMode |
If set to 'insertIntoNewRow', the test will be inserted in a new row at the given row index. If set to 'appendToExistingRow' the test will be appended to the existing row at the given row index. Defaults to 'insertIntoNewRow'. | - | - |
location.row? |
number |
Change the row a test is in. If not specified, the last row index will be used. | - | - |
ncuBehavior? |
NCUBehaviorType |
Change how to handle NCU behavior. | - | Omit.ncuBehavior |
ncuCount? |
number |
Change the current non conforming unit count. If ncuBehavior is set to autoSum, this will be overwritten during save. If ncuBehavior is set to input, this maybe overwritten by the user. | - | Omit.ncuCount |
note? |
string | null |
Change the note to save with this test. | - | Omit.note |
noteType? |
NoteFunctionalityType |
Change when a note is required on a test. | - | Omit.noteType |
partOverrideId? |
number | null |
Change the part to use for this test. Expects the ID of the part. null to unset the part override. | - | Omit.partOverrideId |
processOverrideId? |
number | null |
Change the process to use for this test. Expects the ID of the process. null to unset the process override. | - | Omit.processOverrideId |
required? |
boolean |
Change whether or not the user is forced to enter data. | - | Omit.required |
sampleSize? |
number |
Change the sample size of the defect list. | - | Omit.sampleSize |
scriptId? |
string |
The id used to select this test in scripts. | - | Omit.scriptId |
selectedDefectCategoryId? |
number | null |
Change the defect category selected by the user, or pre-selected during inspection setup. It must contain defects. null may be used to unselect a defect category. | - | Omit.selectedDefectCategoryId |
storeData? |
StoreDataFunctionalityType |
Change whether or not data will be stored for this test. | - | Omit.storeData |
testSpecificTrace? |
object[] |
Change the trace which have been preset for this test. This is expected to be the complete list of traceability specific to this test. Any test specific traceability not included in this list will be removed from this test. | - | Omit.testSpecificTrace |
userDefinedVisible? |
boolean |
Change whether a test can be seen. Invisible tests are treated the same as visible tests. | - | Omit.userDefinedVisible |
value? |
Record<number, IWorkerDefectListValue[]> |
Change the value stored for this record. The key is the defect id, the value is the list of defect counts and traceability that apply to each defect. This will only update the values passed in, and only defects that exist in the current defect category are valid. | - | Omit.value |
width? |
number |
Change the number of columns the test occupies. The minimum width for a test is defined by minWidth, and the max width is 12. | - | Omit.width |
FileCopyableCreate
Construct a type with the properties of T except for those in type K.
Extends
Omit<FileTestWorkerCreate,"copyFrom"|"copyFromSubInspection">.CopyableCreate
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends SubInspectionId | string & object |
- |
U extends SubInspectionId | undefined |
undefined |
Properties
| Property | Type | Description | Overrides | Inherited from |
|---|---|---|---|---|
borderBottom? |
boolean |
Change whether or not there is a bottom border. | - | Omit.borderBottom |
borderLeft? |
boolean |
Change whether or not there is a left border. | - | Omit.borderLeft |
borderRight? |
boolean |
Change whether or not there is a right border. | - | Omit.borderRight |
borderTop? |
boolean |
Change whether or not there is a top border. | - | Omit.borderTop |
copyFrom? |
U extends string ? string : string |
If set, all properties not explicitly set in this object will be copied from the test with this script ID. Note that the existing test's column and row will not be copied (specify where the test should be created with the location property). The existing test with this script ID must be of the same type where the new test will be created. If the existing test contains other tests, those tests will be copied. If tests with the same script ID already exist, they will be given randomly generated script IDs. Use getProperties() on the new test to retrieve these auto-generated IDs. |
CopyableCreate.copyFrom |
- |
copyFromSubInspection? |
string & object | U |
If set, attempts to copy the test from another sub-inspection, instead of the same sub-inspection targeted by this function. The test will be copied from the currently running sub-inspection if the provided script ID matches the ID of the running sub-inspection. | CopyableCreate.copyFromSubInspection |
- |
fileId? |
number |
Change the file bound to the test with a numeric ID. If type is set to 'url', setting this property won't result in visible changes. | - | Omit.fileId |
frozen? |
boolean |
Change whether a test is frozen in place. | - | Omit.frozen |
label? |
string |
Change the text that accompanies the test. | - | Omit.label |
location? |
object |
Contains properties to change the location of the test. | - | Omit.location |
location.column? |
number | "default" |
Change the column a test is in, between 0 and 11. | - | - |
location.insertMode? |
TestInsertMode |
If set to 'insertIntoNewRow', the test will be inserted in a new row at the given row index. If set to 'appendToExistingRow' the test will be appended to the existing row at the given row index. Defaults to 'insertIntoNewRow'. | - | - |
location.row? |
number |
Change the row a test is in. If not specified, the last row index will be used. | - | - |
openInNewTab? |
boolean |
Change whether the file opens in a new tab or displays inline. If the test has finished loading, modifying this property will not have any effect until the sub-inspection is loaded again. | - | Omit.openInNewTab |
orientation? |
FileOrientationType |
Change the orientation of a PDF. | - | Omit.orientation |
scriptId? |
string |
The id used to select this test in scripts. | - | Omit.scriptId |
type? |
FileType |
Change whether to load a web page or load a file from GS. | - | Omit.type |
url? |
string |
Change the URL of the url to load. If type is set to 'file', setting this property won't result in visible changes. | - | Omit.url |
userDefinedVisible? |
boolean |
Change whether a test can be seen. Invisible tests are treated the same as visible tests. | - | Omit.userDefinedVisible |
width? |
number |
Change the number of columns the test occupies. The minimum width for a test is defined by minWidth, and the max width is 12. | - | Omit.width |
GroupCopyableCreate
Construct a type with the properties of T except for those in type K.
Extends
Omit<GroupTestWorkerCreate,"copyFrom"|"copyFromSubInspection">.CopyableCreate
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends SubInspectionId | string & object |
- |
U extends SubInspectionId | undefined |
undefined |
Properties
| Property | Type | Description | Overrides | Inherited from |
|---|---|---|---|---|
borderBottom? |
boolean |
Change whether or not there is a bottom border. | - | Omit.borderBottom |
borderLeft? |
boolean |
Change whether or not there is a left border. | - | Omit.borderLeft |
borderRight? |
boolean |
Change whether or not there is a right border. | - | Omit.borderRight |
borderTop? |
boolean |
Change whether or not there is a top border. | - | Omit.borderTop |
copyFrom? |
U extends string ? string : string |
If set, all properties not explicitly set in this object will be copied from the test with this script ID. Note that the existing test's column and row will not be copied (specify where the test should be created with the location property). The existing test with this script ID must be of the same type where the new test will be created. If the existing test contains other tests, those tests will be copied. If tests with the same script ID already exist, they will be given randomly generated script IDs. Use getProperties() on the new test to retrieve these auto-generated IDs. |
CopyableCreate.copyFrom |
- |
copyFromSubInspection? |
string & object | U |
If set, attempts to copy the test from another sub-inspection, instead of the same sub-inspection targeted by this function. The test will be copied from the currently running sub-inspection if the provided script ID matches the ID of the running sub-inspection. | CopyableCreate.copyFromSubInspection |
- |
frozen? |
boolean |
Change whether a test is frozen in place. | - | Omit.frozen |
label? |
string |
Change the text that accompanies the test. | - | Omit.label |
location? |
object |
Contains properties to change the location of the test. | - | Omit.location |
location.column? |
number | "default" |
Change the column a test is in, between 0 and 11. | - | - |
location.insertMode? |
TestInsertMode |
If set to 'insertIntoNewRow', the test will be inserted in a new row at the given row index. If set to 'appendToExistingRow' the test will be appended to the existing row at the given row index. Defaults to 'insertIntoNewRow'. | - | - |
location.row? |
number |
Change the row a test is in. If not specified, the last row index will be used. | - | - |
mode? |
GroupTestMode |
How tests should layout in this group when they do not make up the full width. - static: Do not modify the location or size of the tests. - fill: Expand tests to fill space. Tests will be expanded evenly. - collapse: Pack tests together to eliminate as much empty space as possible. Does not modify the width of tests. - collapseAndFill: Pack tests together to eliminate as much space as possible, then expand tests to fill the remaining space. |
- | Omit.mode |
scriptId? |
string |
The id used to select this test in scripts. | - | Omit.scriptId |
userDefinedVisible? |
boolean |
Change whether a test can be seen. Invisible tests are treated the same as visible tests. | - | Omit.userDefinedVisible |
width? |
number |
Change the number of columns the test occupies. The minimum width for a test is defined by minWidth, and the max width is 12. | - | Omit.width |
InputCopyableCreate
Construct a type with the properties of T except for those in type K.
Extends
Omit<InputTestWorkerCreate,"copyFrom"|"copyFromSubInspection">.CopyableCreate
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends SubInspectionId | string & object | undefined |
- |
U extends SubInspectionId | undefined |
undefined |
Properties
| Property | Type | Description | Overrides | Inherited from |
|---|---|---|---|---|
borderBottom? |
boolean |
Change whether or not there is a bottom border. | - | Omit.borderBottom |
borderLeft? |
boolean |
Change whether or not there is a left border. | - | Omit.borderLeft |
borderRight? |
boolean |
Change whether or not there is a right border. | - | Omit.borderRight |
borderTop? |
boolean |
Change whether or not there is a top border. | - | Omit.borderTop |
copyFrom? |
U extends string ? string : T extends string ? string : string |
If set, all properties not explicitly set in this object will be copied from the test with this script ID. Note that the existing test's column and row will not be copied (specify where the test should be created with the location property). The existing test with this script ID must be of the same type where the new test will be created. If the existing test contains other tests, those tests will be copied. If tests with the same script ID already exist, they will be given randomly generated script IDs. Use getProperties() on the new test to retrieve these auto-generated IDs. |
CopyableCreate.copyFrom |
- |
copyFromSubInspection? |
string & object | U |
If set, attempts to copy the test from another sub-inspection, instead of the same sub-inspection targeted by this function. The test will be copied from the currently running sub-inspection if the provided script ID matches the ID of the running sub-inspection. | CopyableCreate.copyFromSubInspection |
- |
enabled? |
boolean |
Change whether the user is allowed to interact with the test in the UI. | - | Omit.enabled |
frozen? |
boolean |
Change whether a test is frozen in place. | - | Omit.frozen |
label? |
string |
Change the text that accompanies the test. | - | Omit.label |
location? |
object |
Contains properties to change the location of the test. | - | Omit.location |
location.column? |
number | "default" |
Change the column a test is in, between 0 and 11. | - | - |
location.insertMode? |
TestInsertMode |
If set to 'insertIntoNewRow', the test will be inserted in a new row at the given row index. If set to 'appendToExistingRow' the test will be appended to the existing row at the given row index. Defaults to 'insertIntoNewRow'. | - | - |
location.row? |
number |
Change the row a test is in. If not specified, the last row index will be used. | - | - |
multiline? |
boolean |
Change whether or not to display the input area as a multiline text box. If options are set, this property will have no effect. | - | Omit.multiline |
options? |
InputTestEntity[] | null |
Change the currently set options. These should take the form of { id: uniqueIdentifier, name: humanReadableName } When the user selects an option, the value of the test will become the id of the option selected. Changing this property will clear the value of the test. | - | Omit.options |
required? |
boolean |
Change whether or not the user is forced to enter data. | - | Omit.required |
scriptId? |
string |
The id used to select this test in scripts. | - | Omit.scriptId |
userDefinedVisible? |
boolean |
Change whether a test can be seen. Invisible tests are treated the same as visible tests. | - | Omit.userDefinedVisible |
useSearchableSelect? |
boolean |
Whether to use a searchable select. It is advised to bind to the onPaginate event to populate the searchable select if this is true. If multiple events are bound to onPaginate, it will use the result of the last one. Changing this property will clear the value of the test. | - | Omit.useSearchableSelect |
value? |
string | number | null |
Set the value of the test. If options are set, this will attempt to look up the InputTestEntity based on the id. | - | Omit.value |
width? |
number |
Change the number of columns the test occupies. The minimum width for a test is defined by minWidth, and the max width is 12. | - | Omit.width |
LabelCopyableCreate
Construct a type with the properties of T except for those in type K.
Extends
Omit<LabelTestWorkerCreate,"copyFrom"|"copyFromSubInspection">.CopyableCreate
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends SubInspectionId | string & object |
- |
U extends SubInspectionId | undefined |
undefined |
Properties
| Property | Type | Description | Overrides | Inherited from |
|---|---|---|---|---|
borderBottom? |
boolean |
Change whether or not there is a bottom border. | - | Omit.borderBottom |
borderLeft? |
boolean |
Change whether or not there is a left border. | - | Omit.borderLeft |
borderRight? |
boolean |
Change whether or not there is a right border. | - | Omit.borderRight |
borderTop? |
boolean |
Change whether or not there is a top border. | - | Omit.borderTop |
content? |
string |
Change the content of this test. Any valid safe HTML may be used. | - | Omit.content |
copyFrom? |
U extends string ? string : string |
If set, all properties not explicitly set in this object will be copied from the test with this script ID. Note that the existing test's column and row will not be copied (specify where the test should be created with the location property). The existing test with this script ID must be of the same type where the new test will be created. If the existing test contains other tests, those tests will be copied. If tests with the same script ID already exist, they will be given randomly generated script IDs. Use getProperties() on the new test to retrieve these auto-generated IDs. |
CopyableCreate.copyFrom |
- |
copyFromSubInspection? |
string & object | U |
If set, attempts to copy the test from another sub-inspection, instead of the same sub-inspection targeted by this function. The test will be copied from the currently running sub-inspection if the provided script ID matches the ID of the running sub-inspection. | CopyableCreate.copyFromSubInspection |
- |
frozen? |
boolean |
Change whether a test is frozen in place. | - | Omit.frozen |
location? |
object |
Contains properties to change the location of the test. | - | Omit.location |
location.column? |
number | "default" |
Change the column a test is in, between 0 and 11. | - | - |
location.insertMode? |
TestInsertMode |
If set to 'insertIntoNewRow', the test will be inserted in a new row at the given row index. If set to 'appendToExistingRow' the test will be appended to the existing row at the given row index. Defaults to 'insertIntoNewRow'. | - | - |
location.row? |
number |
Change the row a test is in. If not specified, the last row index will be used. | - | - |
scriptId? |
string |
The id used to select this test in scripts. | - | Omit.scriptId |
userDefinedVisible? |
boolean |
Change whether a test can be seen. Invisible tests are treated the same as visible tests. | - | Omit.userDefinedVisible |
width? |
number |
Change the number of columns the test occupies. The minimum width for a test is defined by minWidth, and the max width is 12. | - | Omit.width |
OEECopyableCreate
Construct a type with the properties of T except for those in type K.
Extends
Omit<OEETestWorkerCreate,"copyFrom"|"copyFromSubInspection">.CopyableCreate
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends SubInspectionId | string & object |
- |
U extends SubInspectionId | undefined |
undefined |
Properties
| Property | Type | Description | Overrides | Inherited from |
|---|---|---|---|---|
alertId? |
number | null |
Change the real-time alert for this test. | - | Omit.alertId |
availabilityDefectCategoryId? |
number | null |
Change the defect category to use to track the availability. This property is unused if trackAvailability is not set to downtimeWithReasons. | - | Omit.availabilityDefectCategoryId |
availabilityPartOverrideId? |
number | null |
Change the part to use when tracking availability. This property will not be used if trackAvailability is not set to downtimeWithReasons. | - | Omit.availabilityPartOverrideId |
availabilityProcessOverrideId? |
number | null |
Change the process to use when tracking availability. This property will not be used if trackAvailability is not set to downtimeWithReasons. | - | Omit.availabilityProcessOverrideId |
availableTime? |
number | null |
Change the total available time. If trackAvailability is not set to 'availability', this value will not be used. | - | Omit.availableTime |
badParts? |
Record<number, number> |
Change the bad parts which have been recorded. This must be an object where the key is the defect id and the number is the defect count. This property will be ignored if no quality defect category is set. This will throw an error if a defectId is used which is not present in the quality defect category. Only the defects included in badParts will be updated. | - | Omit.badParts |
borderBottom? |
boolean |
Change whether or not there is a bottom border. | - | Omit.borderBottom |
borderLeft? |
boolean |
Change whether or not there is a left border. | - | Omit.borderLeft |
borderRight? |
boolean |
Change whether or not there is a right border. | - | Omit.borderRight |
borderTop? |
boolean |
Change whether or not there is a top border. | - | Omit.borderTop |
copyFrom? |
U extends string ? string : string |
If set, all properties not explicitly set in this object will be copied from the test with this script ID. Note that the existing test's column and row will not be copied (specify where the test should be created with the location property). The existing test with this script ID must be of the same type where the new test will be created. If the existing test contains other tests, those tests will be copied. If tests with the same script ID already exist, they will be given randomly generated script IDs. Use getProperties() on the new test to retrieve these auto-generated IDs. |
CopyableCreate.copyFrom |
- |
copyFromSubInspection? |
string & object | U |
If set, attempts to copy the test from another sub-inspection, instead of the same sub-inspection targeted by this function. The test will be copied from the currently running sub-inspection if the provided script ID matches the ID of the running sub-inspection. | CopyableCreate.copyFromSubInspection |
- |
downtimeReasons? |
Record<number, number> |
Change the downtime reasons which have been recorded. This must be an object where the key is the defect id and the number is the defect count. This property will be ignored if no availability defect category is set. This will throw an error if a defectId is used which is not present in the availability defect category. Only the defects included in downtimeReasons will be updated. | - | Omit.downtimeReasons |
enabled? |
boolean |
Change whether the user is allowed to interact with the test in the UI. | - | Omit.enabled |
enableTotalParts? |
boolean |
Change whether the operator is able to enter total parts. | - | Omit.enableTotalParts |
frozen? |
boolean |
Change whether a test is frozen in place. | - | Omit.frozen |
goodParts? |
number | null |
Change the good parts produced. If trackQuality is not set to 'goodParts', this value will not be used. | - | Omit.goodParts |
idealCycleTime? |
number | null |
Change the ideal cycle time. | - | Omit.idealCycleTime |
label? |
string |
Change the text that accompanies the test. | - | Omit.label |
location? |
object |
Contains properties to change the location of the test. | - | Omit.location |
location.column? |
number | "default" |
Change the column a test is in, between 0 and 11. | - | - |
location.insertMode? |
TestInsertMode |
If set to 'insertIntoNewRow', the test will be inserted in a new row at the given row index. If set to 'appendToExistingRow' the test will be appended to the existing row at the given row index. Defaults to 'insertIntoNewRow'. | - | - |
location.row? |
number |
Change the row a test is in. If not specified, the last row index will be used. | - | - |
note? |
string | null |
Change the note to save with this test. | - | Omit.note |
noteType? |
NoteFunctionalityType |
Change when a note is required on a test. | - | Omit.noteType |
partOverrideId? |
number | null |
Change the part to use for this test. Expects the ID of the part. null to unset the part override. | - | Omit.partOverrideId |
processOverrideId? |
number | null |
Change the process to use for this test. Expects the ID of the process. null to unset the process override. | - | Omit.processOverrideId |
qualityDefectCategoryId? |
number | null |
Change the defect category to use to track the quality. This property is unused if trackQuality is not set to badPartsWithDefects. | - | Omit.qualityDefectCategoryId |
qualityPartOverrideId? |
number | null |
Change the part to use when tracking quality. This property will not be used if trackQuality is not set to badPartsWithDefects. | - | Omit.qualityPartOverrideId |
qualityProcessOverrideId? |
number | null |
Change the process to use when tracking quality. This property will not be used if trackQuality is not set to badPartsWithDefects. | - | Omit.qualityProcessOverrideId |
required? |
boolean |
Change whether or not the user is forced to enter data. | - | Omit.required |
scheduledTime? |
number | null |
Change the total scheduled time in minutes. | - | Omit.scheduledTime |
scriptId? |
string |
The id used to select this test in scripts. | - | Omit.scriptId |
storeData? |
StoreDataFunctionalityType |
Change whether or not data will be stored for this test. | - | Omit.storeData |
testSpecificTrace? |
object[] |
Change the trace which have been preset for this test. This is expected to be the complete list of traceability specific to this test. Any test specific traceability not included in this list will be removed from this test. | - | Omit.testSpecificTrace |
totalParts? |
number | null |
Change the total parts, including good parts and bad parts. | - | Omit.totalParts |
trackAvailability? |
OEEAvailabilityType |
Change how availability is tracked. 'available': Have the operator record the available time. 'downtimeWithReasons': Have the operator record the downtime and the reasons for it. 'doNotTrack': Nothing will be tracked for availability. | - | Omit.trackAvailability |
trackPerformance? |
boolean |
Change whether or not to track performance data. | - | Omit.trackPerformance |
trackQuality? |
OEEQualityType |
Change how quality is tracked. 'goodParts': Have the operator record the number of good parts. 'badPartsWithDefects': Have the operator record bad parts and the defects. 'noNotTrack': Nothing will be tracked for quality. | - | Omit.trackQuality |
userDefinedVisible? |
boolean |
Change whether a test can be seen. Invisible tests are treated the same as visible tests. | - | Omit.userDefinedVisible |
width? |
number |
Change the number of columns the test occupies. The minimum width for a test is defined by minWidth, and the max width is 12. | - | Omit.width |
PassFailCopyableCreate
Construct a type with the properties of T except for those in type K.
Extends
Omit<PassFailTestWorkerCreate,"copyFrom"|"copyFromSubInspection">.CopyableCreate
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends SubInspectionId | string & object |
- |
U extends SubInspectionId | undefined |
undefined |
Properties
| Property | Type | Description | Overrides | Inherited from |
|---|---|---|---|---|
alertId? |
number | null |
Change the real-time alert for this test. | - | Omit.alertId |
borderBottom? |
boolean |
Change whether or not there is a bottom border. | - | Omit.borderBottom |
borderLeft? |
boolean |
Change whether or not there is a left border. | - | Omit.borderLeft |
borderRight? |
boolean |
Change whether or not there is a right border. | - | Omit.borderRight |
borderTop? |
boolean |
Change whether or not there is a top border. | - | Omit.borderTop |
copyFrom? |
U extends string ? string : string |
If set, all properties not explicitly set in this object will be copied from the test with this script ID. Note that the existing test's column and row will not be copied (specify where the test should be created with the location property). The existing test with this script ID must be of the same type where the new test will be created. If the existing test contains other tests, those tests will be copied. If tests with the same script ID already exist, they will be given randomly generated script IDs. Use getProperties() on the new test to retrieve these auto-generated IDs. |
CopyableCreate.copyFrom |
- |
copyFromSubInspection? |
string & object | U |
If set, attempts to copy the test from another sub-inspection, instead of the same sub-inspection targeted by this function. The test will be copied from the currently running sub-inspection if the provided script ID matches the ID of the running sub-inspection. | CopyableCreate.copyFromSubInspection |
- |
defectId? |
number | null |
Change the defect to record when this test is marked as 'fail'. Expects the ID of the defect. Use null to unset the defect. | - | Omit.defectId |
enabled? |
boolean |
Change whether the user is allowed to interact with the test in the UI. | - | Omit.enabled |
failLabel? |
string |
Change the label for the fail button. | - | Omit.failLabel |
frozen? |
boolean |
Change whether a test is frozen in place. | - | Omit.frozen |
label? |
string |
Change the text that accompanies the test. | - | Omit.label |
location? |
object |
Contains properties to change the location of the test. | - | Omit.location |
location.column? |
number | "default" |
Change the column a test is in, between 0 and 11. | - | - |
location.insertMode? |
TestInsertMode |
If set to 'insertIntoNewRow', the test will be inserted in a new row at the given row index. If set to 'appendToExistingRow' the test will be appended to the existing row at the given row index. Defaults to 'insertIntoNewRow'. | - | - |
location.row? |
number |
Change the row a test is in. If not specified, the last row index will be used. | - | - |
naLabel? |
string |
Change the label for the N/A button. | - | Omit.naLabel |
ncuOnFailure? |
number |
Change how many non-conforming units will be tracked on fail. | - | Omit.ncuOnFailure |
note? |
string | null |
Change the note to save with this test. | - | Omit.note |
noteType? |
NoteFunctionalityType |
Change when a note is required on a test. | - | Omit.noteType |
onlyShowIfMatchesPart? |
boolean |
Change whether this test should only be displayed if the part in the test's context contains the defect set on this test. | - | Omit.onlyShowIfMatchesPart |
partOverrideId? |
number | null |
Change the part to use for this test. Expects the ID of the part. null to unset the part override. | - | Omit.partOverrideId |
passLabel? |
string |
Change the label for the pass button. | - | Omit.passLabel |
processOverrideId? |
number | null |
Change the process to use for this test. Expects the ID of the process. null to unset the process override. | - | Omit.processOverrideId |
required? |
boolean |
Change whether or not the user is forced to enter data. | - | Omit.required |
sampleSize? |
number |
Change the sample size to track with this test. | - | Omit.sampleSize |
scriptId? |
string |
The id used to select this test in scripts. | - | Omit.scriptId |
selectedFailColor? |
string |
Change color of the fail button when it has been selected. | - | Omit.selectedFailColor |
selectedNaColor? |
string |
Change color of the N/A button when it has been selected. | - | Omit.selectedNaColor |
selectedPassColor? |
string |
Change the color of the pass button when it has been selected. | - | Omit.selectedPassColor |
showNA? |
boolean |
Change whether or not to show the N/A button. | - | Omit.showNA |
storeData? |
StoreDataFunctionalityType |
Change whether or not data will be stored for this test. | - | Omit.storeData |
testSpecificTrace? |
object[] |
Change the trace which have been preset for this test. This is expected to be the complete list of traceability specific to this test. Any test specific traceability not included in this list will be removed from this test. | - | Omit.testSpecificTrace |
unselectedFailColor? |
string |
Change the color of the fail button when it has not been selected. | - | Omit.unselectedFailColor |
unselectedNaColor? |
string |
Change the color of the N/A button when it has not been selected. | - | Omit.unselectedNaColor |
unselectedPassColor? |
string |
Change The color of the pass button when it has not been selected. | - | Omit.unselectedPassColor |
userDefinedVisible? |
boolean |
Change whether a test can be seen. Invisible tests are treated the same as visible tests. | - | Omit.userDefinedVisible |
value? |
PassFailType | null |
Change the currently selected option. | - | Omit.value |
width? |
number |
Change the number of columns the test occupies. The minimum width for a test is defined by minWidth, and the max width is 12. | - | Omit.width |
RatingCopyableCreate
Construct a type with the properties of T except for those in type K.
Extends
Omit<RatingTestWorkerCreate,"copyFrom"|"copyFromSubInspection">.CopyableCreate
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends SubInspectionId | string & object |
- |
U extends SubInspectionId | undefined |
undefined |
Properties
| Property | Type | Description | Overrides | Inherited from |
|---|---|---|---|---|
alertId? |
number | null |
Change the real-time alert for this test. | - | Omit.alertId |
borderBottom? |
boolean |
Change whether or not there is a bottom border. | - | Omit.borderBottom |
borderLeft? |
boolean |
Change whether or not there is a left border. | - | Omit.borderLeft |
borderRight? |
boolean |
Change whether or not there is a right border. | - | Omit.borderRight |
borderTop? |
boolean |
Change whether or not there is a top border. | - | Omit.borderTop |
buttons? |
IRatingTestButton[] |
Change the list of buttons to display for the test. | - | Omit.buttons |
copyFrom? |
U extends string ? string : string |
If set, all properties not explicitly set in this object will be copied from the test with this script ID. Note that the existing test's column and row will not be copied (specify where the test should be created with the location property). The existing test with this script ID must be of the same type where the new test will be created. If the existing test contains other tests, those tests will be copied. If tests with the same script ID already exist, they will be given randomly generated script IDs. Use getProperties() on the new test to retrieve these auto-generated IDs. |
CopyableCreate.copyFrom |
- |
copyFromSubInspection? |
string & object | U |
If set, attempts to copy the test from another sub-inspection, instead of the same sub-inspection targeted by this function. The test will be copied from the currently running sub-inspection if the provided script ID matches the ID of the running sub-inspection. | CopyableCreate.copyFromSubInspection |
- |
enabled? |
boolean |
Change whether the user is allowed to interact with the test in the UI. | - | Omit.enabled |
frozen? |
boolean |
Change whether a test is frozen in place. | - | Omit.frozen |
label? |
string |
Change the text that accompanies the test. | - | Omit.label |
location? |
object |
Contains properties to change the location of the test. | - | Omit.location |
location.column? |
number | "default" |
Change the column a test is in, between 0 and 11. | - | - |
location.insertMode? |
TestInsertMode |
If set to 'insertIntoNewRow', the test will be inserted in a new row at the given row index. If set to 'appendToExistingRow' the test will be appended to the existing row at the given row index. Defaults to 'insertIntoNewRow'. | - | - |
location.row? |
number |
Change the row a test is in. If not specified, the last row index will be used. | - | - |
ncuOnFailure? |
number |
Change the count of non-conforming units when an option with a defect is selected. | - | Omit.ncuOnFailure |
note? |
string | null |
Change the note to save with this test. | - | Omit.note |
noteType? |
NoteFunctionalityType |
Change when a note is required on a test. | - | Omit.noteType |
partOverrideId? |
number | null |
Change the part to use for this test. Expects the ID of the part. null to unset the part override. | - | Omit.partOverrideId |
processOverrideId? |
number | null |
Change the process to use for this test. Expects the ID of the process. null to unset the process override. | - | Omit.processOverrideId |
required? |
boolean |
Change whether or not the user is forced to enter data. | - | Omit.required |
sampleSize? |
number |
Change the sample size to use for this test. | - | Omit.sampleSize |
scriptId? |
string |
The id used to select this test in scripts. | - | Omit.scriptId |
storeData? |
StoreDataFunctionalityType |
Change whether or not data will be stored for this test. | - | Omit.storeData |
testSpecificTrace? |
object[] |
Change the trace which have been preset for this test. This is expected to be the complete list of traceability specific to this test. Any test specific traceability not included in this list will be removed from this test. | - | Omit.testSpecificTrace |
userDefinedVisible? |
boolean |
Change whether a test can be seen. Invisible tests are treated the same as visible tests. | - | Omit.userDefinedVisible |
value? |
string | null |
Select a new option. This should be the label of the selected button. An error will be thrown if the value supplied is not in the list of buttons. | - | Omit.value |
width? |
number |
Change the number of columns the test occupies. The minimum width for a test is defined by minWidth, and the max width is 12. | - | Omit.width |
SPCCopyableCreate
Construct a type with the properties of T except for those in type K.
Extends
Omit<SPCTestWorkerCreate,"copyFrom"|"copyFromSubInspection">.CopyableCreate
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends SubInspectionId | string & object |
- |
U extends SubInspectionId | undefined |
undefined |
Properties
| Property | Type | Description | Overrides | Inherited from |
|---|---|---|---|---|
alertId? |
number | null |
Change the real-time alert for this test. | - | Omit.alertId |
autoFocusNext? |
number | null |
When set, will automatically focus the next input or test after have not recevied input for the defined number of milliseconds. | - | Omit.autoFocusNext |
borderBottom? |
boolean |
Change whether or not there is a bottom border. | - | Omit.borderBottom |
borderLeft? |
boolean |
Change whether or not there is a left border. | - | Omit.borderLeft |
borderRight? |
boolean |
Change whether or not there is a right border. | - | Omit.borderRight |
borderTop? |
boolean |
Change whether or not there is a top border. | - | Omit.borderTop |
cellLabel? |
string | null |
The label that will be shown for each cell if showCellLabel is true. Any instances of {{index}} in the value will be replaced by the subgroup index. Setting this to null will use the default value. | - | Omit.cellLabel |
copyFrom? |
U extends string ? string : string |
If set, all properties not explicitly set in this object will be copied from the test with this script ID. Note that the existing test's column and row will not be copied (specify where the test should be created with the location property). The existing test with this script ID must be of the same type where the new test will be created. If the existing test contains other tests, those tests will be copied. If tests with the same script ID already exist, they will be given randomly generated script IDs. Use getProperties() on the new test to retrieve these auto-generated IDs. |
CopyableCreate.copyFrom |
- |
copyFromSubInspection? |
string & object | U |
If set, attempts to copy the test from another sub-inspection, instead of the same sub-inspection targeted by this function. The test will be copied from the currently running sub-inspection if the provided script ID matches the ID of the running sub-inspection. | CopyableCreate.copyFromSubInspection |
- |
enabled? |
boolean |
Change whether the user is allowed to interact with the test in the UI. | - | Omit.enabled |
frozen? |
boolean |
Change whether a test is frozen in place. | - | Omit.frozen |
isAnchorPoint? |
boolean |
Whether to use this point as an anchor point with submitted data. | - | Omit.isAnchorPoint |
label? |
string |
Change the text that accompanies the test. | - | Omit.label |
location? |
object |
Contains properties to change the location of the test. | - | Omit.location |
location.column? |
number | "default" |
Change the column a test is in, between 0 and 11. | - | - |
location.insertMode? |
TestInsertMode |
If set to 'insertIntoNewRow', the test will be inserted in a new row at the given row index. If set to 'appendToExistingRow' the test will be appended to the existing row at the given row index. Defaults to 'insertIntoNewRow'. | - | - |
location.row? |
number |
Change the row a test is in. If not specified, the last row index will be used. | - | - |
matchMethod? |
CharacteristicMatchMethodType |
Change the match method that is set on this test. | - | Omit.matchMethod |
note? |
string | null |
Change the note to save with this test. | - | Omit.note |
noteType? |
NoteFunctionalityType |
Change when a note is required on a test. | - | Omit.noteType |
partOverrideId? |
number | null |
Change the part to use for this test. Expects the ID of the part. null to unset the part override. | - | Omit.partOverrideId |
processOverrideId? |
number | null |
Change the process to use for this test. Expects the ID of the process. null to unset the process override. | - | Omit.processOverrideId |
required? |
boolean |
Change whether or not the user is forced to enter data. | - | Omit.required |
scriptId? |
string |
The id used to select this test in scripts. | - | Omit.scriptId |
serialDeviceId? |
number | null |
Change the Serial Device of this spc test Use null to unset the Serial Device. | - | Omit.serialDeviceId |
showCellLabel? |
boolean |
Whether to display a label for each input cell. | - | Omit.showCellLabel |
showDescription? |
boolean |
Change whether to show the characteristic's description | - | Omit.showDescription |
showNAToggles? |
boolean |
Change whether to display buttons that allow individual values to be marked "N/A" | - | Omit.showNAToggles |
spcCharacteristicId? |
number | null |
Change the SPC Characteristic of this spc test. Use null to unset the SPC Characteristic. This will reset any values which have been entered. This cannot be set directly when the matchMethod is set to partAndTag. Use partOverrideId to change the Characteristic instead. |
- | Omit.spcCharacteristicId |
storeData? |
StoreDataFunctionalityType |
Change whether or not data will be stored for this test. | - | Omit.storeData |
subgroupSize? |
number | null |
Change the subgroup size for this test. Setting this to null will reset the subgroup size to the value set on the SPC Characteristic, or 0 if no SPC Characteristic has been set. | - | Omit.subgroupSize |
subgroupSpecificTraceIds? |
number[] |
Change the traceability assigned to this spc test. | - | Omit.subgroupSpecificTraceIds |
tagId? |
number |
Change the Tag of this spc test Use null to unset the Tag. | - | Omit.tagId |
testSpecificTrace? |
object[] |
Change the trace which have been preset for this test. This is expected to be the complete list of traceability specific to this test. Any test specific traceability not included in this list will be removed from this test. | - | Omit.testSpecificTrace |
userDefinedVisible? |
boolean |
Change whether a test can be seen. Invisible tests are treated the same as visible tests. | - | Omit.userDefinedVisible |
value? |
IWorkerSPCValue[] |
Change the values set on this spc test. The values are reset when the sub-inspection is loaded. For this value to have any effect, it must be triggered while the sub-inspection is running. The number of elements in this list must match the subgroup size of the test, either set by scripting or the SPC Characteristic. | - | Omit.value |
width? |
number |
Change the number of columns the test occupies. The minimum width for a test is defined by minWidth, and the max width is 12. | - | Omit.width |
TaskCopyableCreate
Construct a type with the properties of T except for those in type K.
Extends
Omit<TaskTestWorkerCreate,"copyFrom"|"copyFromSubInspection">.CopyableCreate
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends SubInspectionId | string & object |
- |
U extends SubInspectionId | undefined |
undefined |
Properties
| Property | Type | Description | Overrides | Inherited from |
|---|---|---|---|---|
alertId? |
number | null |
Change the real-time alert for this test. | - | Omit.alertId |
borderBottom? |
boolean |
Change whether or not there is a bottom border. | - | Omit.borderBottom |
borderLeft? |
boolean |
Change whether or not there is a left border. | - | Omit.borderLeft |
borderRight? |
boolean |
Change whether or not there is a right border. | - | Omit.borderRight |
borderTop? |
boolean |
Change whether or not there is a top border. | - | Omit.borderTop |
copyFrom? |
U extends string ? string : string |
If set, all properties not explicitly set in this object will be copied from the test with this script ID. Note that the existing test's column and row will not be copied (specify where the test should be created with the location property). The existing test with this script ID must be of the same type where the new test will be created. If the existing test contains other tests, those tests will be copied. If tests with the same script ID already exist, they will be given randomly generated script IDs. Use getProperties() on the new test to retrieve these auto-generated IDs. |
CopyableCreate.copyFrom |
- |
copyFromSubInspection? |
string & object | U |
If set, attempts to copy the test from another sub-inspection, instead of the same sub-inspection targeted by this function. The test will be copied from the currently running sub-inspection if the provided script ID matches the ID of the running sub-inspection. | CopyableCreate.copyFromSubInspection |
- |
enabled? |
boolean |
Change whether the user is allowed to interact with the test in the UI. | - | Omit.enabled |
frozen? |
boolean |
Change whether a test is frozen in place. | - | Omit.frozen |
label? |
string |
Change the text that accompanies the test. | - | Omit.label |
location? |
object |
Contains properties to change the location of the test. | - | Omit.location |
location.column? |
number | "default" |
Change the column a test is in, between 0 and 11. | - | - |
location.insertMode? |
TestInsertMode |
If set to 'insertIntoNewRow', the test will be inserted in a new row at the given row index. If set to 'appendToExistingRow' the test will be appended to the existing row at the given row index. Defaults to 'insertIntoNewRow'. | - | - |
location.row? |
number |
Change the row a test is in. If not specified, the last row index will be used. | - | - |
note? |
string | null |
Change the note to save with this test. | - | Omit.note |
noteType? |
NoteFunctionalityType |
Change when a note is required on a test. | - | Omit.noteType |
partOverrideId? |
number | null |
Change the part to use for this test. Expects the ID of the part. null to unset the part override. | - | Omit.partOverrideId |
processOverrideId? |
number | null |
Change the process to use for this test. Expects the ID of the process. null to unset the process override. | - | Omit.processOverrideId |
required? |
boolean |
Change whether or not the user is forced to enter data. | - | Omit.required |
requireSignOff? |
boolean |
Change whether or not the user must get sign-off from another user. | - | Omit.requireSignOff |
roleIds? |
number[] |
Change the roles which are allowed to sign-off on this task. | - | Omit.roleIds |
scriptId? |
string |
The id used to select this test in scripts. | - | Omit.scriptId |
showNote? |
boolean |
Change whether or not the note button should be shown for this test. | - | Omit.showNote |
storeData? |
StoreDataFunctionalityType |
Change whether or not data will be stored for this test. | - | Omit.storeData |
testSpecificTrace? |
object[] |
Change the trace which have been preset for this test. This is expected to be the complete list of traceability specific to this test. Any test specific traceability not included in this list will be removed from this test. | - | Omit.testSpecificTrace |
textToStore? |
string |
Change the text to store along with the data record. | - | Omit.textToStore |
userDefinedVisible? |
boolean |
Change whether a test can be seen. Invisible tests are treated the same as visible tests. | - | Omit.userDefinedVisible |
value? |
boolean |
Change whether or not the checkbox is currently checked. | - | Omit.value |
width? |
number |
Change the number of columns the test occupies. The minimum width for a test is defined by minWidth, and the max width is 12. | - | Omit.width |
TraceabilityCopyableCreate
Construct a type with the properties of T except for those in type K.
Extends
Omit<TraceabilityTestWorkerCreate,"copyFrom"|"copyFromSubInspection">.CopyableCreate
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends SubInspectionId | string & object | undefined |
- |
U extends SubInspectionId | undefined |
undefined |
Properties
| Property | Type | Description | Overrides | Inherited from |
|---|---|---|---|---|
borderBottom? |
boolean |
Change whether or not there is a bottom border. | - | Omit.borderBottom |
borderLeft? |
boolean |
Change whether or not there is a left border. | - | Omit.borderLeft |
borderRight? |
boolean |
Change whether or not there is a right border. | - | Omit.borderRight |
borderTop? |
boolean |
Change whether or not there is a top border. | - | Omit.borderTop |
copyFrom? |
U extends string ? string : T extends string ? string : string |
If set, all properties not explicitly set in this object will be copied from the test with this script ID. Note that the existing test's column and row will not be copied (specify where the test should be created with the location property). The existing test with this script ID must be of the same type where the new test will be created. If the existing test contains other tests, those tests will be copied. If tests with the same script ID already exist, they will be given randomly generated script IDs. Use getProperties() on the new test to retrieve these auto-generated IDs. |
CopyableCreate.copyFrom |
- |
copyFromSubInspection? |
string & object | U |
If set, attempts to copy the test from another sub-inspection, instead of the same sub-inspection targeted by this function. The test will be copied from the currently running sub-inspection if the provided script ID matches the ID of the running sub-inspection. | CopyableCreate.copyFromSubInspection |
- |
enabled? |
boolean |
Change whether the user is allowed to interact with the test in the UI. | - | Omit.enabled |
frozen? |
boolean |
Change whether a test is frozen in place. | - | Omit.frozen |
label? |
string |
Change the text that accompanies the test. | - | Omit.label |
location? |
object |
Contains properties to change the location of the test. | - | Omit.location |
location.column? |
number | "default" |
Change the column a test is in, between 0 and 11. | - | - |
location.insertMode? |
TestInsertMode |
If set to 'insertIntoNewRow', the test will be inserted in a new row at the given row index. If set to 'appendToExistingRow' the test will be appended to the existing row at the given row index. Defaults to 'insertIntoNewRow'. | - | - |
location.row? |
number |
Change the row a test is in. If not specified, the last row index will be used. | - | - |
options? |
number[] | string[] | null |
Change the available options for a user to select from for this traceability. This may only be used on text or number traceabiilty. When used on text traceability, the provided options must be strings. When used on a number field (int, decimal, or currency), the provided options must be numbers. |
- | Omit.options |
required? |
boolean | null |
Change whether or not the user is forced to enter data. Unsetting this using null will fall back to the required setting on the Traceability. |
- | Omit.required |
restricted? |
WorkerTraceRestrictionType |
Change whether this traceability test is restricted to certain options. If the traceability does not have any preset options and this is true, an empty list will be displayed. | - | Omit.restricted |
scriptId? |
string |
The id used to select this test in scripts. | - | Omit.scriptId |
traceabilityId? |
number |
Set the traceability field for this test. This is required if copyFrom is not specified. |
- | Omit.traceabilityId |
userDefinedVisible? |
boolean |
Change whether a test can be seen. Invisible tests are treated the same as visible tests. | - | Omit.userDefinedVisible |
value? |
string | number | boolean | Date | null |
Change the current traceability value for the test. If the traceability test is restricted, the value must match one of the preset options. | - | Omit.value |
width? |
number |
Change the number of columns the test occupies. The minimum width for a test is defined by minWidth, and the max width is 12. | - | Omit.width |