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

package/dist/es/excel/excel.component.js

@@ -0,0 +1,252 @@
+/**-----------------------------------------------------------------------------------------
+* 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';
+var hierarchyData = function (view) {
+    var data = view.data;
+    var levels = {};
+    var aggregates = {};
+    var items = [];
+    var depth = 0;
+    for (var idx = 0, dataIndex = 0; idx < data.length; idx++) {
+        var 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: function (_item, idx) { return idx; },
+        itemLevel: function (_item, idx) { return levels[idx]; },
+        depth: depth + 1,
+        aggregates: aggregates,
+        data: items
+    };
+};
+var ɵ0 = hierarchyData;
+var toExcelColumn = function (column) {
+    return {
+        title: column.title,
+        field: column.field,
+        locked: Boolean(column.locked),
+        width: column.width,
+        level: column.level,
+        hidden: !column.isVisible,
+        footerTemplate: column.footerTemplate
+    };
+};
+var ɵ1 = toExcelColumn;
+var toExcelColumns = function (columns) {
+    var result = [];
+    sortColumns(columns)
+        .forEach(function (column) {
+        if (column.isSpanColumn) {
+            result.push.apply(result, toExcelColumns(column.childrenArray));
+        }
+        else {
+            var excelColumn = toExcelColumn(column);
+            if (column.isColumnGroup) {
+                excelColumn.children = [excelColumn].concat(toExcelColumns(column.childrenArray));
+            }
+            result.push(excelColumn);
+        }
+    });
+    return result;
+};
+var ɵ2 = toExcelColumns;
+var componentColumns = function (component) {
+    var columns = toExcelColumns(component.columns.toArray());
+    return orderBy(columns, [{ field: 'locked', dir: 'desc' }]);
+};
+var ɵ3 = componentColumns;
+/**
+ * Configures the settings for the export of TreeList in Excel ([see example]({% slug excelexport_treelist %})).
+ */
+var ExcelComponent = /** @class */ (function () {
+    function ExcelComponent(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));
+    }
+    ExcelComponent.prototype.ngOnDestroy = function () {
+        this.saveSubscription.unsubscribe();
+        if (this.dataSubscription) {
+            this.dataSubscription.unsubscribe();
+        }
+    };
+    ExcelComponent.prototype.save = function (component) {
+        var _this = this;
+        var result = this.fetchData ? this.fetchData(component) : null;
+        this.excelService.toggleLoading(true);
+        this.zone.runOutsideAngular(function () {
+            if (result && isObservable(result.data)) {
+                _this.dataSubscription = result.data.pipe(take(1)).subscribe(function (data) {
+                    _this.dataSubscription = null;
+                    _this.exportData(component, {
+                        data: data,
+                        fetchChildren: result.fetchChildren,
+                        hasChildren: result.hasChildren
+                    });
+                });
+            }
+            else {
+                // allow the loading to be shown
+                setTimeout(function () {
+                    _this.exportData(component, result);
+                });
+            }
+        });
+    };
+    ExcelComponent.prototype.exportData = function (component, result) {
+        var _this = this;
+        var viewOptions = result ? {
+            fields: result,
+            expandState: this.expandAll ? EXPANDED_STATE : component.expandStateService
+        } : this.componentViewOptions(component);
+        ViewCollection.loadView(viewOptions).subscribe(function (view) {
+            if (!view) {
+                return;
+            }
+            var hierarchy = hierarchyData(view);
+            var 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
+            });
+            var args = new ExcelExportEvent(options);
+            if (hasObservers(component.excelExport)) {
+                _this.zone.run(function () {
+                    component.excelExport.emit(args);
+                });
+            }
+            _this.excelService.toggleLoading(false);
+            if (!args.isDefaultPrevented()) {
+                _this.saveFile(options);
+            }
+        });
+    };
+    ExcelComponent.prototype.saveFile = function (options) {
+        var _this = this;
+        toDataURL(options).then(function (dataURL) {
+            saveAs(dataURL, _this.fileName, {
+                forceProxy: _this.forceProxy,
+                proxyURL: _this.proxyURL
+            });
+        });
+    };
+    ExcelComponent.prototype.componentViewOptions = function (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);
+    return ExcelComponent;
+}());
+export { ExcelComponent };
+export { ɵ0, ɵ1, ɵ2, ɵ3 };

package/dist/es/excel/excel.module.js

@@ -0,0 +1,53 @@
+/**-----------------------------------------------------------------------------------------
+* 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';
+var 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);
+ *
+ * ```
+ */
+var ExcelModule = /** @class */ (function () {
+    function ExcelModule() {
+    }
+    ExcelModule = tslib_1.__decorate([
+        NgModule({
+            declarations: [declarations],
+            exports: [declarations, ExcelExportModule]
+        })
+    ], ExcelModule);
+    return ExcelModule;
+}());
+export { ExcelModule };

package/dist/es/excel/excel.service.js

@@ -0,0 +1,35 @@
+/**-----------------------------------------------------------------------------------------
+* 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
+ */
+var ExcelService = /** @class */ (function () {
+    function ExcelService() {
+        this.saveToExcel = new EventEmitter();
+        this.exportClick = new EventEmitter();
+        this.loadingChange = new EventEmitter();
+    }
+    ExcelService.prototype.save = function (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);
+        }
+    };
+    ExcelService.prototype.toggleLoading = function (value) {
+        this.loading = value;
+        this.loadingChange.emit();
+    };
+    ExcelService = tslib_1.__decorate([
+        Injectable()
+    ], ExcelService);
+    return ExcelService;
+}());
+export { ExcelService };

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

@@ -0,0 +1,23 @@
+/**-----------------------------------------------------------------------------------------
+* 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 { PreventableEvent } from '../common/preventable-event';
+/**
+ * Arguments for the TreeList expand and collapse events.
+ */
+var ExpandEvent = /** @class */ (function (_super) {
+    tslib_1.__extends(ExpandEvent, _super);
+    /**
+     * @hidden
+     */
+    function ExpandEvent(args) {
+        var _this = _super.call(this) || this;
+        _this.expand = args.expand;
+        _this.dataItem = args.dataItem;
+        return _this;
+    }
+    return ExpandEvent;
+}(PreventableEvent));
+export { ExpandEvent };

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

@@ -0,0 +1,40 @@
+/**-----------------------------------------------------------------------------------------
+* 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 var defaultExpanded = function (_item) { return true; };
+/**
+ * @hidden
+ */
+var ExpandStateService = /** @class */ (function () {
+    function ExpandStateService() {
+        this.changes = new Subject();
+        this.isExpanded = defaultExpanded;
+    }
+    ExpandStateService.prototype.toggleState = function (dataItem) {
+        var isExpanded = this.isExpanded(dataItem);
+        this.changes.next(new ExpandEvent({ dataItem: dataItem, expand: !isExpanded }));
+    };
+    ExpandStateService.prototype.expand = function (dataItem) {
+        if (!this.isExpanded(dataItem)) {
+            this.changes.next(new ExpandEvent({ dataItem: dataItem, expand: true }));
+        }
+    };
+    ExpandStateService.prototype.collapse = function (dataItem) {
+        if (this.isExpanded(dataItem)) {
+            this.changes.next(new ExpandEvent({ dataItem: dataItem, expand: false }));
+        }
+    };
+    ExpandStateService = tslib_1.__decorate([
+        Injectable()
+    ], ExpandStateService);
+    return ExpandStateService;
+}());
+export { ExpandStateService };

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

@@ -0,0 +1,20 @@
+/**-----------------------------------------------------------------------------------------
+* 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.
+ */
+var ExpandableTreeComponent = /** @class */ (function () {
+    function ExpandableTreeComponent() {
+    }
+    ExpandableTreeComponent = tslib_1.__decorate([
+        Injectable()
+    ], ExpandableTreeComponent);
+    return ExpandableTreeComponent;
+}());
+export { ExpandableTreeComponent };

package/dist/es/expand-state/expandable.directive.js

@@ -0,0 +1,124 @@
+/**-----------------------------------------------------------------------------------------
+* 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 { Directive, Input, Output, EventEmitter } from '@angular/core';
+import { ExpandableTreeComponent } from './expandable-tree-component';
+import { getter } from '@progress/kendo-common';
+import { isString } from '../utils';
+/**
+ * A directive which controls the expanded state of the items.
+ */
+var ExpandableDirective = /** @class */ (function () {
+    function ExpandableDirective(component) {
+        this.component = component;
+        /**
+         * Fires when the expandedKeys are changed.
+         */
+        this.expandedKeysChange = new EventEmitter();
+        /**
+         * Specifies if the items should be initially expanded.
+         * @default false
+         */
+        this.initiallyExpanded = false;
+        this.state = new Set();
+        this.component.isExpanded = this.isExpanded.bind(this);
+        this.toggleState = this.toggleState.bind(this);
+        this.subscriptions = this.component.expandStateChange.subscribe(this.toggleState);
+    }
+    Object.defineProperty(ExpandableDirective.prototype, "expandedKeys", {
+        get: function () {
+            return Array.from(this.state.keys());
+        },
+        /**
+         * Sets the expanded item keys.
+         */
+        set: function (value) {
+            if (value !== this._expandedKeys) {
+                this._expandedKeys = value;
+                this.component.updateView();
+            }
+        },
+        enumerable: true,
+        configurable: true
+    });
+    Object.defineProperty(ExpandableDirective.prototype, "expandBy", {
+        /**
+         * Defines the item key that will be stored in the expandedKeys collection.
+         * Defaults to the component idField.
+         */
+        set: function (key) {
+            if (isString(key)) {
+                this._expandBy = getter(key);
+            }
+            else {
+                this._expandBy = key;
+            }
+        },
+        enumerable: true,
+        configurable: true
+    });
+    Object.defineProperty(ExpandableDirective.prototype, "keyGetter", {
+        get: function () {
+            return this._expandBy || this.component.idGetter;
+        },
+        enumerable: true,
+        configurable: true
+    });
+    /**
+     * @hidden
+     */
+    ExpandableDirective.prototype.isExpanded = function (item) {
+        var key = this.keyGetter(item);
+        return this.state.has(key) ? !this.initiallyExpanded : this.initiallyExpanded;
+    };
+    ExpandableDirective.prototype.ngOnChanges = function (changes) {
+        if (changes.expandedKeys) {
+            this.state = new Set(this._expandedKeys);
+        }
+        else if (changes.initiallyExpanded) {
+            this.state.clear();
+        }
+    };
+    ExpandableDirective.prototype.ngOnDestroy = function () {
+        this.subscriptions.unsubscribe();
+    };
+    ExpandableDirective.prototype.toggleState = function (args) {
+        var key = this.keyGetter(args.dataItem);
+        if (Boolean(this.initiallyExpanded) !== args.expand) {
+            this.state.add(key);
+        }
+        else {
+            this.state.delete(key);
+        }
+        this.expandedKeysChange.emit(this.expandedKeys);
+    };
+    tslib_1.__decorate([
+        Output(),
+        tslib_1.__metadata("design:type", EventEmitter)
+    ], ExpandableDirective.prototype, "expandedKeysChange", void 0);
+    tslib_1.__decorate([
+        Input(),
+        tslib_1.__metadata("design:type", Array),
+        tslib_1.__metadata("design:paramtypes", [Array])
+    ], ExpandableDirective.prototype, "expandedKeys", null);
+    tslib_1.__decorate([
+        Input(),
+        tslib_1.__metadata("design:type", Boolean)
+    ], ExpandableDirective.prototype, "initiallyExpanded", void 0);
+    tslib_1.__decorate([
+        Input(),
+        tslib_1.__metadata("design:type", Object),
+        tslib_1.__metadata("design:paramtypes", [Object])
+    ], ExpandableDirective.prototype, "expandBy", null);
+    ExpandableDirective = tslib_1.__decorate([
+        Directive({
+            exportAs: 'kendoTreeListExpandable',
+            selector: '[kendoTreeListExpandable]'
+        }),
+        tslib_1.__metadata("design:paramtypes", [ExpandableTreeComponent])
+    ], ExpandableDirective);
+    return ExpandableDirective;
+}());
+export { ExpandableDirective };