PositionValues in SuiteScript for Custom Styles

The PositionValues object enables developers to specify precise positional values such as LEFT and CENTER in SuiteScript. This functionality is crucial for creating and manipulating styles dynamically within workbooks, enhancing the customization capabilities of reports and dashboards.

What Are PositionValues?

The PositionValues object allows for the definition of horizontal and vertical positioning in SuiteScript. You can create this object using the workbook.createPositionValues(options) method. It supports various script types, specifically server scripts.

PositionValues Object Members

The PositionValues object comprises the following properties:

Usage Example

To use the PositionValues object, refer to the following code sample:

// Example of creating a PositionValues object  
var myPositionValues = workbook.createPositionValues({  
    horizontal: workbook.Position.CENTER,  
    vertical: workbook.Position.LEFT  
});

Error Handling

When implementing the PositionValues, be aware of the following potential error codes:

• INVALID_POSITION: This error is thrown if the specified value for the horizontal or vertical property is not part of the workbook.Position enumeration.
• WRONG_PARAMETER_TYPE: This is triggered if the value assigned to the properties is not a string.

Related Resources

For additional guidance and examples, you might want to check:

• N/workbook Module
• Full scripts in the Tutorial: Creating a Workbook Using the Workbook API