handsontable/plugins/columnSorting/columnSorting.d.ts

Handsontable is a JavaScript Data Grid available for React, Angular and Vue.

import Core from '../../core';
import { GridSettings } from '../../settings';
import { BasePlugin } from '../base';

export type SortOrderType = 'asc' | 'desc';
export interface Config {
  column: number;
  sortOrder: SortOrderType;
}

export interface DetailedSettings {
  initialConfig?: Config | Config[];
  sortEmptyCells?: boolean;
  indicator?: boolean;
  headerAction?: boolean;
  compareFunctionFactory?: ((sortOrder: SortOrderType, columnMeta: GridSettings) =>
    (value: any, nextValue: any) => -1 | 0 | 1);
}

export type Settings = boolean | DetailedSettings;

export class ColumnSorting extends BasePlugin {
  constructor(hotInstance: Core);
  isEnabled(): boolean;
  sort(sortConfig: Config | Config[]): void;
  clearSort(): void;
  isSorted(): boolean;
  getSortConfig(column?: number): Config | Config[];
  setSortConfig(sortConfig?: Config | Config[]): void;
}