workbook.createPositionUnits(options)
The content in this help topic applies to SuiteScript 2.x.
Method Description |
Creates a background position defined using x-y coordinates and units. |
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 |
---|---|---|---|
|
string |
required |
The units to use for x-y coordinates. |
|
number |
required |
The x coordinate. |
|
number |
required |
The y coordinate. |
Errors
Error Code |
Thrown If |
---|---|
|
The resulting position is not included in the workbook.Position enum. |