TinyBase logoTinyBase

SortedRowIdsArgs

The SortedRowIdsArgs type describes the arguments used to sort Row Ids using the getSortedRowIds method.

{
  tableId: Id;
  cellId?: Id;
  descending?: boolean;
  offset?: number;
  limit?: number;
}
TypeDescription
tableIdId

The Id of the Table in the Store, required.

cellId?Id

The optional Id of the Cell whose values are used for the sorting, defaults to sorting by the Row Id itself.

descending?boolean

Whether the sorting should be in descending order, defaulting to false.

offset?number

The number of Row Ids to skip for pagination purposes, defaulting to 0.

limit?number

The maximum number of Row Ids to return, defaulting to all.

It's an object containing the Id of the Table in the Store, and optional cellId, descending, offset, and limit parameters. See the getSortedRowIds method for specific examples.

Since

v6.1.0