workbook.createExpression(options)

Note:

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

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	workbook.Expression
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	2020.2

Parameters

Note:

The options parameter is a JavaScript object.

Parameter	Type	Required / Optional	Description
options.functionId	workbook.ExpressionType	required	The function for the expression.
options.parameters	Object	optional	The parameters for the expression.

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.

            // 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 

          

Related Topics

N/workbook Module

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices