@progress/kendo-angular-treelist 19.1.2-develop.4 → 19.1.2-develop.5

package/treelist.component.d.ts

@@ -69,12 +69,39 @@ import { PagerSettings } from './common/pager-settings';
 import * as i0 from "@angular/core";
 /**
  * Represents the Kendo UI TreeList component for Angular.
+ * Use this component to display and manage hierarchical data in a tabular format.
  *
  * @example
  * ```html
- * <kendo-treelist [kendoTreeListFlatBinding]="data" ...></kendo-treelist>
+ * <kendo-treelist
+ *   [kendoTreeListFlatBinding]="data"
+ *   [pageSize]="10"
+ *   [pageable]="true">
+ * </kendo-treelist>
  * ```
  *
+ * @remarks
+ * Supported children components are:
+ * {@link CheckboxColumnComponent},
+ * {@link ColumnChooserComponent},
+ * {@link ColumnComponent},
+ * {@link ColumnGroupComponent},
+ * {@link ColumnMenuAutoSizeAllColumnsComponent},
+ * {@link ColumnMenuAutoSizeColumnComponent},
+ * {@link ColumnMenuChooserComponent},
+ * {@link ColumnMenuComponent},
+ * {@link ColumnMenuFilterComponent},
+ * {@link ColumnMenuItemComponent},
+ * {@link ColumnMenuLockComponent},
+ * {@link ColumnMenuSortComponent},
+ * {@link CommandColumnComponent},
+ * {@link CustomMessagesComponent},
+ * {@link ExcelComponent},
+ * {@link TreeListSpacerComponent},
+ * {@link PDFComponent},
+ * {@link RowReorderColumnComponent},
+ * {@link SpanColumnComponent},
+ * {@link ToolBarComponent}.
  */
 export declare class TreeListComponent implements AfterContentInit, AfterViewInit, OnDestroy, OnChanges, OnInit {
     private supportService;
@@ -103,63 +130,64 @@ export declare class TreeListComponent implements AfterContentInit, AfterViewIni
     private ctx;
     private rowReorderService;
     /**
-     * An optional accessible description of the component.
+     * Provides an accessible description of the component.
      */
     ariaLabel: string;
     /**
-     * Sets the data of the TreeList. If an array is provided, the TreeList automatically gets the total count
+     * Sets the data for the TreeList. When you provide an array, the TreeList gets the total count automatically
      * ([more information and example]({% slug databinding_treelist %})).
      */
     set data(value: Array<any> | TreeListDataResult | Observable<any> | null | undefined);
     get data(): Array<any> | TreeListDataResult | Observable<any> | null | undefined;
     /**
-     * Defines the page size used by the TreeList when [paging]({% slug paging_treelist %}) is enabled.
+     * Sets the page size for the TreeList when [paging]({% slug paging_treelist %}) is enabled.
      *
      * @default 10
      */
     pageSize: number;
     /**
-     * Defines the height (in pixels) that is used when the `scrollable` option of the TreeList is set.
-     * To set the height of the TreeList, you can also use `style.height`. The `style.height`
+     * Sets the height in pixels for the TreeList when you set the `scrollable` option.
+     * You can also use `style.height` to set the height. The `style.height`
      * option supports units such as `px`, `%`, `em`, `rem`, and others.
      */
     height: number;
     /**
-     * Represent the actual height of each TreeList row (`tr`) element in the DOM.
-     * Required by the [virtual scrolling functionality]({% slug scrollmmodes_treelist %}).
-     * Set the `rowHeight` option to the exact pixels as the height of the `tr` element appears in the DOM.
+     * Sets the actual height of each TreeList row (`tr`) element in the DOM.
+     * The [virtual scrolling functionality]({% slug scrollmmodes_treelist %}) requires this setting.
+     * Set the `rowHeight` option to match the exact pixel height of the `tr` element in the DOM.
      */
     rowHeight: number;
     /**
-     * Defines the number of records to be skipped by the pager.
-     * Required by the [paging]({% slug paging_treelist %}) functionality.
+     * Sets the number of records that the pager skips.
+     * The [paging]({% slug paging_treelist %}) functionality requires this setting.
      */
     get skip(): number | null | undefined;
     set skip(value: number | null | undefined);
     /**
-     * Defines the scroll mode used by the TreeList.
+     * Sets the scroll mode for the TreeList.
+     *
      * @default 'scrollable'
      */
     scrollable: ScrollMode;
     /**
-     * The descriptors by which the data will be sorted ([see example]({% slug sorting_treelist %})).
+     * Sets the descriptors for sorting the data ([see example]({% slug sorting_treelist %})).
      */
     set sort(value: Array<SortDescriptor> | null | undefined);
     get sort(): Array<SortDescriptor> | null | undefined;
     /**
-     * A function that defines how to track changes for the data rows.
+     * Sets a function that defines how to track changes for the data rows.
      *
      * By default, the TreeList tracks changes by the index of the data item.
-     * Edited rows are tracked by reference.
-     *
+     * The TreeList tracks edited rows by reference.
      */
     trackBy: TrackByFunction<TreeListItem>;
     /**
-     * The descriptor by which the data will be filtered ([see examples]({% slug filtering_treelist %})).
+     * Sets the descriptor for filtering the data ([see examples]({% slug filtering_treelist %})).
      */
     filter: CompositeFilterDescriptor | null | undefined;
     /**
-     * If set to `true`, the treelist will render only the columns in the current viewport.
+     * When set to `true`, the TreeList renders only the columns in the current viewport.
+     *
      * @default false
      */
     virtualColumns: boolean;
@@ -187,38 +215,42 @@ export declare class TreeListComponent implements AfterContentInit, AfterViewIni
     set showPagerItemsText(value: boolean);
     get marqueeSelection(): boolean;
     /**
-     * Enables the [filtering]({% slug filtering_treelist %}) of the TreeList columns that have their `field` option set.
+     * Enables the [filtering]({% slug filtering_treelist %}) of TreeList columns that have their `field` option set.
+     *
+     * @default false
      */
     filterable: FilterableSettings;
     /**
-     * Enables the [sorting]({% slug sorting_treelist %}) of the TreeList columns that have their `field` option set.
+     * Enables the [sorting]({% slug sorting_treelist %}) of TreeList columns that have their `field` option set.
+     *
+     * @default false
      */
     sortable: SortSettings;
     /**
-     * Configures the pager of the TreeList ([see example]({% slug paging_treelist %})).
+     * Configures the pager for the TreeList ([see example]({% slug paging_treelist %})).
      *
+     * @default false
      */
     pageable: PagerSettings | boolean;
     get normalizedPageableSettings(): any;
     /**
-     * When the keyboard navigation is enabled, the user can use dedicated shortcuts to interact with the Grid.
-     * By default, navigation is enabled. To disable it altogether, and include the TreeList content in the normal tab sequence, set the property to `false`.
+     * When keyboard navigation is enabled, you can use dedicated shortcuts to interact with the TreeList.
+     * By default, navigation is enabled. To disable it and include the TreeList content in the normal tab sequence, set this property to `false`.
+     *
      * @default true
      */
     navigable: boolean;
     /**
-     * Indicates whether the TreeList columns will be resized during initialization so that
-     * they fit their headers and row content. Defaults to `false`.
+     * Determines whether TreeList columns resize during initialization to fit their headers and row content.
      * Columns with `autoSize` set to `false` are excluded.
-     * To dynamically update the column width to match the new content,
+     * To dynamically update the column width to match new content,
      * refer to [this example]({% slug resizing_columns_treelist %}).
      *
      * @default false
      */
     autoSize: boolean;
     /**
-     * Defines a function that is executed for every data row in the component.
-     *
+     * A function executed for every data row in the component. It should return a string that will be used as a CSS class for the row.
      */
     set rowClass(fn: RowClassFn);
     get rowClass(): RowClassFn;
@@ -227,37 +259,37 @@ export declare class TreeListComponent implements AfterContentInit, AfterViewIni
      */
     get activeCell(): NavigationCell;
     /**
-     * Returns the currently focused row (if any).
+     * Gets the currently focused row (if any).
      */
     get activeRow(): NavigationRow;
     /**
-     * If set to `true`, the user can resize columns by dragging the edges (resize handles) of their header cells
+     * When set to `true`, you can resize columns by dragging the edges (resize handles) of their header cells
      * ([see example]({% slug resizing_columns_treelist %})).
      *
      * @default false
      */
     resizable: boolean;
     /**
-     * If set to `true`, the user can reorder columns by dragging their header cells
+     * When set to `true`, you can reorder columns by dragging their header cells
      * ([see example]({% slug reordering_columns_treelist %})).
      *
      * @default false
      */
     reorderable: boolean;
     /**
-     * Specifies if the loading indicator of the TreeList will be displayed ([see example]({% slug databinding_treelist %})).
+     * Determines whether the TreeList displays the loading indicator ([see example]({% slug databinding_treelist %})).
      *
      * @default false
      */
     loading: boolean;
     /**
-     * Specifies if the column menu of the columns will be displayed ([see example]({% slug columnmenu_treelist %})).
+     * Determines whether the column menu of the columns displays ([see example]({% slug columnmenu_treelist %})).
      *
      * @default false
      */
     columnMenu: boolean | ColumnMenuSettings;
     /**
-     * Specifies if the header of the treelist will be hidden. The header is visible by default.
+     * Determines whether the TreeList hides the header. The header is visible by default.
      *
      * The header includes column headers and the [filter row](slug:filter_row_treelist).
      *
@@ -265,122 +297,123 @@ export declare class TreeListComponent implements AfterContentInit, AfterViewIni
      */
     hideHeader: boolean;
     /**
-     * The name of the field which contains the unique identifier of the node.
+     * Sets the name of the field that contains the unique identifier of the node.
      *
      * @default "id"
      */
     set idField(value: string);
     /**
-     * Specified the treelist selection settings
+     * Sets the TreeList selection settings.
      */
     set selectable(value: boolean | SelectableSettings);
     /**
-     * Provides a callback that determines if the given row or cell is selected.
+     * Sets a callback that determines if the given row or cell is selected.
      */
     set isSelected(value: IsSelectedFn);
     /**
      * Enables the [row reordering]({% slug treelist_row_reordering %}) of the TreeList.
+     *
      * @default false
      */
     set rowReorderable(value: boolean);
     get rowReorderable(): boolean;
     /**
-     * Fires when the TreeList selection is changed.
+     * Fires when the TreeList selection changes.
      */
     selectionChange: EventEmitter<SelectionChangeEvent>;
     /**
-     * Fires when the TreeList filter is modified through the UI.
-     * You have to handle the event yourself and filter the data.
+     * Fires when you modify the TreeList filter through the UI.
+     * You have to handle the event and filter the data.
      */
     filterChange: EventEmitter<CompositeFilterDescriptor>;
     /**
-     * Fires when the page of the TreeList is changed ([see example]({% slug paging_treelist %})).
-     * You have to handle the event yourself and page the data.
+     * Fires when the page of the TreeList changes ([see example]({% slug paging_treelist %})).
+     * You have to handle the event and page the data.
      */
     pageChange: EventEmitter<PageChangeEvent>;
     /**
-     * Fires when the sorting of the TreeList is changed ([see example]({% slug sorting_treelist %})).
-     * You have to handle the event yourself and sort the data.
+     * Fires when the sorting of the TreeList changes ([see example]({% slug sorting_treelist %})).
+     * You have to handle the event and sort the data.
      */
     sortChange: EventEmitter<Array<SortDescriptor>>;
     /**
-     * Fires when the data state of the TreeList is changed.
+     * Fires when the data state of the TreeList changes.
      */
     dataStateChange: EventEmitter<DataStateChangeEvent>;
     /**
-     * Fires when the user clicks the **Edit** command button to edit a row
+     * Fires when you click the **Edit** command button to edit a row
      * ([see example]({% slug editing_template_forms_treelist %}#toc-editing-records)).
      */
     edit: EventEmitter<EditEvent>;
     /**
-     * Fires when the user clicks the **Cancel** command button to close a row
+     * Fires when you click the **Cancel** command button to close a row
      * ([see example]({% slug editing_template_forms_treelist %}#toc-cancelling-editing)).
      */
     cancel: EventEmitter<CancelEvent>;
     /**
-     * Fires when the user clicks the **Save** command button to save changes in a row
+     * Fires when you click the **Save** command button to save changes in a row
      * ([see example]({% slug editing_template_forms_treelist %}#toc-saving-records)).
      */
     save: EventEmitter<SaveEvent>;
     /**
-     * Fires when the user clicks the **Remove** command button to remove a row
+     * Fires when you click the **Remove** command button to remove a row
      * ([see example]({% slug editing_template_forms_treelist %}#toc-removing-records)).
      */
     remove: EventEmitter<RemoveEvent>;
     /**
-     * Fires when the user clicks the **Add** command button to add a new row
+     * Fires when you click the **Add** command button to add a new row
      * ([see example]({% slug editing_template_forms_treelist %}#toc-adding-records)).
      */
     add: EventEmitter<AddEvent>;
     /**
-     * Fires when the user leaves an edited cell ([see example]({% slug editing_incell_treelist %}#toc-basic-concepts)).
+     * Fires when you leave an edited cell ([see example]({% slug editing_incell_treelist %}#toc-basic-concepts)).
      */
     cellClose: EventEmitter<CellCloseEvent>;
     /**
-     * Fires when the user clicks a cell ([see example]({% slug editing_incell_treelist %}#toc-basic-concepts)).
+     * Fires when you click a cell ([see example]({% slug editing_incell_treelist %}#toc-basic-concepts)).
      */
     cellClick: EventEmitter<CellClickEvent>;
     /**
-     * Fires when the user clicks the **Export to PDF** command button.
+     * Fires when you click the **Export to PDF** command button.
      */
     pdfExport: EventEmitter<PDFExportEvent>;
     /**
-     * Fires when the user clicks the **Export to Excel** command button.
+     * Fires when you click the **Export to Excel** command button.
      */
     excelExport: EventEmitter<ExcelExportEvent>;
     /**
-     * Fires when the user completes the resizing of the column.
+     * Fires when you complete the resizing of the column.
      */
     columnResize: EventEmitter<Array<ColumnResizeArgs>>;
     /**
-     * Fires when the user completes the reordering of the column.
+     * Fires when you complete the reordering of the column.
      */
     columnReorder: EventEmitter<ColumnReorderEvent>;
     /**
-     * Fires when the user changes the visibility of the columns from the column menu or column chooser.
+     * Fires when you change the visibility of the columns from the column menu or column chooser.
      */
     columnVisibilityChange: EventEmitter<ColumnVisibilityChangeEvent>;
     /**
-     * Fires when the user changes the locked state of the columns from the column menu or by reordering the columns.
+     * Fires when you change the locked state of the columns from the column menu or by reordering the columns.
      */
     columnLockedChange: EventEmitter<ColumnLockedChangeEvent>;
     /**
-     * Fires when the user scrolls to the last record on the page and enables endless scrolling
+     * Fires when you scroll to the last record on the page and enables endless scrolling
      * ([see example]({% slug scrollmmodes_treelist %}#toc-endless-scrolling)).
-     * You have to handle the event yourself and page the data.
+     * You have to handle the event and page the data.
      */
     scrollBottom: EventEmitter<ScrollBottomEvent>;
     /**
-     * Fires when the treelist content is scrolled.
-     * For performance reasons, the event is triggered outside the Angular zone. Enter the Angular zone if you make any changes that require change detection.
+     * Fires when the TreeList content scrolls.
+     * For performance reasons, the event triggers outside the Angular zone. Enter the Angular zone if you make any changes that require change detection.
      */
     contentScroll: EventEmitter<ContentScrollEvent>;
     /**
-     * Fires when an item is expanded.
+     * Fires when an item expands.
      */
     expandEvent: EventEmitter<ExpandEvent>;
     /**
-     * Fires when an item is collapsed.
+     * Fires when an item collapses.
      */
     collapseEvent: EventEmitter<ExpandEvent>;
     /**
@@ -391,7 +424,7 @@ export declare class TreeListComponent implements AfterContentInit, AfterViewIni
      */
     expandStateChange: EventEmitter<ExpandEvent>;
     /**
-     * Fires when the user drops the dragged row and reordering is performed.
+     * Fires when you drop the dragged row and reordering occurs.
      * Emits the [RowReorderEvent]({% slug api_treelist_rowreorderevent %}).
      */
     rowReorder: EventEmitter<RowReorderEvent>;
@@ -456,17 +489,17 @@ export declare class TreeListComponent implements AfterContentInit, AfterViewIni
     get columnMenuTemplate(): TemplateRef<any>;
     get totalCount(): number;
     /**
-     * Gets or sets the callback function that retrieves the child nodes for a particular node.
+     * Sets or gets the callback function that retrieves the child nodes for a particular node.
      */
     set fetchChildren(value: (node: any) => Observable<any[]> | any[]);
     get fetchChildren(): (node: any) => Observable<any[]> | any[];
     /**
-     * Gets or sets the callback function that indicates if a particular node has child nodes.
+     * Sets or gets the callback function that determines if a particular node has child nodes.
      */
     set hasChildren(value: (node: any) => boolean);
     get hasChildren(): (node: any) => boolean;
     /**
-     * Sets the callback function that indicates if a particular item is expanded.
+     * Sets the callback function that determines if a particular item is expanded.
      */
     set isExpanded(value: (node: any) => boolean);
     idGetter: any;
@@ -543,12 +576,14 @@ export declare class TreeListComponent implements AfterContentInit, AfterViewIni
      */
     attachScrollSync(): void;
     /**
-     * Switches the specified table row in the edit mode ([see example]({% slug editing_template_forms_treelist %}#toc-editing-records)).
+     * Switches the specified table row to edit mode ([see example]({% slug editing_template_forms_treelist %}#toc-editing-records)).
      *
-     * @param dataItem - The data item that will be edited.
+     * @param dataItem The data item that you will edit.
      * @param group - The [`FormGroup`](link:site.data.urls.angular['formgroupapi'])
      * that describes the edit form.
-     * @param options - Additional options. Use `skipFocus` to determine if the row's edit element should be focused. Defaults to `false`.
+     * @param options Additional options. Use `skipFocus` to determine if the edit element of the row should receive focus.
+     *
+     * @default false
      */
     editRow(dataItem: any, group?: any, options?: {
         [skipFocus: string]: boolean;
@@ -556,23 +591,23 @@ export declare class TreeListComponent implements AfterContentInit, AfterViewIni
     /**
      * Closes the editor for a given row ([see example]({% slug editing_template_forms_treelist %}#toc-cancelling-editing)).
      *
-     * @param {any} dataItem - The dataItem that will be switched out of the edit mode.
-     * @param {boolean} isNew - Indicates whether the dataItem is new.
+     * @param dataItem The data item that you will switch out of edit mode.
+     * @param isNew Determines whether the data item is new.
      */
     closeRow(dataItem: any, isNew: boolean): void;
     /**
      * Creates a new row editor ([see example]({% slug editing_template_forms_treelist %}#toc-adding-records)).
      *
-     * @param {FormGroup} group - The [`FormGroup`](link:site.data.urls.angular['formgroupapi']) that describes
-     * the edit form. If called with a data item, it will build the `FormGroup` from the data item fields.
+     * @param group The [`FormGroup`](link:site.data.urls.angular['formgroupapi']) that describes
+     * the edit form. If called with a data item, it builds the `FormGroup` from the data item fields.
      */
     addRow(group: any, parent?: any): void;
     /**
-     * Puts the cell that is specified by the table row and column in edit mode.
+     * Puts the cell that you specify by the table row and column in edit mode.
      *
-     * @param {any} dataItem - The data item that will be edited.
-     * @param {number|string|any} column - The leaf column index, or the field name or the column instance that should be edited.
-     * @param {FormGroup} group - The [`FormGroup`](link:site.data.urls.angular['formgroupapi'])
+     * @param dataItem The data item that you will edit.
+     * @param column The leaf column index, or the field name or the column instance that should be edited.
+     * @param group The [`FormGroup`](link:site.data.urls.angular['formgroupapi'])
      * that describes the edit form.
      */
     editCell(dataItem: any, column: number | string | any, group?: any): void;
@@ -580,9 +615,8 @@ export declare class TreeListComponent implements AfterContentInit, AfterViewIni
      * Closes the current cell in edit mode and fires
      * the [`cellClose`]({% slug api_treelist_treelistcomponent %}#toc-cellclose) event.
      *
-     * @return {boolean} Indicates whether the edited cell was closed.
-     * A `false` value indicates that the
-     * [`cellClose`]({% slug api_treelist_treelistcomponent %}#toc-cellclose) event was prevented.
+     * @return  {boolean} A Boolean value that indicates whether the edited cell closed.
+     * A `false` value indicates that the [`cellClose`]({% slug api_treelist_treelistcomponent %}#toc-cellclose) event was prevented.
      */
     closeCell(): boolean;
     /**
@@ -590,44 +624,43 @@ export declare class TreeListComponent implements AfterContentInit, AfterViewIni
      */
     cancelCell(): void;
     /**
-     * Returns a flag which indicates if a row or a cell is currently edited.
+     * Gets a flag that indicates if a row or a cell is currently edited.
      *
-     * @return {boolean} A flag which indicates if a row or a cell is currently edited.
+     * @return {boolean} A Boolean flag that indicates if a row or a cell is currently edited.
      */
     isEditing(): boolean;
     /**
-     * Returns a flag which indicates if a cell is currently edited.
+     * Gets a flag that indicates if a cell is currently edited.
      *
-     * @return {boolean} A flag which indicates if a cell is currently being edited.
+     * @return {boolean} A Boolean flag that indicates if a cell is currently being edited.
      */
     isEditingCell(): boolean;
     /**
-     * Initiates the PDF export ([see example]({% slug pdfexport_treelist %})).
+     * Starts the PDF export ([see example]({% slug pdfexport_treelist %})).
      */
     saveAsPDF(): void;
     /**
      * Exports the TreeList element to a Drawing [`Group`]({% slug api_kendo-drawing_group %}) by using the `kendo-treelist-pdf` component options.
      * ([see example]({% slug pdfexport_treelist %}#toc-exporting-multiple-treelists-to-the-same-pdf)).
      *
-     * @return {Promise} A promise that will be resolved with the Drawing `Group`.
+     * @return {Promise} A promise that resolves with the Drawing `Group`.
      */
     drawPDF(): Promise<any>;
     /**
-     * Initiates the Excel export ([see example]({% slug excelexport_treelist %})).
+     * Starts the Excel export ([see example]({% slug excelexport_treelist %})).
      */
     saveAsExcel(): void;
     /**
      * Applies the minimum possible width for the specified column,
      * so that the whole text fits without wrapping. This method expects the TreeList
      * to be resizable (set `resizable` to `true`).
-     * Makes sense to execute this method only
+     * Execute this method only
      * after the TreeList is already populated with data. [See example](slug:resizing_columns_treelist#toc-auto-fitting-the-content).
-     *
      */
     autoFitColumn(column: ColumnBase): void;
     /**
      * Adjusts the width of the specified columns to fit the entire content, including headers, without wrapping.
-     * If no columns are specified, `autoFitColumns` is applied to all columns.
+     * If you do not specify columns, `autoFitColumns` applies to all columns.
      *
      * This method requires the TreeList to be resizable (set `resizable` to `true`).
      * [See example](slug:resizing_columns_treelist#toc-auto-fitting-the-content).
@@ -666,8 +699,8 @@ export declare class TreeListComponent implements AfterContentInit, AfterViewIni
      * The row indexing is absolute and does not change with paging.
      * Header rows are included, starting at index 0.
      *
-     * If the TreeList is configured for scrolling, including virtual scrolling, the scroll position will be updated.
-     * If the row is not present on the current page, the method will have no effect.
+     * If the TreeList is configured for scrolling, including virtual scrolling, the scroll position updates.
+     * If the row is not present on the current page, the method has no effect.
      *
      * @param rowIndex - The logical row index to focus. The top header row has an index 0.
      * @param colIndex - The column index to focus.
@@ -678,36 +711,39 @@ export declare class TreeListComponent implements AfterContentInit, AfterViewIni
     /**
      * Focuses the next cell, optionally wrapping to the next row.
      *
-     * @param wrap - A Boolean value which indicates if the focus will move to the next row. Defaults to `true`.
-     * @returns {NavigationCell} The focused cell. If the focus is already on the last cell, returns `null`.
+     * @param wrap A Boolean value that indicates if the focus moves to the next row.
+     * @return {NavigationCell} The focused cell. If the focus is already on the last cell, returns `null`.
+     *
+     * @default true
      */
     focusNextCell(wrap?: boolean): NavigationCell;
     /**
      * Focuses the previous cell. Optionally wraps to the previous row.
      *
-     * @param wrap - A Boolean value which indicates if the focus will move to the next row. Defaults to `true`.
-     * @returns {NavigationCell} The focused cell. If the focus is already on the first cell, returns `null`.
+     * @param wrap A Boolean value that indicates if the focus moves to the next row.
+     * @return {NavigationCell} The focused cell. If the focus is already on the first cell, returns `null`.
+     *
+     * @default true
      */
     focusPrevCell(wrap?: boolean): NavigationCell;
     /**
-     * Scrolls to the specified row and column
+     * Scrolls to the specified row and column.
      */
     scrollTo(request: ScrollRequest): void;
     /**
      * Changes the position of the specified column.
      * The reordering of columns operates only on the level
-     * which is inferred by the source column.
+     * that the source column infers.
      * For the `reorderColumn` method to work properly,
      * the `source` column has to be visible.
      *
-     * @param {ColumnBase} source - The column whose position will be changed.
-     * @param {number} destIndex - The new position of the column.
-     * @param {ColumnReorderConfig} options - Additional options.
-     *
+     * @param source The column whose position you will change.
+     * @param destIndex The new position of the column.
+     * @param options Additional options.
      */
     reorderColumn(source: ColumnBase, destIndex: number, options?: ColumnReorderConfig): void;
     /**
-     * Clears the already loaded children for the dataItem so that the TreeList will fetch them again the next time it is rendered.
+     * Clears the already loaded children for the data item so that the TreeList fetches them again the next time it renders.
      */
     reload(dataItem: any, reloadChildren?: boolean): void;
     /**
@@ -719,11 +755,11 @@ export declare class TreeListComponent implements AfterContentInit, AfterViewIni
      */
     updateView(): void;
     /**
-     * Expands the row for the specified dataItem.
+     * Expands the row for the specified data item.
      */
     expand(dataItem: any): void;
     /**
-     * Collapses the row for the specified dataItem.
+     * Collapses the row for the specified data item.
      */
     collapse(dataItem: any): void;
     /**

package/treelist.module.d.ts

@@ -110,22 +110,20 @@ import * as i104 from "@progress/kendo-angular-toolbar";
 import * as i105 from "@progress/kendo-angular-pager";
 import * as i106 from "./column-resizing/table.directive";
 /**
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
- * definition for the TreeList component.
+ * Represents the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) definition for the TreeList component.
+ * Use this module to enable TreeList features in your application.
  *
  * @example
- *
  * ```ts
  * import { NgModule } from '@angular/core';
  * import { BrowserModule } from "@angular/platform-browser";
  * import { TreeListModule } from '@progress/kendo-angular-treelist';
- *
  * import { AppComponent } from './app.component';
  *
- * _@NgModule({
- *     declarations: [AppComponent],
- *     imports:      [BrowserModule, TreeListModule],
- *     bootstrap:    [AppComponent]
+ * @NgModule({
+ *   declarations: [AppComponent],
+ *   imports: [BrowserModule, TreeListModule],
+ *   bootstrap: [AppComponent]
  * })
  * export class AppModule {}
  * ```