1. SuiteCloud Platform
  2. SuiteScript
  3. SuiteScript 2.x API Reference
  4. SuiteScript 2.x Modules
  5. N/currentRecord Module
  6. currentRecord.CurrentRecord
  7. CurrentRecord.getMatrixHeaderValue(options)

CurrentRecord.getMatrixHeaderValue(options)

Method Description

Gets the value for the associated header in the matrix.

Returns

number | Date | string | array | boolean

Supported Script Types

Client scripts

For more information, see SuiteScript 2.x Script Types.

Governance

None

Module

N/currentRecord Module

Since

2016.2
Parameters
Note:

The options parameter is a JavaScript object.

Parameter

Type

Required / Optional

Description

Since

options.sublistId

string

required

The internal ID of the sublist that contains the matrix.

This value is displayed in the Records Browser. For more information, see Working with the SuiteScript Records Browser.

2016.2

options.fieldId

string

required

The internal ID of the matrix field.

See Finding Internal IDs of Record Fields.

2016.2

options.column

number

required

The column number for the field.

2016.2
Errors

Error Code

Thrown If

SSS_MISSING_REQD_ARGUMENT

A required argument is missing or undefined.
Syntax
Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/currentRecord Module Script Samples.

          //Add additional code 
...
var value = objRecord.getMatrixHeaderValue({
    sublistId: 'item',
    fieldId: 'item',
    column: 12
});
... 
//Add additional code

Related Topics

General Notices