workbook.createSection(options)
Method Description |
Creates a section, which includes children and a total line. |
Returns |
|
Supported Script Types |
Server scripts For more information, see SuiteScript 2.x Script Types. |
Governance |
None |
Module |
|
Sibling Module Members |
|
Since |
2020.2 |
Parameters
The options
parameter is a JavaScript object.
Parameter |
Type |
Required / Optional |
Description |
---|---|---|---|
|
Array<workbook.DataDimension | workbook.Measure | workbook.Section> |
required |
The child data. |
|
optional |
Predefined format values for the total line. |
Errors
Error Code |
Thrown If |
---|---|
|
The value specified for the |
Syntax
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. Also see Full scripts in the Tutorial: Creating a Workbook Using the Workbook API topic.
// 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