workbook.createPositionValues(options)

Note:

The content in this help topic applies to SuiteScript 2.x.

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.

Related Topics

N/workbook Module

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices