workbook.createColor(options)
Method Description |
Creates a color. |
Returns |
|
Supported Script Types |
Server scripts For more information, see SuiteScript 2.x Script Types. |
Governance |
None |
Module |
|
Sibling Module Members |
|
Since |
2021.2 |
Parameters
The options
parameter is a JavaScript object.
Parameter |
Type |
Required / Optional |
Description |
---|---|---|---|
|
number |
optional |
The alpha portion (opacity or transparency) of the color. |
|
number |
optional |
The blue portion of the color. |
|
number |
optional |
The green portion of the color. |
|
number |
optional |
The red portion of the color. |
Errors
Error Code |
Thrown If |
---|---|
|
The value of any of the |
|
The value of the |
Syntax
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. Also see Full scripts in the Tutorial: Creating a Workbook Using the Workbook API topic.
// Add additional code
...
var myColor = workbook.createColor({
alpha: 0.4,
blue: 255,
green: 192,
red: 203
});
...
// Add additional code