Series Object Members in NetSuite SuiteScript Workbook API

The Series object in NetSuite SuiteScript is crucial for developers working with the workbook API to visualize data through charts. Understanding its members and how to interact with them is essential for efficient data presentation.

What is the Series Object?

The Series object represents a series within a workbook, primarily used to define chart elements. It allows developers to manage the aspects of the series effectively.

Series Object Members

The following table summarizes the available members for the workbook.Series object:

How to Create a Series

To create a Series object, you can use the workbook.createSeries(options) method. Below is an example demonstrating the creation and retrieval of a Series object:

1// Add additional code
2...
3// Create a Series
4var mySeries = workbook.createSeries({
5    aspects: [myAspect]
6});
7 
8// View a workbook.Series used in a Chart
9var myWorkbook = workbook.load({
10    id: myWorkbookId
11});
12 
13var mySeries = myWorkbook.charts[0].series[0];
14 
15log.audit({
16    title: 'Series.aspects = ',
17    details: mySeries.aspects[0]
18});
19...
20// Add additional code

Error Handling

It’s important to note that if a wrong parameter type is specified, particularly for the aspects property, an error will be triggered. The relevant error code is:

• WRONG_PARAMETER_TYPE: Thrown if the value specified is not a workbook.Aspect[].

Related Documentation

For more clarity on operations or further exploration, refer to:

• N/workbook Module
• SuiteScript 2.x Modules
• SuiteScript 2.x

Key Points

• The Series object is used within the workbook for chart definition.
• The aspects property specifies the specific attributes of the series.
• Proper parameter handling is essential to avoid runtime errors.