@progress/kendo-angular-treelist 13.0.0-develop.7 → 13.0.0-develop.9

package/esm2020/pdf/pdf-margin.component.mjs

@@ -5,6 +5,15 @@
 import { Component } from '@angular/core';
 import { PDFExportMarginComponent } from '@progress/kendo-angular-pdf-export';
 import * as i0 from "@angular/core";
+/**
+ * Represents the Kendo UI PDFMargin component for Angular.
+ * The supported units are:
+ * `"mm"`
+ * `"cm"`
+ * `"in"`
+ * `"pt"` (default).
+ * Numbers are considered to be points (`"pt"`).
+ */
 export class PDFMarginComponent extends PDFExportMarginComponent {
 }
 PDFMarginComponent.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "13.3.12", ngImport: i0, type: PDFMarginComponent, deps: null, target: i0.ɵɵFactoryTarget.Component });

package/esm2020/rendering/cell-template.directive.mjs

@@ -20,7 +20,7 @@ import * as i0 from "@angular/core";
  * - `loading`—Specifies if the item children are currently loading.
  * - `rowIndex`—The current row index. Use it as an alias for a template variable by utilizing the `let-rowIndex="rowIndex"` syntax.
  *
- * * @example
+ * @example
  * ```html
  * <kendo-treelist ...>
  *   <kendo-treelist-column field="ProductName">

package/esm2020/rendering/common/spacer.component.mjs

@@ -9,7 +9,7 @@ import * as i0 from "@angular/core";
  * Represents the Kendo UI TreeListSpacer component for Angular.
  * Used to give additional white space between the Pager inner elements,
  * and provides a way for customizing the spacer width.
- * It can also be used in any flex container within the TreeList.
+ * It can also be used in any flex container within the TreeList. [See example](slug:toolbartemplate_treelist#toc-define-spacing-between-the-toolbar-elements).
  */
 export class TreeListSpacerComponent {
     constructor() {

package/esm2020/treelist.component.mjs

@@ -122,12 +122,11 @@ const isInEditedCell = (element, treelistElement) => closest(element, matchesCla
 /**
  * Represents the Kendo UI TreeList component for Angular.
  *
- * {% meta height:470 %}
- * {% embed_file data-binding/flat/app.component.ts preview %}
- * {% embed_file data-binding/flat/app.module.ts %}
- * {% embed_file shared/main.ts %}
- * {% embed_file shared/employees.ts %}
- * {% endmeta %}
+ * @example
+ * ```html
+ * <kendo-treelist [kendoTreeListFlatBinding]="data" ...></kendo-treelist>
+ * ```
+ *
  */
 export class TreeListComponent {
     constructor(supportService, wrapper, changeNotification, editService, filterService, pdfService, responsiveService, renderer, excelService, ngZone, scrollSyncService, domEvents, columnResizingService, changeDetectorRef, columnReorderService, columnInfoService, navigationService, sortService, scrollRequestService, expandStateService, optionChanges, selectionService, localization, ctx, rowReorderService) {
@@ -164,10 +163,7 @@ export class TreeListComponent {
         this.pageSize = 10;
         /**
          * Defines the scroll mode used by the TreeList.
-         *
-         * The available options are:
-         *  - `none`&mdash;Renders no scrollbar.
-         *  - `scrollable`&mdash;The default scroll mode. It requires the setting of the `height` option.
+         * @default 'scrollable'
          */
         this.scrollable = 'scrollable';
         /**
@@ -175,49 +171,12 @@ export class TreeListComponent {
          *
          * By default, the TreeList tracks changes by the index of the data item.
          * Edited rows are tracked by reference.
-         * In some cases, you might need to override the default behavior,
-         * for example, when you implement editing with immutable data items.
-         *
-         * The following example demonstrates how to track items only by index.
-         *
-         * @example
-         * ```ts
-         * import { Component } from '@angular/core';
-         * import { TreeListItem } from '@progress/kendo-angular-treelist';
          *
-         * _@Component({
-         *    selector: 'my-app',
-         *    template: `
-         *        <kendo-treelist [data]="treelistData" [trackBy]="trackBy">
-         *        </kendo-treelist>
-         *    `
-         * })
-         * class AppComponent {
-         *    public treelistData: any[] = products;
-         *
-         *    public trackBy(index: number, item: TreeListItem): any {
-         *        console.log(item);
-         *        return index;
-         *    }
-         * }
-         *
-         * const products = [{
-         *    "ProductID": 1,
-         *    "ProductName": "Chai",
-         *    "UnitPrice": 18.0000,
-         *    "Discontinued": true
-         *  }, {
-         *    "ProductID": 2,
-         *    "ProductName": "Chang",
-         *    "UnitPrice": 19.0000,
-         *    "Discontinued": false
-         *  }
-         * ];
-         * ```
          */
         this.trackBy = defaultTrackBy;
         /**
          * If set to `true`, the treelist will render only the columns in the current viewport.
+         * @default false
          */
         this.virtualColumns = false;
         /**
@@ -231,18 +190,12 @@ export class TreeListComponent {
         /**
          * Configures the pager of the TreeList ([see example]({% slug paging_treelist %})).
          *
-         * The available options are:
-         * - `buttonCount: Number`&mdash;Sets the maximum numeric buttons count before the buttons are collapsed. Defaults to `10`.
-         * - `info: Boolean`&mdash;Toggles the information about the current page and the total number of records. Defaults to `true`.
-         * - `type: PagerType`&mdash;Accepts the `numeric` (buttons with numbers) and `input` (input for typing the page number) values. Defaults to `'numeric'`.
-         * - `pageSizes: Boolean` or `Array<number>`&mdash;Shows a menu for selecting the page size. Defaults to `false`.
-         * - `previousNext: Boolean`&mdash;Toggles the **Previous** and **Next** buttons. Defaults to `true`.
-         * - `responsive: Boolean`&mdash;Toggles the built-in responsive behavior of the Pager. Defaults to `true`.
          */
         this.pageable = false;
         /**
          * If set to `true`, the user can use dedicated shortcuts to interact with the TreeList.
          * By default, navigation is disabled and the TreeList content is accessible in the normal tab sequence.
+         * @default false
          */
         this.navigable = false;
         /**
@@ -251,6 +204,8 @@ export class TreeListComponent {
          * Columns with `autoSize` set to `false` are excluded.
          * To dynamically update the column width to match the new content,
          * refer to [this example]({% slug resizing_columns_treelist %}).
+         *
+         * @default false
          */
         this.autoSize = false;
         /**
@@ -282,7 +237,9 @@ export class TreeListComponent {
         /**
          * Specifies if the header of the treelist will be hidden. The header is visible by default.
          *
-         * > The header includes column headers and the [filter row]({% slug filtering_treelist %}#toc-filter-row).
+         * The header includes column headers and the [filter row]({% slug filtering_treelist %}#toc-filter-row).
+         *
+         * @default false
          */
         this.hideHeader = false;
         /**
@@ -602,48 +559,6 @@ export class TreeListComponent {
     /**
      * Defines a function that is executed for every data row in the component.
      *
-     * @example
-     * ```ts
-     * import { Component, ViewEncapsulation } from '@angular/core';
-     * import { RowClassArgs } from '@progress/kendo-angular-treelist';
-     *
-     * _@Component({
-     *    selector: 'my-app',
-     *    encapsulation: ViewEncapsulation.None,
-     *    styles: [`
-     *        .k-treelist tr.even { background-color: #f45c42; }
-     *        .k-treelist tr.odd { background-color: #41f4df; }
-     *    `],
-     *    template: `
-     *        <kendo-treelist [data]="treelistData" [rowClass]="rowCallback">
-     *        </kendo-treelist>
-     *    `
-     * })
-     * class AppComponent {
-     *    public treelistData: any[] = products;
-     *
-     *    public rowCallback(context: RowClassArgs) {
-     *        const isEven = context.index % 2 === 0;
-     *        return {
-     *            even: isEven,
-     *            odd: !isEven
-     *        };
-     *    }
-     * }
-     *
-     * const products = [{
-     *    "ProductID": 1,
-     *    "ProductName": "Chai",
-     *    "UnitPrice": 18.0000,
-     *    "Discontinued": true
-     *  }, {
-     *    "ProductID": 2,
-     *    "ProductName": "Chang",
-     *    "UnitPrice": 19.0000,
-     *    "Discontinued": false
-     *  }
-     * ];
-     * ```
      */
     set rowClass(fn) {
         if (typeof fn !== 'function') {
@@ -687,7 +602,7 @@ export class TreeListComponent {
         this.selectionService.settings = value;
     }
     /**
-     * Provides a callback that determines if the given row / cell is selected.
+     * Provides a callback that determines if the given row or cell is selected.
      */
     set isSelected(value) {
         if (typeof value !== 'function' && isDevMode()) {
@@ -1141,7 +1056,7 @@ export class TreeListComponent {
      * 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 will be resolved with the Drawing `Group`.
      */
     drawPDF() {
         const promise = createPromise();
@@ -1159,64 +1074,8 @@ export class TreeListComponent {
      * 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
-     * after the TreeList is already populated with data.
-     *
-     * @example
-     * ```ts
-     * _@Component({
-     *    selector: 'my-app',
-     *    template: `
-     *        <kendo-treelist
-     *            #treelist
-     *            [data]="treelistData"
-     *            [resizable]="true"
-     *            style="height: 300px">
-     *            <ng-template kendoTreeListToolbarTemplate>
-     *                 <button kendoButton (click)="treelist.autoFitColumn(groupColumn)">
-     *                     Auto-fit the group column
-     *                 </button>
-     *            </ng-template>
-     *            <kendo-treelist-column-group #groupColumn title="Product Info">
-     *                <kendo-treelist-column
-     *                    field="ProductID"
-     *                    [width]="50"
-     *                    [minResizableWidth]="30"
-     *                    title="ID">
-     *                </kendo-treelist-column>
-     *
-     *                <kendo-treelist-column
-     *                    field="ProductName"
-     *                    title="Product Name">
-     *                </kendo-treelist-column>
-     *            </kendo-treelist-column-group>
+     * after the TreeList is already populated with data. [See example](slug:resizing_columns_treelist#toc-auto-fitting-the-content).
      *
-     *            <kendo-treelist-column
-     *                field="UnitPrice"
-     *                title="Unit Price"
-     *                [width]="180"
-     *                filter="numeric"
-     *                format="{0:c}">
-     *            </kendo-treelist-column>
-     *        </kendo-treelist>
-     *    `
-     * })
-     * class AppComponent {
-     *    public treelistData: any[] = products;
-     * }
-     *
-     * const products = [{
-     *    "ProductID": 1,
-     *    "ProductName": "Chai",
-     *    "UnitPrice": 18.0000,
-     *    "Discontinued": true
-     *  }, {
-     *    "ProductID": 2,
-     *    "ProductName": "Chang",
-     *    "UnitPrice": 19.0000,
-     *    "Discontinued": false
-     *  }
-     * ];
-     * ```
      */
     autoFitColumn(column) {
         this.columnResizingService.autoFit(column);
@@ -1226,69 +1085,7 @@ export class TreeListComponent {
      * If no columns are specified, `autoFitColumns` is applied to all columns.
      *
      * This method requires the TreeList to be resizable (set `resizable` to `true`).
-     *
-     * @example
-     * ```ts
-     * _@Component({
-     *    selector: 'my-app',
-     *    template: `
-     *      <kendo-treelist
-     *          #treelist
-     *          [data]="treelistData"
-     *          [resizable]="true"
-     *          style="height: 300px">
-     *          <ng-template kendoTreeListToolbarTemplate>
-     *              <button kendoButton (click)="treelist.autoFitColumns([firstColumn, lastColumn])">
-     *                  Auto-fit the first and last column
-     *              </button>
-     *              <button kendoButton (click)="treelist.autoFitColumns()">
-     *                  Auto-fit all columns
-     *              </button>
-     *          </ng-template>
-     *          <kendo-treelist-column-group title="Product Info">
-     *              <kendo-treelist-column
-     *                  #firstColumn
-     *                  field="ProductID"
-     *                  [width]="50"
-     *                  [minResizableWidth]="30"
-     *                  title="ID">
-     *              </kendo-treelist-column>
-     *
-     *              <kendo-treelist-column
-     *                  field="ProductName"
-     *                  title="Product Name"
-     *                  >
-     *              </kendo-treelist-column>
-     *          </kendo-treelist-column-group>
-     *
-     *          <kendo-treelist-column
-     *              #lastColumn
-     *              field="UnitPrice"
-     *              title="Unit Price"
-     *              [width]="180"
-     *              filter="numeric"
-     *              format="{0:c}">
-     *          </kendo-treelist-column>
-     *      </kendo-treelist>
-     *    `
-     * })
-     * class AppComponent {
-     *    public treelistData: any[] = products;
-     * }
-     *
-     * const products = [{
-     *    "ProductID": 1,
-     *    "ProductName": "Chai",
-     *    "UnitPrice": 18.0000,
-     *    "Discontinued": true
-     *  }, {
-     *    "ProductID": 2,
-     *    "ProductName": "Chang",
-     *    "UnitPrice": 19.0000,
-     *    "Discontinued": false
-     *  }
-     * ];
-     * ```
+     * [See example](slug:resizing_columns_treelist#toc-auto-fitting-the-content).
      */
     autoFitColumns(columns = this.columns) {
         let cols;
@@ -1361,9 +1158,9 @@ export class TreeListComponent {
     /**
      * Focuses the cell with the specified row and column index.
      *
-     * The row index is based on the logical structure of the TreeList and does not correspond to the data item index:
-     * * Header rows are included, starting at index 0.
-     * * The row indexing is absolute and does not change with paging.
+     * The row index is based on the logical structure of the TreeList and does not correspond to the data item index.
+     * 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.
@@ -1414,67 +1211,6 @@ export class TreeListComponent {
      * @param {number} destIndex - The new position of the column.
      * @param {ColumnReorderConfig} options - Additional options.
      *
-     * @example
-     * ```ts
-     * _@Component({
-     *    selector: 'my-app',
-     *    template: `
-     *        <kendo-treelist
-     *            #treelist
-     *            [data]="treelistData"
-     *            [reorderable]="true"
-     *            style="height: 300px">
-     *            <ng-template kendoTreeListToolbarTemplate>
-     *                 <button kendoButton
-     *                     (click)="treelist.reorderColumn(groupColumn, 2, { before: true })">
-     *                     Move the group column before the last one.
-     *                 </button>
-     *            </ng-template>
-     *            <kendo-treelist-column-group #groupColumn title="Product Info">
-     *                <kendo-treelist-column
-     *                    field="ProductID"
-     *                    [width]="50"
-     *                    title="ID">
-     *                </kendo-treelist-column>
-     *
-     *                <kendo-treelist-column
-     *                    field="ProductName"
-     *                    title="Product Name">
-     *                </kendo-treelist-column>
-     *            </kendo-treelist-column-group>
-     *
-     *            <kendo-treelist-column
-     *                field="UnitPrice"
-     *                title="Unit Price"
-     *                [width]="180"
-     *                format="{0:c}">
-     *            </kendo-treelist-column>
-     *
-     *            <kendo-treelist-column
-     *                field="Discontinued"
-     *                title="Discontinued"
-     *                [width]="100">
-     *            </kendo-treelist-column>
-     *        </kendo-treelist>
-     *    `
-     * })
-     * class AppComponent {
-     *    public treelistData: any[] = products;
-     * }
-     *
-     * const products = [{
-     *    "ProductID": 1,
-     *    "ProductName": "Chai",
-     *    "UnitPrice": 18.0000,
-     *    "Discontinued": true
-     *  }, {
-     *    "ProductID": 2,
-     *    "ProductName": "Chang",
-     *    "UnitPrice": 19.0000,
-     *    "Discontinued": false
-     *  }
-     * ];
-     * ```
      */
     reorderColumn(source, destIndex, options = { before: false }) {
         const columnsForLevel = sortColumns(this.allColumnsForLevel(source.level));
@@ -2289,14 +2025,14 @@ TreeListComponent.ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "12.0.0", vers
                     [virtualColumns]="virtualColumns"
                     [expandIcons]="expandIcons"
                     (scrollBottom)="notifyScrollBottom()"
-                    (contentScroll)="contentScroll.emit($event)"   
+                    (contentScroll)="contentScroll.emit($event)"
                     kendoDraggable
                     kendoTreeListSelectionMarquee
                     [enableDrag]="marqueeSelection">
                 </kendo-treelist-list>
             </ng-template>
             <ng-template [ngIf]="!isScrollable">
-                <table 
+                <table
                     class="k-table k-table-md k-grid-header-table"
                     [style.table-layout]="resizable ? 'fixed' : null">
                     <colgroup kendoTreeListColGroup
@@ -2699,14 +2435,14 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
                     [virtualColumns]="virtualColumns"
                     [expandIcons]="expandIcons"
                     (scrollBottom)="notifyScrollBottom()"
-                    (contentScroll)="contentScroll.emit($event)"   
+                    (contentScroll)="contentScroll.emit($event)"
                     kendoDraggable
                     kendoTreeListSelectionMarquee
                     [enableDrag]="marqueeSelection">
                 </kendo-treelist-list>
             </ng-template>
             <ng-template [ngIf]="!isScrollable">
-                <table 
+                <table
                     class="k-table k-table-md k-grid-header-table"
                     [style.table-layout]="resizable ? 'fixed' : null">
                     <colgroup kendoTreeListColGroup

package/excel/excel-command.directive.d.ts

@@ -17,7 +17,7 @@ import * as i0 from "@angular/core";
  *
  * @example
  * ```html
- * <kendo-treelist>
+ * <kendo-treelist ...>
  *   <ng-template kendoTreeListToolbarTemplate>
  *     <button kendoTreeListExcelCommand>Export to PDF</button>
  *   </ng-template>

package/excel/excel.component.d.ts

@@ -39,15 +39,17 @@ export declare class ExcelComponent implements OnDestroy {
     forceProxy: boolean;
     /**
      * The URL of the server-side proxy which streams the file to the end user.
-     * You need to use a proxy if the browser is not capable of saving files locally—for example,
-     * Internet Explorer 9 and Safari. The responsibility for implementing the server-side proxy is yours.
+     * Using a proxy is required if the browser is not capable of saving files locally.
      *
-     * In the request body, the proxy receives a POST request with the following parameters:
-     * - `contentType`—The MIME type of the file.
-     * - `base64`—The base-64 encoded file content.
-     * - `fileName`—The file name, as requested by the caller.
+     * Optionally, set up a proxy to reduce memory usage. This avoids copying the file contents into memory,
+     * but transmits it over the network instead. For this use case, set [forceProxy](#toc-forceproxy) to `true`
+     * to skip client-side saving even in browsers that support it.
      *
+     * In the request body, the proxy receives a POST request with the specific parameters. [See example](slug:server_proxy#toc-implementations).
      * The proxy returns the decoded file with the `"Content-Disposition"` header set to `attachment; filename="<fileName.xslx>"`.
+     *
+     * For details on the server-side proxy usage and implementation, see the [File Saver]({% slug overview_filesaver %}) documentation.
+     *
      */
     proxyURL: string;
     /**
@@ -56,8 +58,7 @@ export declare class ExcelComponent implements OnDestroy {
      */
     fetchData: (component: TreeListComponent) => ExcelExportData;
     /**
-     * Specifies if the item levels in the Excel file are collapsible.
-     * > Applicable only if the treelist has footers.
+     * Specifies if the item levels in the Excel file are collapsible. Applicable only if the treelist has footers.
      */
     collapsible: boolean;
     /**