Pivot.portletName

Property Description

The name of the portlet for the pivot.

Type

string | workbook.Expression

Module

N/workbook Module

Parent Object

workbook.Pivot

Sibling Object Members

Pivot Object Members

Since

2021.2

Errors

Error Code	Thrown If
`WRONG_PARAMETER_TYPE`	The value for this property is not a string or workbook.Expression

Error Code

Thrown If

WRONG_PARAMETER_TYPE

The value for this property is not a string or workbook.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. Also see Full scripts in the Tutorial: Creating a Workbook Using the Workbook API topic.

            // Add additional code
...
// View the Pivot's portlet name
var myWorkbook = workbook.load({
    id: myWorkbookId 
});

log.audit({
    title: 'Pivot portlet name = ',
    details: myWorkbook.pivot[0].portletName
});
...
// Add additional code

Errors

Syntax

Related Topics