workbook.createPositionValues(options)

Method Description	Creates a background position defined using position values.
Returns	workbook.PositionValues
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.horizontal	string	required	The units to use for x-y coordinates.
options.vertical	string	required	The x coordinate.

Errors

Error Code	Thrown If
INVALID_POSITION	The value of any of the options.horizontal or options.vertical parameters is not included in the workbook.Position 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 myPositionValues = workbook.createPositionValues({
    horizontal: workbook.Position.CENTER,
    vertical: workbook.Position.LEFT
});
...
// Add additional code 

          

Related Topics

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

General Notices