DataDimension.totalLine

Property Description

The formatting specification for the total line of the data dimension.

Type

workbook.TotalLine

Module

N/workbook Module

Parent Object

workbook.DataDimension

Sibling Object Members

DataDimension Object Members

Since

2020.2

Errors

Error Code

Thrown If

INVALID_TOTAL_LINE

The value for this property is invalid. Set this parameter using values from the workbook.TotalLine enum.

WRONG_PARAMETER_TYPE

The value specified for this property is not included in the workbook.TotalLine enum.

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. Also see Full scripts in the Tutorial: Creating a Workbook Using the Workbook API topic.

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

var theTotalLine = myDataDimension.totalLine;
...
// Add additional code 

          

Related Topics

General Notices