Documentation home page
LyteNyte Grid logo for dark mode

property

SortComparatorFn

Function signature for custom sort comparators.

Parameters

leftFieldDataParam (docs)
rightFieldDataParam (docs)
optionsany

Returns

number

property

SortComparators

Predefined sort comparator types supported by LyteNyte Grid.

Type

"string" | "number" | "date" |

Variants

  • "string"
  • "number"
  • "date"
  • ``

property

SortCustomSort

Definition for a user-defined custom sort comparator.

columnId

property

The column identifier associated with the sort. May be null if not defined.

Type

null | string

Variants

  • null
  • string

comparator

property

The comparator function used for custom sorting.

TypeSortComparatorFn

kind

property

Discriminant for the custom sort type.

Value

"\"custom\""

options

property

Optional configuration for the custom comparator.

Type

any

property

SortDateColumnSort

A built-in date sort model definition.

kind

property

Discriminant for the date sort type.

Value

"\"date\""

options

property

Optional date comparator options.

TypeSortDateComparatorOptions

property

SortDateComparatorOptions

Options used for date-based sorting.

includeTime

property

Whether to include the time portion of the date during comparison.

Type

boolean

nullsFirst

property

A boolean indicating if null values should appear first in the sort order.

Type

boolean

toIsoDateString

property

A function to convert a value to an ISO date string.

Parameters

vunknown

Returns

string

property

SortGridSorts

Union of all supported grid sort types.

Type

SortCustomSort | SortDateColumnSort | SortNumberColumnSort | SortStringColumnSort

Variants

  • SortCustomSort (docs)
  • SortDateColumnSort (docs)
  • SortNumberColumnSort (docs)
  • SortStringColumnSort (docs)

property

SortModelItem

A model item representing an active sort applied to the grid.

columnId

property

The column identifier associated with the sort. May be null if not defined.

Type

null | string

Variants

  • null
  • string

isDescending

property

Whether the sort direction is descending.

Type

boolean

sort

property

The sort type being applied.

TypeSortGridSorts

property

SortNumberColumnSort

A built-in numeric sort model definition.

kind

property

Discriminant for the number sort type.

Value

"\"number\""

options

property

Optional numeric comparator options.

TypeSortNumberComparatorOptions

property

SortNumberComparatorOptions

Options for number-based sorting.

absoluteValue

property

Whether to compare absolute values instead of raw numbers.

Type

boolean

nullsFirst

property

A boolean indicating if null values should appear first in the sort order.

Type

boolean

property

SortStringColumnSort

A built-in string sort model definition.

kind

property

Discriminant for the string sort type.

Value

"\"string\""

options

property

Optional string comparator options.

TypeSortStringComparatorOptions

property

SortStringComparatorOptions

Options used when sorting string values.

caseInsensitive

property

Whether string sorting should ignore case.

Type

boolean

collator

property

An optional Intl.Collator instance to use for string comparison.

TypeCollator

ignorePunctuation

property

Whether punctuation should be ignored during sorting.

Type

boolean

locale

property

The locale used for collation-based sorting.

Type

string

nullsFirst

property

A boolean indicating if null values should appear first in the sort order.

Type

boolean

trimWhitespace

property

Whether leading/trailing whitespace should be trimmed before sorting.

Type

boolean