PositionUnits Object Members in SuiteScript 2.1

TL;DR Opening

The PositionUnits object in SuiteScript provides essential properties for defining a position with specific units and coordinates within a workbook. Understanding its members is crucial for effective script development.

What is the PositionUnits Object?

The PositionUnits object is used to define a position within a workbook using numeric values and associated units. It plays a significant role in various scripting contexts, particularly in the creation and manipulation of workbook elements.

PositionUnits Object Members

The following members are available within the workbook.PositionUnits object:

How to Create a PositionUnits Object

To create a PositionUnits object, utilize the workbook.createPositionUnits(options) method:

1// Example of creating a PositionUnits object
2var myPositionUnits = workbook.createPositionUnits({
3    unit: workbook.Unit.CM,
4    x: 3,
5    y: 3
6});

Important Properties

• unit: The property PositionUnits.unit specifies the measurement units for the position. This is critical for ensuring that the position is defined correctly in the context of workbook dimensions.
• x: Represents the horizontal position. It is denoted as a numeric value.
• y: Represents the vertical position. It is also a numeric value.

Error Handling

Be mindful of the potential errors when working with the PositionUnits object:

• INVALID_UNIT: Thrown if the specified value for unit is not included in the workbook.Unit enumeration.
• WRONG_PARAMETER_TYPE: This occurs if the value specified is not of string type for the unit property.

Who This Affects

This information is particularly relevant for:

• Developers who are working with SuiteScript for custom workbook implementations.
• Administrators managing and scripting around workbook functionalities in NetSuite.

Key Takeaways

• The PositionUnits object is vital for defining positions within a workbook.
• It includes properties for units of measure, as well as x and y coordinates.
• Proper understanding and implementation can significantly enhance workbook functionality within SuiteScript.