N/workbook Module Members
Learn about N/workbook module members, which support various objects and methods for effective SuiteScript development.
TL;DR Opening
The N/workbook module provides essential members for SuiteScript development, enabling developers to create and manipulate various workbook components effectively. This module plays a critical role in data analysis and visualization within NetSuite, allowing users to work with datasets through charts, tables, and other graphical representations.
What are N/workbook Module Members?
The N/workbook module encompasses a variety of objects and methods that facilitate the creation and management of workbooks in NetSuite. Below is a detailed breakdown of the members available in this module, including their types, return values, and descriptions.
Workbook Module Members Overview
The following table summarizes the members of the N/workbook module:
| Member Name | Type | Return Type / Value Type | Supported Script Types | Description |
|---|---|---|---|---|
workbook.Aspect | Object | Server scripts | An aspect. | |
workbook.CalculatedMeasure | Object | Server scripts | A calculated measure. | |
workbook.Category | Object | Server scripts | A chart category. | |
workbook.Chart | Object | Server scripts | A chart. | |
workbook.ChartAxis | Object | Server scripts | A chart axis object used when creating a category or legend. | |
workbook.ChildNodesSelector | Object | Server scripts | A selector for child nodes. | |
workbook.Color | Object | Server scripts | A color. | |
workbook.ConditionalFilter | Object | Server scripts | A conditional filter. | |
workbook.ConditionalFormat | Object | Server scripts | A conditional format. | |
workbook.ConditionalFormatRule | Object | Server scripts | A conditional format rule. | |
| ... | ... | ... | ... | ... |
workbook.createTableColumnFilter(options) | Object | Server scripts | Creates a table filter. | |
workbook.list() | Object[] | Server scripts | Lists all existing workbooks. | |
workbook.loadWorkbook(options) | workbook.Workbook | Server scripts | Loads an existing workbook. |
Key Methods in N/workbook Module
Here are some of the significant methods available in the N/workbook module:
Creating a Workbook
You can create a workbook using the following code:
var myWorkbook = workbook.create({ id: "workbookId"});Creating an Aspect
To create an aspect for a chart series, use:
var myAspect = workbook.createAspect({ measure: myMeasure, type: workbook.AspectType.COLOR});Listing Workbooks
To list all existing workbooks:
var workbooks = workbook.list();Who This Affects
The following roles may find the N/workbook module members especially useful:
- Developers: To create custom reports and visualizations.
- Administrators: For managing data analytics solutions.
- Analysts: To ensure robust reporting functionalities.
Key Takeaways
- The N/workbook module supports various objects crucial for data analysis.
- Several member methods exist for creating, listing, and manipulating workbooks.
- This module is invaluable for developers seeking to enhance reporting capabilities within NetSuite.
Frequently Asked Questions (4)
Do I need any specific permissions to use the N/workbook module members?
Is the N/workbook module available for client scripts or just server scripts?
How can I load an existing workbook using the N/workbook module?
Can I use N/workbook module members to create conditional formats in my workbooks?
Was this article helpful?
More in SuiteScript
- SuiteScript 2.1 Enhancements in NetSuite February Updates
SuiteScript 2.1 now supports async features and PATCH method. Discover the latest API and SuiteProcurement improvements.
- Scheduling Map/Reduce Script Deployments in NetSuite
Learn to schedule map/reduce script submissions, including one-time and recurring options in NetSuite.
- Binary File Support in N/https Module for SuiteScript
SuiteScript enhances capabilities with binary file support in the N/https module, allowing improved data handling in external communications.
- API Governance Units Calculation in NetSuite 2026.1
NetSuite 2026.1 introduces examples illustrating API governance unit calculations for both user event and scheduled scripts.
