workbook.createDataMeasure(options)
Method Description |
Creates a data measure. |
Returns |
|
Supported Script Types |
Server scripts For more information, see SuiteScript 2.x Script Types. |
Governance |
None |
Module |
|
Sibling Module Members |
|
Since |
2021.2 |
Parameters
The options
parameter is a JavaScript object.
Parameter |
Type |
Required / Optional |
Description |
---|---|---|---|
|
string |
required |
The type of aggregation to use for the data measure. |
|
required for single-expression measures (in which |
The expression for the data measure (if the data measure is a single-expression measure). |
|
|
required for multi-expression measures (in which |
The expressions for the data measure (if the data measure is a multi-expression measure). |
|
|
string | workbook.Expression |
optional |
The label for the data measure. |
Errors
Error Code |
Thrown If |
---|---|
|
The |
|
Both |
Syntax
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