workbook.createDataDimension(options)

Note:

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

Method Description	Creates a data dimension, which includes items, child data items, and a total line. A data dimension is used in a workbook.PivotAxis, a workbook.DimensionSelector, and a workbook.Section.
Returns	workbook.DataDimension
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.Section | workbook.Measure>	optional	The child data dimensions or sections of the data dimension.
options.items	workbook.DataDimensionItem[]	required	The items of the data dimension.
options.totalLine	string	optional	The predefined formats 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.
NO_DIMENSION_ITEM_DEFINED	The options.items parameter is empty.

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 DataDimension
var myDataDimension = workbook.createDataDimension({
    items: [myDataDimensionItem]
});

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

          

Related Topics

N/workbook Module

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices