workbook.createDataMeasure(options)

Note:

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

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	string	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.

Related Topics

N/workbook Module

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices