workbook.createExpression(options)
Method Description |
Creates an expression, that includes a function ID and parameters. Expressions can be used to create a pivot definition, a data dimension item, a measure, a conditional filter, and a dimension sort. |
Returns |
|
Supported Script Types |
Server scripts For more information, see SuiteScript 2.x Script Types. |
Governance |
None |
Module |
|
Sibling Module Members |
|
Since |
2020.2 |
Parameters
The options
parameter is a JavaScript object.
Parameter |
Type |
Required / Optional |
Description |
---|---|---|---|
|
required |
The function for the expression. |
|
|
Object |
optional |
The parameters for the expression. |
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
...
// Create a basic Expression
var myExpression = workbook.createExpression({
functionId: query.Operator.EMPTY
});
// Create a complete Expression
var myExpression = workbook.createExpression({
functionId: query.Operator.EQUAL,
parameters: {
parm1: 15
}
});
...
// Add additional code