workbook.TotalLine

Note:

The content in this help topic applies to SuiteScript 2.x.

Note:

JavaScript does not include an enumeration type. The SuiteScript 2.0 documentation uses the term enumeration (or enum) to describe a plain JavaScript object with a flat, map-like structure. In this object, each key points to a read-only string value.

Enum Description

Holds formatting presets for the total line. Used to pass the totalLine value to workbook.createDataDimension(options) and to workbook.createSection(options).

Module

N/workbook Module

Sibling Module Members

N/workbook Module Members

Since

2020.2

Values

Value

FIRST_LINE

HIDDEN

LAST_LINE

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

            // Add additional code
...
var myDataDimension = workbook.createDataDimension({
    totalLine: workbook.TotalLine.HIDDEN,
    children: [mySection],
    items: [myDataDimensionItem]
});

var myFirstSection = workbook.createSection({
    totalLine: workbook.TotalLine.FIRST_LINE,
    children: [mySectionChildren]
});
...
// Add additional code 

          

Related Topics

N/workbook Module
SuiteScript 2.x Modules
SuiteScript 2.x

General Notices