workbook.createDataMeasure(options)

Method Description

Creates a data measure.

Returns

workbook.DataMeasure

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.aggregation`	workbook.Aggregation	required	The type of aggregation to use for the data measure.
`options.expression`	workbook.Expression	required for single-expression measures (in which `options.expressions` is not used)	The expression for the data measure (if the data measure is a single-expression measure).
`options.expressions`	workbook.Expression[]	required for multi-expression measures (in which `options.expression` is not used)	The expressions for the data measure (if the data measure is a multi-expression measure).
`options.label`	string \| workbook.Expression	optional	The label for the data measure.

Parameter

Type

Required / Optional

Description

options.aggregation

workbook.Aggregation

required

The type of aggregation to use for the data measure.

options.expression

workbook.Expression

required for single-expression measures (in which options.expressions is not used)

The expression for the data measure (if the data measure is a single-expression measure).

options.expressions

workbook.Expression[]

required for multi-expression measures (in which options.expression is not used)

The expressions for the data measure (if the data measure is a multi-expression measure).

options.label

string | workbook.Expression

optional

The label for the data measure.

Errors

Error Code	Thrown If
`AT_LEAST_ONE_EXPRESSION_IS_NEEDED`	The `options.expression` parameter is not provided and the `options.expressions` parameter is an empty array.
`MUTUALLY_EXCLUSIVE_ARGUMENTS`	Both `options.expression` and `options.expressions` are provided.

Error Code

Thrown If

AT_LEAST_ONE_EXPRESSION_IS_NEEDED

The options.expression parameter is not provided and the options.expressions parameter is an empty array.

MUTUALLY_EXCLUSIVE_ARGUMENTS

Both options.expression and options.expressions are provided.

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 myDataMeasure = workbook.createDataMeasure({
    aggregation: 'DataCount',
    expression: singleExpression,  // previously created workbook.Expression
    label: 'MeasureLabel'
});
...
// Add additional code

Parameters

Errors

Syntax

Related Topics