Legend Object Members for SuiteScript Workbook Integration

The Legend object in SuiteScript provides several members that are essential for charting within workbooks. These members allow developers to manage chart axes, data dimensions, and sort definitions, enhancing visual data representation and analysis.

What Members Does the Legend Object Include?

The Legend object provides the following key members:

Error Handling

When working with properties of the Legend object, be aware of potential errors:

• Error Code: WRONG_PARAMETER_TYPE
  • Thrown If: The value specified for a property is not a valid workbook.ChartAxis.

Code Sample

Below is an example to demonstrate how you might access the Legend.axes member of a workbook:

1// Add additional code
2...
3// View Legend.axes in a Chart
4var myWorkbook = workbook.load({
5    id: myWorkbookId
6});
7 
8log.audit({
9    title: 'Legend.axes = ',
10    details: myWorkbook.charts[0].legend.axes
11});
12...
13// Add additional code

This example illustrates the syntax to access and log the legend axes of a chart within a workbook, enhancing your ability to customize data visualizations in NetSuite.

Additional Context

For more detailed implementations, consider referring to the N/workbook Module, where further examples and complete scripts are available.

Related Resources

• [N/workbook Module]: This module includes additional properties and methods related to workbook functionalities in SuiteScript.
• [SuiteScript 2.x Script Types]: An overview of various script types supported in SuiteScript, critical for understanding the context of the Legend object usage.

Key Takeaways

• The Legend object in SuiteScript provides essential members for charts.
• Key members include axes, root dimensions, and sort definitions.
• Proper error handling is crucial when dealing with object properties.
• Accessing Legend properties enhances the customization of data visualizations.