workbook.createSection(options)

Note:

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

Method Description	Creates a section, which includes children and a total line.
Returns	workbook.Section
Supported Script Types	Server scripts For more information, see SuiteScript 2.x Script Types.
Governance	None
Module	N/workbook Module
Sibling Module Members	N/workbook Module Members
Since	2020.2

Parameters

Note:

The options parameter is a JavaScript object.

Parameter	Type	Required / Optional	Description
options.children	Array<workbook.DataDimension | workbook.Measure | workbook.Section>	required	The child data.
options.totalLine	workbook.TotalLine	optional	Predefined format values for the total line.

Errors

Error Code	Thrown If
INVALID_TOTAL_LINE	The value specified for the options.totalLine parameter is invalid. Set this parameter value using workbook.TotalLine.

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
...
// Create a basic Section with DataDimension children
var mySection = workbook.createSection({
    children: [myDataDimension]
});

// Create a basic Section with Measure children
var mySection = workbook.createSection({
    children: [myMeasure]
});

// Create a basic Section with Section children
var mySection = workbook.createSection({
    children: [mySectionChildren]    // create this using a separate call to workbook.createSection
});

// Create a comprehensive Section
var mySection = workbook.createSection({
    children: [myMeasure],
    totalLine: workbook.TotalLine.HIDDEN
});
...
// Add additional code 

          

Related Topics

N/workbook Module

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices