AdapTable Version:

Framework:

CustomSortApi

Provides run-time access to the Custom Sort function

TypeScript

export interface

Methods

Method	Description
addCustomSort(customSort)	Adds a Custom Sort to Custom Sort collection in Adaptable State
createCustomSort(params)	Creates new Custom Sort based on given values
deleteCustomSort(columnId)	Removes Custom Sort for a given ColumnId
editCustomSort(customSort)	Edits a Custom Sort
editCustomSortValues(columnId, values)	Updates existing Custom Sort with new set of Sorted Values
getActiveCustomSorts(config)	Retrieves all Custom Sorts that are active (not-suspended) in Adaptable State
getCustomSortById(id, config)	Retrieves Custom Sort by the technical ID (from `CustomSortState`)
getCustomSortByName(name)	Retrieves a Custom Sort by its Name
getCustomSortForColumn(columnId)	Retrieves Custom Sort from Adaptable State for Column with given ColumnId
getCustomSorts(config)	Retrieves all Custom Sorts in Adaptable State
getCustomSortState()	Retrieves Custom Sort section from Adaptable State
getLiveCustomSortComparers()	Returns all Custom Sort Comparers in Custom Sort Options that are currently applied
getLiveCustomSorts()	Retrieves all Custom Sorts in Adaptable State that are currently applied
getSuspendedCustomSorts(config)	Retrieves all Custom Sorts that are suspended in Adaptable State
openCustomSortSettingsPanel()	Opens Settings Panel with Custom Sort section selected and visible
suspendAllCustomSort()	Suspends all Custom Sorts
suspendCustomSort(customSort)	Suspends Custom Sort
unSuspendAllCustomSort()	Activates all suspended Custom Sort
unSuspendCustomSort(customSort)	Un-suspends or activates a suspended Custom Sort

Method Details

addCustomSort

Adds a Custom Sort to Custom Sort collection in Adaptable State

TypeScript

addCustomSort(customSort: CustomSort): CustomSort;

Parameters

Parameter	Type	Description
customSort	`CustomSort`	Custom Sort to add

Returns

CustomSort

createCustomSort

Creates new Custom Sort based on given values

TypeScript

createCustomSort(params: {
        name: string;
        columnId: string;
        values: string[];
    }): CustomSort;

Parameters

Parameter	Type	Description
params	`\{ name: string; columnId: string; values: string[]; \}`	Parameters for creating a Custom Sort

Returns

CustomSort

deleteCustomSort

Removes Custom Sort for a given ColumnId

TypeScript

deleteCustomSort(columnId: string): void;

Parameters

Parameter	Type
columnId	`string`

Returns

void

editCustomSort

Edits a Custom Sort

TypeScript

editCustomSort(customSort: CustomSort): CustomSort;

Parameters

Parameter	Type	Description
customSort	`CustomSort`	Custom Sort to Edit

Returns

CustomSort

editCustomSortValues

Updates existing Custom Sort with new set of Sorted Values

TypeScript

editCustomSortValues(columnId: string, values: string[]): CustomSort;

Parameters

Parameter	Type	Description
columnId	`string`	Id of Column on which to edit the Custom Sort
values	`string[]`	Custom Sort values to use (replaces what was previously used)

Returns

CustomSort

getActiveCustomSorts

Retrieves all Custom Sorts that are active (not-suspended) in Adaptable State

TypeScript

getActiveCustomSorts(config?: LayoutExtendedConfig): CustomSort[];

Parameters

Parameter	Type
config	`LayoutExtendedConfig`

Returns

CustomSort[]

getCustomSortById

Retrieves Custom Sort by the technical ID (from CustomSortState)

TypeScript

getCustomSortById(id: CustomSort['Uuid'], config?: LayoutExtendedConfig): CustomSort;

Parameters

Parameter	Type	Description
id	`CustomSort['Uuid']`	Custom Sort technical id
config	`LayoutExtendedConfig`

Returns

CustomSort

getCustomSortByName

Retrieves a Custom Sort by its Name

TypeScript

getCustomSortByName(name: string): CustomSort | undefined;

Parameters

Parameter	Type	Description
name	`string`	Name of the Custom Sort

Returns

CustomSort | undefined

getCustomSortForColumn

Retrieves Custom Sort from Adaptable State for Column with given ColumnId

TypeScript

getCustomSortForColumn(columnId: string): CustomSort | undefined;

Parameters

Parameter	Type	Description
columnId	`string`	Id of Column to retrieve Custom Sort for

Returns

CustomSort | undefined

getCustomSorts

Retrieves all Custom Sorts in Adaptable State

TypeScript

getCustomSorts(config?: LayoutExtendedConfig): CustomSort[];

Parameters

Parameter	Type
config	`LayoutExtendedConfig`

Returns

CustomSort[]

getCustomSortState

Retrieves Custom Sort section from Adaptable State

TypeScript

getCustomSortState(): CustomSortState;

Returns

CustomSortState

getLiveCustomSortComparers

Returns all Custom Sort Comparers in Custom Sort Options that are currently applied

TypeScript

getLiveCustomSortComparers(): ColumnValuesComparer[];

Returns

ColumnValuesComparer[]

getLiveCustomSorts

Retrieves all Custom Sorts in Adaptable State that are currently applied

TypeScript

getLiveCustomSorts(): CustomSort[];

Returns

CustomSort[]

getSuspendedCustomSorts

Retrieves all Custom Sorts that are suspended in Adaptable State

TypeScript

getSuspendedCustomSorts(config?: LayoutExtendedConfig): CustomSort[];

Parameters

Parameter	Type
config	`LayoutExtendedConfig`

Returns

CustomSort[]

openCustomSortSettingsPanel

Opens Settings Panel with Custom Sort section selected and visible

TypeScript

openCustomSortSettingsPanel(): void;

Returns

void

suspendAllCustomSort

Suspends all Custom Sorts

TypeScript

suspendAllCustomSort(): void;

Returns

void

suspendCustomSort

Suspends Custom Sort

TypeScript

suspendCustomSort(customSort: CustomSort): CustomSort;

Parameters

Parameter	Type	Description
customSort	`CustomSort`	Custom Sort to suspend

Returns

CustomSort

unSuspendAllCustomSort

Activates all suspended Custom Sort

TypeScript

unSuspendAllCustomSort(): void;

Returns

void

unSuspendCustomSort

Un-suspends or activates a suspended Custom Sort

TypeScript

unSuspendCustomSort(customSort: CustomSort): CustomSort;

Parameters

Parameter	Type	Description
customSort	`CustomSort`	Custom Sort to suspend

Returns

CustomSort

PreviousCustomSort NextCustomSortOptions