workbook.createCalculatedMeasure(options)

Method Description

Creates a calculated measure.

Returns

workbook.CalculatedMeasure

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

2021.2

Parameters

Note:

The options parameter is a JavaScript object.

Parameter	Type	Required / Optional	Description
`options.expression`	workbook.Expression	required	The expression for the calculated measure.
`options.label`	string \| workbook.Expression	optional	The label for the calculated measure.

Parameter

Type

Required / Optional

Description

options.expression

workbook.Expression

required

The expression for the calculated measure.

options.label

string | workbook.Expression

optional

The label for the calculated measure.

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 myCalculatedMeasure = workbook.createCalculatedMeasure({
    expression: measureExpression,   // previously created workbook.Expression
    label: 'Measure Label'
});
...
// Add additional code

Parameters

Syntax

Related Topics