@progress/kendo-angular-treelist 3.1.3-dev.202110041229

package/dist/es2015/excel/excel-export-event.js

@@ -0,0 +1,14 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { PreventableEvent } from '../common/preventable-event';
+/**
+ * Arguments for the `excelExport` event.
+ */
+export class ExcelExportEvent extends PreventableEvent {
+    constructor(workbook) {
+        super();
+        this.workbook = workbook;
+    }
+}

package/dist/es2015/excel/excel.component.d.ts

@@ -0,0 +1,105 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { OnDestroy, QueryList, NgZone } from '@angular/core';
+import { Observable } from 'rxjs';
+import { ColumnBase, CellOptions } from '@progress/kendo-angular-excel-export';
+import { TreeListComponent } from '../treelist.component';
+import { ExcelService } from './excel.service';
+import { LocalizationService } from '@progress/kendo-angular-l10n';
+/**
+ * The expected type of result for the treelist excel export fetchData function.
+ */
+export interface ExcelExportData {
+    /**
+     * The root data that should be exported.
+     */
+    data: any[] | Observable<any[]>;
+    /**
+     * A function that returns the children for an item.
+     */
+    fetchChildren: any;
+    /**
+     * A function that indicates if a particular item has children.
+     */
+    hasChildren: any;
+}
+/**
+ * Configures the settings for the export of TreeList in Excel ([see example]({% slug excelexport_treelist %})).
+ */
+export declare class ExcelComponent implements OnDestroy {
+    private excelService;
+    private localization;
+    private zone;
+    /**
+     * Specifies the file name of the exported Excel file.
+     * @default "Export.xlsx"
+     */
+    fileName: string;
+    /**
+     * Enables or disables column filtering in the Excel file. This behavior is different from the filtering feature of the TreeList.
+     */
+    filterable: boolean;
+    /**
+     * The author of the workbook.
+     */
+    creator?: string;
+    /**
+     * The date on which the workbook was created. Defaults to `new Date()`.
+     */
+    date?: Date;
+    /**
+     * If set to `true`, the content is forwarded to `proxyURL` even if the browser supports the saving of files locally.
+     */
+    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&mdash;for example,
+     * Internet Explorer 9 and Safari. The responsibility for implementing the server-side proxy is yours.
+     *
+     * In the request body, the proxy receives a POST request with the following parameters:
+     * - `contentType`&mdash;The MIME type of the file.
+     * - `base64`&mdash;The base-64 encoded file content.
+     * - `fileName`&mdash;The file name, as requested by the caller.
+     *
+     * The proxy returns the decoded file with the `"Content-Disposition"` header set to `attachment; filename="<fileName.xslx>"`.
+     */
+    proxyURL: string;
+    /**
+     * The function that is used to get the exported data options. By default, uses the current data of the TreeList.
+     * To export data that is different from the current TreeList data, provide a custom function.
+     */
+    fetchData: (component: TreeListComponent) => ExcelExportData;
+    /**
+     * Specifies if the item levels in the Excel file are collapsible.
+     * > Applicable only if the treelist has footers.
+     */
+    collapsible: boolean;
+    /**
+     * Specifies if export should include all pages
+     * @default true
+     */
+    allPages: boolean;
+    /**
+     * Specifies if the export should expand all items or should use the current TreeList state.
+     * @default true
+     */
+    expandAll: boolean;
+    /**
+     * The options of the cells that are inserted before the data to indicate the hierarchy.
+     */
+    paddingCellOptions: CellOptions;
+    /**
+     * @hidden
+     */
+    columns: QueryList<ColumnBase>;
+    private saveSubscription;
+    private dataSubscription;
+    constructor(excelService: ExcelService, localization: LocalizationService, zone: NgZone);
+    ngOnDestroy(): void;
+    protected save(component: TreeListComponent): void;
+    protected exportData(component: any, result?: ExcelExportData): void;
+    protected saveFile(options: any): void;
+    protected componentViewOptions(component: any): any;
+}

package/dist/es2015/excel/excel.component.js

@@ -0,0 +1,248 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import * as tslib_1 from "tslib";
+import { Component, Input, ContentChildren, QueryList, NgZone } from '@angular/core';
+import { isObservable } from 'rxjs';
+import { take } from 'rxjs/operators';
+import { saveAs } from '@progress/kendo-file-saver';
+import { toDataURL, workbookOptions, ColumnBase } from '@progress/kendo-angular-excel-export';
+import { ExcelService } from './excel.service';
+import { ExcelExportEvent } from './excel-export-event';
+import { LocalizationService } from '@progress/kendo-angular-l10n';
+import { orderBy } from '@progress/kendo-data-query';
+import { sortColumns } from '../columns/column-common';
+import { ViewCollection, EXPANDED_STATE } from '../data/data.collection';
+import { hasObservers } from '@progress/kendo-angular-common';
+const hierarchyData = (view) => {
+    const data = view.data;
+    const levels = {};
+    const aggregates = {};
+    const items = [];
+    let depth = 0;
+    for (let idx = 0, dataIndex = 0; idx < data.length; idx++) {
+        const item = data[idx];
+        if (item.type === 'data') {
+            items.push(item.data);
+            levels[dataIndex] = item.level;
+            depth = Math.max(depth, item.level);
+            dataIndex++;
+        }
+        else {
+            aggregates[item.parentIndex] = item.aggregates;
+        }
+    }
+    return {
+        itemId: (_item, idx) => idx,
+        itemLevel: (_item, idx) => levels[idx],
+        depth: depth + 1,
+        aggregates,
+        data: items
+    };
+};
+const ɵ0 = hierarchyData;
+const toExcelColumn = (column) => {
+    return {
+        title: column.title,
+        field: column.field,
+        locked: Boolean(column.locked),
+        width: column.width,
+        level: column.level,
+        hidden: !column.isVisible,
+        footerTemplate: column.footerTemplate
+    };
+};
+const ɵ1 = toExcelColumn;
+const toExcelColumns = (columns) => {
+    const result = [];
+    sortColumns(columns)
+        .forEach((column) => {
+        if (column.isSpanColumn) {
+            result.push(...toExcelColumns(column.childrenArray));
+        }
+        else {
+            const excelColumn = toExcelColumn(column);
+            if (column.isColumnGroup) {
+                excelColumn.children = [excelColumn].concat(toExcelColumns(column.childrenArray));
+            }
+            result.push(excelColumn);
+        }
+    });
+    return result;
+};
+const ɵ2 = toExcelColumns;
+const componentColumns = (component) => {
+    const columns = toExcelColumns(component.columns.toArray());
+    return orderBy(columns, [{ field: 'locked', dir: 'desc' }]);
+};
+const ɵ3 = componentColumns;
+/**
+ * Configures the settings for the export of TreeList in Excel ([see example]({% slug excelexport_treelist %})).
+ */
+let ExcelComponent = class ExcelComponent {
+    constructor(excelService, localization, zone) {
+        this.excelService = excelService;
+        this.localization = localization;
+        this.zone = zone;
+        /**
+         * Specifies the file name of the exported Excel file.
+         * @default "Export.xlsx"
+         */
+        this.fileName = 'Export.xlsx';
+        /**
+         * Specifies if export should include all pages
+         * @default true
+         */
+        this.allPages = true;
+        /**
+         * Specifies if the export should expand all items or should use the current TreeList state.
+         * @default true
+         */
+        this.expandAll = true;
+        /**
+         * @hidden
+         */
+        this.columns = new QueryList();
+        this.saveSubscription = excelService.saveToExcel.subscribe(this.save.bind(this));
+    }
+    ngOnDestroy() {
+        this.saveSubscription.unsubscribe();
+        if (this.dataSubscription) {
+            this.dataSubscription.unsubscribe();
+        }
+    }
+    save(component) {
+        const result = this.fetchData ? this.fetchData(component) : null;
+        this.excelService.toggleLoading(true);
+        this.zone.runOutsideAngular(() => {
+            if (result && isObservable(result.data)) {
+                this.dataSubscription = result.data.pipe(take(1)).subscribe((data) => {
+                    this.dataSubscription = null;
+                    this.exportData(component, {
+                        data: data,
+                        fetchChildren: result.fetchChildren,
+                        hasChildren: result.hasChildren
+                    });
+                });
+            }
+            else {
+                // allow the loading to be shown
+                setTimeout(() => {
+                    this.exportData(component, result);
+                });
+            }
+        });
+    }
+    exportData(component, result) {
+        const viewOptions = result ? {
+            fields: result,
+            expandState: this.expandAll ? EXPANDED_STATE : component.expandStateService
+        } : this.componentViewOptions(component);
+        ViewCollection.loadView(viewOptions).subscribe((view) => {
+            if (!view) {
+                return;
+            }
+            const hierarchy = hierarchyData(view);
+            const options = workbookOptions({
+                columns: this.columns.length ? this.columns : componentColumns(component),
+                data: hierarchy.data,
+                aggregates: hierarchy.aggregates,
+                filterable: this.filterable,
+                creator: this.creator,
+                date: this.date,
+                rtl: this.localization.rtl,
+                collapsible: this.collapsible,
+                hierarchy: hierarchy,
+                paddingCellOptions: this.paddingCellOptions
+            });
+            const args = new ExcelExportEvent(options);
+            if (hasObservers(component.excelExport)) {
+                this.zone.run(() => {
+                    component.excelExport.emit(args);
+                });
+            }
+            this.excelService.toggleLoading(false);
+            if (!args.isDefaultPrevented()) {
+                this.saveFile(options);
+            }
+        });
+    }
+    saveFile(options) {
+        toDataURL(options).then((dataURL) => {
+            saveAs(dataURL, this.fileName, {
+                forceProxy: this.forceProxy,
+                proxyURL: this.proxyURL
+            });
+        });
+    }
+    componentViewOptions(component) {
+        return {
+            fields: Object.assign(component.viewFieldAccessor(), {
+                pageable: !this.allPages,
+                skip: this.allPages ? 0 : component.skip
+            }),
+            expandState: !this.expandAll || (!this.allPages && component.pageable) ? component.expandStateService : EXPANDED_STATE,
+            loaded: new Map(component.view.loaded)
+        };
+    }
+};
+tslib_1.__decorate([
+    Input(),
+    tslib_1.__metadata("design:type", String)
+], ExcelComponent.prototype, "fileName", void 0);
+tslib_1.__decorate([
+    Input(),
+    tslib_1.__metadata("design:type", Boolean)
+], ExcelComponent.prototype, "filterable", void 0);
+tslib_1.__decorate([
+    Input(),
+    tslib_1.__metadata("design:type", String)
+], ExcelComponent.prototype, "creator", void 0);
+tslib_1.__decorate([
+    Input(),
+    tslib_1.__metadata("design:type", Date)
+], ExcelComponent.prototype, "date", void 0);
+tslib_1.__decorate([
+    Input(),
+    tslib_1.__metadata("design:type", Boolean)
+], ExcelComponent.prototype, "forceProxy", void 0);
+tslib_1.__decorate([
+    Input(),
+    tslib_1.__metadata("design:type", String)
+], ExcelComponent.prototype, "proxyURL", void 0);
+tslib_1.__decorate([
+    Input(),
+    tslib_1.__metadata("design:type", Function)
+], ExcelComponent.prototype, "fetchData", void 0);
+tslib_1.__decorate([
+    Input(),
+    tslib_1.__metadata("design:type", Boolean)
+], ExcelComponent.prototype, "collapsible", void 0);
+tslib_1.__decorate([
+    Input(),
+    tslib_1.__metadata("design:type", Boolean)
+], ExcelComponent.prototype, "allPages", void 0);
+tslib_1.__decorate([
+    Input(),
+    tslib_1.__metadata("design:type", Boolean)
+], ExcelComponent.prototype, "expandAll", void 0);
+tslib_1.__decorate([
+    Input(),
+    tslib_1.__metadata("design:type", Object)
+], ExcelComponent.prototype, "paddingCellOptions", void 0);
+tslib_1.__decorate([
+    ContentChildren(ColumnBase, { descendants: true }),
+    tslib_1.__metadata("design:type", QueryList)
+], ExcelComponent.prototype, "columns", void 0);
+ExcelComponent = tslib_1.__decorate([
+    Component({
+        selector: 'kendo-treelist-excel',
+        template: ``
+    }),
+    tslib_1.__metadata("design:paramtypes", [ExcelService,
+        LocalizationService,
+        NgZone])
+], ExcelComponent);
+export { ExcelComponent };
+export { ɵ0, ɵ1, ɵ2, ɵ3 };

package/dist/es2015/excel/excel.module.d.ts

@@ -0,0 +1,37 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+/**
+ * Represents the [NgModule]({{ site.data.urls.angular['ngmoduleapi'] }})
+ * definition for the Excel component of the TreeList.
+ *
+ * @example
+ *
+ * ```ts-no-run
+ * // Import the TreeList and Excel modules
+ * import { TreeListModule, ExcelModule } from '@progress/kendo-angular-treelist';
+ *
+ * // The browser platform with a compiler
+ * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
+ *
+ * import { NgModule } from '@angular/core';
+ *
+ * // Import the app component
+ * import { AppComponent } from './app.component';
+ *
+ * // Define the app module
+ * _@NgModule({
+ *     declarations: [AppComponent], // declare app component
+ *     imports:      [BrowserModule, TreeListModule, ExcelModule], // import TreeList and Excel modules
+ *     bootstrap:    [AppComponent]
+ * })
+ * export class AppModule {}
+ *
+ * // Compile and launch the module
+ * platformBrowserDynamic().bootstrapModule(AppModule);
+ *
+ * ```
+ */
+export declare class ExcelModule {
+}

package/dist/es2015/excel/excel.module.js

@@ -0,0 +1,50 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import * as tslib_1 from "tslib";
+import { NgModule } from '@angular/core';
+import { ExcelComponent } from './excel.component';
+import { ExcelCommandDirective } from './excel-command.directive';
+import { ExcelExportModule } from '@progress/kendo-angular-excel-export';
+const declarations = [ExcelComponent, ExcelCommandDirective];
+/**
+ * Represents the [NgModule]({{ site.data.urls.angular['ngmoduleapi'] }})
+ * definition for the Excel component of the TreeList.
+ *
+ * @example
+ *
+ * ```ts-no-run
+ * // Import the TreeList and Excel modules
+ * import { TreeListModule, ExcelModule } from '@progress/kendo-angular-treelist';
+ *
+ * // The browser platform with a compiler
+ * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
+ *
+ * import { NgModule } from '@angular/core';
+ *
+ * // Import the app component
+ * import { AppComponent } from './app.component';
+ *
+ * // Define the app module
+ * _@NgModule({
+ *     declarations: [AppComponent], // declare app component
+ *     imports:      [BrowserModule, TreeListModule, ExcelModule], // import TreeList and Excel modules
+ *     bootstrap:    [AppComponent]
+ * })
+ * export class AppModule {}
+ *
+ * // Compile and launch the module
+ * platformBrowserDynamic().bootstrapModule(AppModule);
+ *
+ * ```
+ */
+let ExcelModule = class ExcelModule {
+};
+ExcelModule = tslib_1.__decorate([
+    NgModule({
+        declarations: [declarations],
+        exports: [declarations, ExcelExportModule]
+    })
+], ExcelModule);
+export { ExcelModule };

package/dist/es2015/excel/excel.service.d.ts

@@ -0,0 +1,16 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { EventEmitter } from '@angular/core';
+/**
+ * @hidden
+ */
+export declare class ExcelService {
+    saveToExcel: EventEmitter<any>;
+    exportClick: EventEmitter<any>;
+    loadingChange: EventEmitter<any>;
+    loading: boolean;
+    save(component: any): void;
+    toggleLoading(value: boolean): void;
+}

package/dist/es2015/excel/excel.service.js

@@ -0,0 +1,37 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import * as tslib_1 from "tslib";
+import { EventEmitter, Injectable, isDevMode } from '@angular/core';
+/**
+ * @hidden
+ */
+let ExcelService = class ExcelService {
+    /**
+     * @hidden
+     */
+    constructor() {
+        this.saveToExcel = new EventEmitter();
+        this.exportClick = new EventEmitter();
+        this.loadingChange = new EventEmitter();
+    }
+    save(component) {
+        if (this.saveToExcel.observers.length === 0) {
+            if (isDevMode()) {
+                throw new Error('Saving excel requires including the ExcelModule and adding the <kendo-treelist-excel> component.');
+            }
+        }
+        else {
+            this.saveToExcel.emit(component);
+        }
+    }
+    toggleLoading(value) {
+        this.loading = value;
+        this.loadingChange.emit();
+    }
+};
+ExcelService = tslib_1.__decorate([
+    Injectable()
+], ExcelService);
+export { ExcelService };

package/dist/es2015/expand-state/expand-event.d.ts

@@ -0,0 +1,27 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { TreeListComponent } from '../treelist.component';
+import { PreventableEvent } from '../common/preventable-event';
+/**
+ * Arguments for the TreeList expand and collapse events.
+ */
+export declare class ExpandEvent extends PreventableEvent {
+    /**
+     * The expanded/collapsed data item.
+     */
+    dataItem: any;
+    /**
+     * The TreeList component that triggered the event.
+     */
+    sender: TreeListComponent;
+    /**
+     * @hidden
+     */
+    expand: boolean;
+    /**
+     * @hidden
+     */
+    constructor(args: any);
+}

package/dist/es2015/expand-state/expand-event.js

@@ -0,0 +1,18 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { PreventableEvent } from '../common/preventable-event';
+/**
+ * Arguments for the TreeList expand and collapse events.
+ */
+export class ExpandEvent extends PreventableEvent {
+    /**
+     * @hidden
+     */
+    constructor(args) {
+        super();
+        this.expand = args.expand;
+        this.dataItem = args.dataItem;
+    }
+}

package/dist/es2015/expand-state/expand-state.service.d.ts

@@ -0,0 +1,19 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { Subject } from "rxjs";
+/**
+ * @hidden
+ */
+export declare const defaultExpanded: (_item: any) => boolean;
+/**
+ * @hidden
+ */
+export declare class ExpandStateService {
+    changes: Subject<any>;
+    isExpanded: any;
+    toggleState(dataItem: any): void;
+    expand(dataItem: any): void;
+    collapse(dataItem: any): void;
+}

package/dist/es2015/expand-state/expand-state.service.js

@@ -0,0 +1,42 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import * as tslib_1 from "tslib";
+import { Injectable } from '@angular/core';
+import { ExpandEvent } from './expand-event';
+import { Subject } from "rxjs";
+/**
+ * @hidden
+ */
+export const defaultExpanded = (_item) => true;
+/**
+ * @hidden
+ */
+let ExpandStateService = class ExpandStateService {
+    /**
+     * @hidden
+     */
+    constructor() {
+        this.changes = new Subject();
+        this.isExpanded = defaultExpanded;
+    }
+    toggleState(dataItem) {
+        const isExpanded = this.isExpanded(dataItem);
+        this.changes.next(new ExpandEvent({ dataItem: dataItem, expand: !isExpanded }));
+    }
+    expand(dataItem) {
+        if (!this.isExpanded(dataItem)) {
+            this.changes.next(new ExpandEvent({ dataItem: dataItem, expand: true }));
+        }
+    }
+    collapse(dataItem) {
+        if (this.isExpanded(dataItem)) {
+            this.changes.next(new ExpandEvent({ dataItem: dataItem, expand: false }));
+        }
+    }
+};
+ExpandStateService = tslib_1.__decorate([
+    Injectable()
+], ExpandStateService);
+export { ExpandStateService };

package/dist/es2015/expand-state/expandable-tree-component.d.ts

@@ -0,0 +1,31 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { EventEmitter } from '@angular/core';
+/**
+ * @hidden
+ *
+ * An injection token used by the expand-directive to interface with the TreeList or the Gantt.
+ */
+export declare abstract class ExpandableTreeComponent {
+    /**
+     * Extracts the id value if an idField is set.
+     */
+    abstract idGetter: any;
+    /**
+     * Emits when the expand or collapse events are fired.
+     */
+    abstract expandStateChange: EventEmitter<any>;
+    /**
+     * Sets the callback function that indicates if a particular TreeList item is expanded.
+     */
+    abstract isExpanded(node: any): boolean;
+    /**
+     * Updates the state of the current TreeList view without reloading the data.
+     *
+     * Checks all currently rendered items for changes and
+     * triggers re-evaluation of the the `isExpanded` and `isSelected` callbacks.
+     */
+    abstract updateView(): void;
+}

package/dist/es2015/expand-state/expandable-tree-component.js

@@ -0,0 +1,17 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import * as tslib_1 from "tslib";
+import { Injectable } from '@angular/core';
+/**
+ * @hidden
+ *
+ * An injection token used by the expand-directive to interface with the TreeList or the Gantt.
+ */
+let ExpandableTreeComponent = class ExpandableTreeComponent {
+};
+ExpandableTreeComponent = tslib_1.__decorate([
+    Injectable()
+], ExpandableTreeComponent);
+export { ExpandableTreeComponent };