SortDefinition Object Members

TL;DR

The SortDefinition object in SuiteScript provides essential properties for defining sorting criteria in workbooks, including selector and sortBys. Understanding these members is vital for effectively leveraging sorting within pivot axes.

What is the SortDefinition Object?

The SortDefinition object is used to create sorting dimensions within workbooks, enhancing data manipulation and presentation. It allows you to define how data is sorted when creating pivot axes through methods such as workbook.createSortDefinition(options).

SortDefinition Object Members

Properties

The following properties are part of the SortDefinition object:

Supported Script Types

The SortDefinition object is specifically designed to be used within server scripts.

Example Usage

Here's how to create an instance of the SortDefinition object in your SuiteScript:

1// Add additional code
2...
3var mySortDefinition = workbook.createSortDefinition({
4    selector: myDimensionSelector,
5    sortBys: [myDimensionSort]
6});
7...
8// Add additional code

This example illustrates how to define your sorting criteria effectively using the SortDefinition object, which can then be utilized in methods that require sorting parameters, such as when creating a pivot axis.

Who This Affects

• Developers: Those implementing workbooks in SuiteScript will directly benefit from understanding the SortDefinition members.
• Administrators: Users managing reports and dashboards can leverage sorting functionalities to enhance data visibility.

Key Takeaways

• The SortDefinition object includes essential properties for sorting in workbooks.
• selector and sortBys are vital for customizing sorting behavior.
• This object is used within server scripts, enhancing the flexibility of data manipulations in NetSuite.