Color Object Members for SuiteScript Workbook Module

TL;DR Opening

Color objects in SuiteScript allow developers to define colors for workbook elements using red, green, blue, and alpha (transparency) values. This capability is crucial for creating visually distinct and appealing outputs in NetSuite workbooks.

Overview of Color Object Members

The workbook.Color object in SuiteScript enables you to create and manipulate colors within a workbook. Here are the available members associated with this object:

Creating a Color Object

You can create a new color object using the workbook.createColor(options) method. Here's an example that demonstrates the syntax for creating a color:

1// Create a color object
2var myColor = workbook.createColor({
3    red: 255,
4    green: 192,
5    blue: 203,
6    alpha: 0.5
7});

Accessing Color Properties

Once a color object is created, you can access its properties directly. For instance, to retrieve the alpha value:

var theAlpha = myColor.alpha;

Error Handling

While working with colors, it's important to ensure that the values for the alpha, red, green, and blue properties are within the required ranges to avoid errors:

• Error Code: INVALID_ALPHA_VALUE
  • Thrown if the alpha value is not between 0 and 255.
• Error Code: WRONG_PARAMETER_TYPE
  • Thrown if the value specified for any property is not a number.

Key Considerations

• The color object is supported in server scripts, allowing for dynamic styling in workbook generation.
• Ensure that alpha values are set correctly to avoid transparency issues in outputs.

Who This Affects

• Developers: Those implementing or enhancing SuiteScript applications utilizing the workbook module.
• Administrators: Users who configure or customize the workbooks for reporting or data visualization purposes.

Key Takeaways

• Color objects facilitate custom styling in SuiteScript using RGBA values.
• Proper handling of color property values is essential to avoid runtime errors.
• The workbook module allows for dynamic content generation in NetSuite's SuiteScript environment.

Source: This article is based on Oracle's official NetSuite documentation.