Color.alpha

Note:

The content in this help topic applies to SuiteScript 2.x.

Property Description	The opacity, or transparency, of the color.
Type	number
Module	N/workbook Module
Parent Object	workbook.Color
Sibling Object Members	Color Object Members
Since	2021.2

Errors

Error Code	Thrown If
INVALID_ALPHA_VALUE	The value of this property is not between 0 and 255.
WRONG_PARAMETER_TYPE	The value specified for this property is not a number.

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.

            // Add additional code
...
var myColor = workbook.createColor({
    red: 255,
    green: 192,
    blue: 203,
    alpha: 0.5
});

var theAlpha = myColor.alpha;
...
// Add additional code 

          

Related Topics

N/workbook Module

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices