Expression.functionId

Property Description

The ID of the function used in the expression.

This property uses values from the workbook.ExpressionType enum.

Type

workbook.ExpressionType

Module

N/workbook Module

Parent Object

workbook.Expression

Sibling Object Members

Expression Object Members

Since

2020.2

Errors

Error Code

Thrown If

WRONG_PARAMETER_TYPE

The value for this property is not a string ( workbook.ExpressionType).

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 myExpression = workbook.createExpression({
    functionId: workbook.ExpressionType.AND,
    parameters: {
        expressions: [expression1, expression2]
    }
});

var theFunctionId = myExpression.functionId;
...
// Add additional code 

          

Related Topics

General Notices