Custom Sort object used in Custom Sort function.

TypeScript
export interface CustomSort extends
Extends

SuspendableObject

Properties

PropertyDescription
ColumnIdId of Column on which Custom Sort will be applied
NameName of the Custom Sort definition
SortedValuesOrder of values by which Column will be sorted; Date values are persisted as ISO strings ('yyyy-MM-dd')
IsReadOnlySets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')
IsSuspendedSuspends (i.e. turns off) an Adaptable Object

Property Details

ColumnId

Id of Column on which Custom Sort will be applied

TypeScript
ColumnId: string;
Property Value

string

Name

Name of the Custom Sort definition

TypeScript
Name: string;
Property Value

string

SortedValues

Order of values by which Column will be sorted; Date values are persisted as ISO strings ('yyyy-MM-dd')

TypeScript
SortedValues?: (string | number)[];
Property Value

(string | number)[]

IsSuspended

Inherited from SuspendableObject

Suspends (i.e. turns off) an Adaptable Object

TypeScript
IsSuspended?: boolean;
Property Value

boolean

IsReadOnly

Inherited from AdaptableObject

Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')

TypeScript
IsReadOnly?: boolean;
Property Value

boolean