@progress/kendo-angular-treelist
Version:
Kendo UI TreeList for Angular - Display hierarchical data in an Angular tree grid view that supports sorting, filtering, paging, and much more.
68 lines (67 loc) • 2.03 kB
TypeScript
/**-----------------------------------------------------------------------------------------
* Copyright © 2025 Progress Software Corporation. All rights reserved.
* Licensed under commercial license. See LICENSE.md in the project root for more information
*-------------------------------------------------------------------------------------------*/
/**
* Defines the settings for sorting the TreeList column.
*
* @example
* ```html
* <kendo-treelist ...>
* <kendo-treelist-column field="ProductName" [sortable]="{ allowUnsort: true, initialDirection: 'asc'}">
* </kendo-treelist-column>
* </kendo-treelist>
* ```
*/
export type ColumnSortSettings = boolean | {
/**
* Enables the removal of the column sorting.
*/
allowUnsort?: boolean;
/**
* Determines the initial (from the unsorted to the sorted state) sort direction.
*
* The available values for setting the initial sort direction are:
* - `asc` (default)
* - `desc`
*/
initialDirection?: 'asc' | 'desc';
};
/**
* Specifies a modifier key when multiple sort.
*
* @example
* ```html
* <kendo-treelist [sortable]="{ mode: 'multiple', multiSortKey: 'shift' }">
* <kendo-treelist-column field="ProductID"></kendo-treelist-column>
* ...
* </kendo-treelist>
* ```
*/
export type ModifierKey = 'none' | 'ctrl' | 'shift' | 'alt';
/**
* Defines the settings for sorting the TreeList.
*
* @example
* ```html
* <kendo-treelist [sortable]="{ mode: 'multiple', allowUnsort: false}"></kendo-treelist>
* ```
*/
export type SortSettings = boolean | ColumnSortSettings & {
/**
* The sort mode of the TreeList.
*
* The available values for setting the sort modes are:
* - `single`
* - `multiple`
*/
mode?: 'single' | 'multiple';
/**
* Enables the sort-sequence indicators for sorting multiple columns.
*/
showIndexes?: boolean;
};
/**
* @hidden
*/
export declare const normalize: (...settings: (SortSettings | ColumnSortSettings)[]) => any;