Class SortSpec

SortSpec

The sorting specification.

Method	Return type	Brief description
`getBackgroundColor()`	`Color`	Returns the background color used for sorting, or `null` if absent.
`getDataSourceColumn()`	`DataSourceColumn`	Gets the data source column the sort spec acts on.
`getDimensionIndex()`	`Integer`	Returns the dimension index or `null` if not linked to a local filter.
`getForegroundColor()`	`Color`	Returns the foreground color used for sorting, or `null` if absent.
`getSortOrder()`	`SortOrder`	Returns the sort order.
`isAscending()`	`Boolean`	Returns whether the sort order is ascending.

Detailed documentation

Returns the background color used for sorting, or null if absent.

Color — The background color.

Scripts that use this method require authorization with one or more of the following scopes :

Gets the data source column the sort spec acts on. Returns null if this sort spec is not acting on a data source column.

DataSourceColumn — The data source column the sort spec acts on.

Scripts that use this method require authorization with one or more of the following scopes :

Returns the dimension index or null if not linked to a local filter.

Integer — The dimension index.

Scripts that use this method require authorization with one or more of the following scopes :

Returns the foreground color used for sorting, or null if absent.

Color — The foreground color.

Scripts that use this method require authorization with one or more of the following scopes :

Returns the sort order.

SortOrder — The sort order.

Scripts that use this method require authorization with one or more of the following scopes :

Returns whether the sort order is ascending.

Boolean — true if the sort order is ascending, or false otherwise.

Scripts that use this method require authorization with one or more of the following scopes :