Record.findMatrixSublistLineWithValue(options)
|
Method Description |
Returns the line number of the first instance where a specified value is found in a specified column of the matrix. Note that line and column indexing begins at 0 with SuiteScript 2.x. (dynamic and standard modes — see SuiteScript 2.x Standard and Dynamic Modes) |
|
Returns |
number |
|
Supported Script Types |
Client and server scripts For more information, see SuiteScript 2.x Script Types. |
|
Governance |
None |
|
Module |
|
|
Sibling Object Members |
|
|
Since |
2015.2 |
Parameters
The options parameter is a JavaScript object.
|
Parameter |
Type |
Required / Optional |
Description |
Since |
|---|---|---|---|---|
|
|
string |
required |
The internal ID of the sublist. This value is displayed in the Records Browser. For more information, see Working with the SuiteScript Records Browser. |
2016.2 |
|
|
string |
required |
The ID of the matrix field. |
2016.2 |
|
|
number |
required |
The value to search for. |
2016.2 |
|
|
number |
required |
The column number of the field. Note that column indexing begins at 0 with SuiteScript 2.x. |
2016.2 |
Errors
|
Error Code |
Thrown If |
|---|---|
|
|
A required argument is invalid or the sublist is not editable. |
|
|
A required argument is missing or undefined. |
Syntax
The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/record Module Script Samples.
// Add additional code
...
var lineNumber = objRecord.findMatrixSublistLineWithValue({
sublistId: 'item',
fieldId: 'price',
value: 233,
column: 17
});
...
// Add additional code