workbook.createStyle(options)
Method Description |
Creates a style to be used for conditional formatting. |
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 |
---|---|---|---|
|
workbook.Color | string |
optional |
The background color. |
|
string |
optional |
The background image. |
|
workbook.PositionPercent | workbook.PositionUnits | workbook.PositionValues |
optional |
The background position. |
|
workbook.Color | string |
optional |
The font color. |
|
optional |
The font size. |
|
|
optional |
The font style. |
|
|
optional |
The font weight. |
|
|
optional |
The alignment of text. |
|
|
workbook.Color | string |
optional |
The text decoration color. |
|
optional |
The text decoration line. |
|
|
workbook.TextDecorationStyle | string |
optional |
The text decoration style. |
Errors
Error Code |
Thrown If |
---|---|
|
The value of any of the |
|
The value of the |
|
The value of the |
|
The value of the |
|
The value of the |
|
The value of the |
|
The value 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 newStyle = workbook.createStyle({
backgroundColor: workbook.Color.WHITE, // backgroundColor: 'WHITE' also works
backgroundImage: 'myStyleImage', // this value must be previously defined
backgroundPosition: workbook.createPositionPercent ({
percentX: 25,
percentY: 45
}),
color: workbook.Color.BLUE, // color: 'BLUE' also works
fontSize: workbook.FontSize.MEDIUM,
fontStyle: workbook.FontStyle.NORMAL,
fontWeight: workbook.FontWeight.BOLD,
textAlign: workbook.TextAlign.CENTER,
textDecorationColor: workbook.Color.YELLOW,
textDecorationLine: workbook.TextDecorationLine.UNDERLINE,
textDecorationsStyle: workbook.TextDecorationStyle.WAVY
});
...
// Add additional code