Get Free Trial
API reference
Table of contents

setFlatSort

setFlatSort(flatSort: Array)

[starting from version: 2.8.2]

Sorts columns in the flat view.

Note that the setFlatSort method is available only for reports based on "csv", "json", and "api" data source types.

Parameters

Array of objects that defines sorting in the flat view. Each object has the following properties:

  • uniqueName – String. The unique name of the column being sorted.
  • sort – String. The sorting type ("asc", "desc", or "undefined").

Note: columns are sorted in the order they were specified (i.e., the first column is sorted first, and so on). Therefore, take the columns’ order into account when sorting multiple columns. See an example on JSFiddle.

Example

let sort = [ 
  {
      uniqueName: "Category",
      sort: "desc"
  },
  {
      uniqueName: "Price",
      sort: "asc"
  }
];
flexmonster.setFlatSort(sort); 

Try the example on JSFiddle.

See also

getFlatSort
getSort
setSort
sortingMethod