workbook.createPositionUnits(options)

Method Description	Creates a background position defined using x-y coordinates and units.
Returns	workbook.PositionUnits
Supported Script Types	Server scripts For more information, see SuiteScript 2.x Script Types.
Governance	None
Module	N/workbook Module
Sibling Module Members	N/workbook Module Members
Since	2021.2

Parameters

Note:

The options parameter is a JavaScript object.

Parameter	Type	Required / Optional	Description
options.unit	workbook.Unit	required	The units to use for x-y coordinates.
options.x	number	required	The x coordinate.
options.y	number	required	The y coordinate.

Errors

Error Code	Thrown If
INVALID_POSITION	The resulting position is not included in the workbook.Position enum.
INVALID_UNIT	The value of the options.unit parameter is not included in the workbook.Unit enum.

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. Also see Full scripts in the Tutorial: Creating a Workbook Using the Workbook API topic.

            // Add additional code
...
var myPositionUnits = workbook.createPositionUnits ({
    unit: workbook.Unit.CM,
    x: 3,
    y: 3
});
...
// Add additional code 

          

Related Topics

• N/workbook Module
• SuiteScript 2.x Modules
• SuiteScript 2.x

General Notices