restrictSortTo
restrictSortTo only allows sorting on specified table columns. This can be useful to prevent users from accidentally performing expensive sort operations as they interact with tables in the UI.
Syntax
table.restrictSortTo(allowedSortingColumns...)
Parameters
| Parameter | Type | Description |
|---|---|---|
| allowedSortingColumns | String... | The column(s) on which sorting is allowed. |
Returns
A new table that only allows sorting on the columns specified in the allowedSortingColumns argument.
Examples
source = newTable(
stringCol("Ticker", "AAPL", "AAPL", "IBM", "IBM", "GOOG", "GOOG"),
stringCol("Exchange", "Nyse", "Arca", "Nyse", "Arca", "Nyse", "Arca"),
intCol("Price", 75, 80, 110, 100, 25, 30),
)
result = source.restrictSortTo("Ticker", "Exchange")
tickerSorted = result.sort("Ticker")
exchangeSorted = result.sort("Exchange")
- result
- tickerSorted
- exchangeSorted
The table can be sorted by the columns Ticker or Exchange with success:
An attempt to sort a column outside the arguments of restrictSortTo will result in an error:
priceSorted = result.sort("Price")
