Show:

Plugin that adds default and custom sorting functionality to the Recordset utility

Methods

_defSortFn

() private

Method that all sort calls go through. Sets up the lastSortProperties object with the details of the sort, and passes in parameters to the "defaultSorter" or a custom specified sort function.

flip

() public

Sorts the recordset based on the last-used sort parameters, but flips the order. (ie: Descending becomes ascending, and vice versa).

initializer

() protected

Sets up the default function to use when the "sort" event is fired.

resort

() public

Resorts the recordset based on the last-used sort parameters (stored in 'lastSortProperties' ATTR)

reverse

() public

Reverses the recordset calling the standard array.reverse() method.

sort

(
  • field
  • desc
)
public

Sorts the recordset.

Parameters:

  • field String

    A key to sort by.

  • desc Boolean

    True if you want sort order to be descending, false if you want sort order to be ascending

Attributes

defaultSorter

Function public

Default sort function to use if none is specified by the user. Takes two records, the key to sort by, and whether sorting direction is descending or not (boolean). If two records have the same value for a given key, the ID is used as the tie-breaker.

defaultSorter

Function public

A boolean telling if the recordset is in a sorted state.

lastSortProperties

Object public

The last properties used to sort. Consists of an object literal with the keys "field", "desc", and "sorter"