Interface SortOptions

Possible values for Wunderbaum.sort and WunderbaumNode.sort options argument.

interface SortOptions {
    caseInsensitive?: boolean;
    cmp?: SortCallback;
    colId?: string;
    deep?: boolean;
    key?: SortKeyCallback;
    nativeOrderPropName?: string;
    order?: SortOrderType;
    propName?: string;
    updateColInfo?: boolean;
}

Properties

caseInsensitive? cmp? colId? deep? key? nativeOrderPropName? order? propName? updateColInfo?

Properties

OptionalcaseInsensitive

caseInsensitive?: boolean

Sort string values case insensitive.

Default

false

Optionalcmp

cmp?: SortCallback

Callback that determines the order.

Default

common.nodeTitleSorter

Deprecated

use key instead

OptionalcolId

colId?: string

Column ID as defined in tree.columns definition. Required if updateColInfo is true.

Optionaldeep

deep?: boolean

Sort descendants recursively.

Default

true

Optionalkey

key?: SortKeyCallback

Callback that determines a node representation for comparison.

Default

common.nodeTitleKeyGetter

OptionalnativeOrderPropName

nativeOrderPropName?: string

Sort by this property if order is undefined. See also WunderbaumNode.resetNativeChildOrder.

Default

_nativeIndex.

Optionalorder

order?: SortOrderType

Sort order 'asc' or 'desc'.

Default

'asc' (or if updateColInfo is true, the rotated status of the column definition. See also WunderbaumOptions.sortFoldersFirst.

OptionalpropName

propName?: string

The name of the node property that will be used for sorting. Mandatory, unless key or colId are given.

OptionalupdateColInfo

updateColInfo?: boolean

Rotate sort order (asc -> desc -> none) before sorting. Update the sort icons in the column header Note: Sorting is done in-place. There is no 'unsorted' state, but we can call setCurrentSortOrder() to renumber the node._sortIdx property, which will be used as sort key, when order is undefined.

Default

false

Settings

Member Visibility

On This Page

Properties