Table.headerRows

Note:

The content in this help topic pertains to SuiteScript 2.1.

Property Description

The extracted header rows from the table in a document.

Header rows refer to rows located at the top of a table. These rows contain labels that help to organize the data in subsequent rows. Each header row is a collection of cells (as documentCapture.Cell objects contained in a documentCapture.TableRow object).

Type

documentCapture.TableRow[]

Supported Script Types

Server scripts

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

Module

N/documentCapture Module

Parent Object

documentCapture.Table

Sibling Object Members

Table Object Members

Since

2025.2

Errors

Error Code	Thrown If
`READ_ONLY`	You try to set the value of this property.

Error Code

Thrown If

READ_ONLY

You try to set the value of this property.

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/documentCapture Module Script Samples.

            // Add additional code
...

const extractedData = documentCapture.documentToStructure({
    file: file.load("SuiteScripts/sample_invoice.pdf"),
    documentType: documentCapture.DocumentType.INVOICE,
    features: [documentCapture.Feature.TABLE_EXTRACTION]
});

const tableHeaderRows = extractedData.pages[0].tables[0].headerRows;

...
// Add additional code

General Notices