@adaptabletools/adaptable/src/Api/Implementation/CustomSortApiImpl.d.ts

Powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements

import { ApiBase } from './ApiBase';
import { CustomSortApi } from '../CustomSortApi';
import { CustomSort, CustomSortState } from '../../AdaptableState/CustomSortState';
import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
import { CustomSortInternalApi } from '../Internal/CustomSortInternalApi';
import { ColumnValuesComparer } from '../../AdaptableOptions/CustomSortOptions';
export declare class CustomSortApiImpl extends ApiBase implements CustomSortApi {
    internalApi: CustomSortInternalApi;
    constructor(_adaptable: IAdaptable);
    getCustomSortState(): CustomSortState;
    getCustomSorts(config?: {
        includeLayoutNotAssociatedObjects?: boolean;
    }): CustomSort[];
    getCustomSortById(id: CustomSort['Uuid']): CustomSort;
    getLiveCustomSorts(): CustomSort[];
    getLiveCustomSortComparers(): ColumnValuesComparer[];
    getActiveCustomSorts(config?: {
        includeLayoutNotAssociatedObjects?: boolean;
    }): CustomSort[];
    getSuspendedCustomSorts(config?: {
        includeLayoutNotAssociatedObjects?: boolean;
    }): CustomSort[];
    getCustomSortByColumn(column: string): CustomSort;
    getCustomSortForColumn(columnId: string): CustomSort | undefined;
    addCustomSort(customSort: CustomSort): CustomSort;
    createCustomSort(columnId: string, values: string[]): CustomSort;
    editCustomSort(columnId: string, values: string[]): CustomSort;
    deleteCustomSort(column: string): void;
    suspendCustomSort(customSort: CustomSort): CustomSort;
    unSuspendCustomSort(customSort: CustomSort): CustomSort;
    suspendAllCustomSort(): void;
    unSuspendAllCustomSort(): void;
    openCustomSortSettingsPanel(): void;
}