Sort Object Members in SuiteScript Workbook API

The Sort object in SuiteScript provides developers with a robust way to specify how data is sorted within various components such as table columns, dimensions, or measures. This feature is essential for ensuring that end-users can view data in a meaningful order, greatly impacting the usability of reports and dashboards.

What Members Does the Sort Object Include?

The workbook.Sort object has several members that control the sorting behavior:

How to Create a Sort Object

You can create a sort object using the workbook.createSort(options) function. Below are some examples to demonstrate its use:

Default Sort Example

// Create a default Sort
var mySort = workbook.createSort({});

Custom Descending Sort Example

1// Create a custom descending Sort
2var mySort = workbook.createSort({
3    ascending: false,
4    caseSensitive: true,
5    nullsLast: true,
6    locale: query.SortLocale.US_EN
7});

Accessing Sort Properties

To access properties of a Sort object after loading a workbook, you can use:

1// Load a workbook by ID
2var myWorkbook = workbook.load({
3    id: myWorkbookId
4});
5 
6// Retrieve the sort properties from a table column
7var mySort = myWorkbook.tables[0].columns[0].sort;
8 
9log.audit({
10    title: 'Sort.ascending = ',
11    details: mySort.ascending
12});
13 
14log.audit({
15    title: 'Sort.caseSensitive = ',
16    details: mySort.caseSensitive
17});
18 
19log.audit({
20    title: 'Sort.locale = ',
21    details: mySort.locale
22});
23 
24log.audit({
25    title: 'Sort.nullsLast = ',
26    details: mySort.nullsLast
27});

Conclusion

Optimizing data sorting not only enhances the aesthetic presentation of reports but also improves user experience by allowing quick insights into data. Utilizing the Sort object effectively will ensure that developers can tailor data views for their audience.