@visactor/vtable 0.19.2-alpha.2 → 0.20.0

package/cjs/ListTable.d.ts

@@ -1,4 +1,4 @@
-import type { CellAddress, CellRange, ColumnsDefine, DropDownMenuEventInfo, FieldData, FieldDef, FieldFormat, FieldKeyDef, IPagination, ListTableAPI, ListTableConstructorOptions, MaybePromiseOrUndefined, SortOrder, SortState } from './ts-types';
+import type { AggregationType, CellAddress, CellRange, ColumnsDefine, DropDownMenuEventInfo, FieldData, FieldDef, FieldFormat, FieldKeyDef, FilterRules, IPagination, ListTableAPI, ListTableConstructorOptions, MaybePromiseOrUndefined, SortOrder, SortState } from './ts-types';
 import { HierarchyState } from './ts-types';
 import { BaseTable } from './core';
 import type { ListTableProtected } from './ts-types/base-table';
@@ -15,6 +15,8 @@ export declare class ListTable extends BaseTable implements ListTableAPI {
     isPivotTable(): false;
     isPivotChart(): false;
     get sortState(): SortState | SortState[];
+    get records(): any;
+    get recordsCount(): any;
     updateColumns(columns: ColumnsDefine): void;
     get columns(): ColumnsDefine;
     get header(): ColumnsDefine;
@@ -47,6 +49,7 @@ export declare class ListTable extends BaseTable implements ListTableAPI {
     getMenuInfo(col: number, row: number, type: string): DropDownMenuEventInfo;
     _getSortFuncFromHeaderOption(columns: ColumnsDefine | undefined, field: FieldDef, fieldKey?: FieldKeyDef): ((v1: any, v2: any, order: SortOrder) => 0 | 1 | -1) | undefined;
     updateSortState(sortState: SortState[] | SortState | null, executeSort?: boolean): void;
+    updateFilterRules(filterRules: FilterRules): void;
     getCheckboxState(field?: string | number): boolean[] | Record<string | number, boolean>[];
     getCellCheckboxState(col: number, row: number): boolean;
     setRecords(records: Array<any>, sort?: SortState | SortState[]): void;
@@ -60,5 +63,12 @@ export declare class ListTable extends BaseTable implements ListTableAPI {
     addRecords(records: any[], recordIndex?: number): void;
     deleteRecords(recordIndexs: number[]): void;
     updateRecords(records: any[], recordIndexs: number[]): void;
-    hasCustomRenderOrLayout(): boolean;
+    _hasCustomRenderOrLayout(): boolean;
+    getAggregateValuesByField(field: string | number): {
+        col: number;
+        aggregateValue: {
+            aggregationType: AggregationType;
+            value: number | string;
+        }[];
+    }[];
 }

package/cjs/ListTable.js

@@ -39,7 +39,7 @@ class ListTable extends core_1.BaseTable {
         this.showHeader = !0;
         const internalProps = this.internalProps;
         internalProps.frozenColDragHeaderMode = options.frozenColDragHeaderMode, this.pagination = options.pagination, 
-        internalProps.sortState = options.sortState, internalProps.columns = options.columns ? (0, 
+        internalProps.sortState = options.sortState, internalProps.dataConfig = {}, internalProps.columns = options.columns ? (0, 
         vutils_2.cloneDeep)(options.columns) : options.header ? (0, vutils_2.cloneDeep)(options.header) : [], 
         null === (_a = options.columns) || void 0 === _a || _a.forEach(((colDefine, index) => {
             colDefine.editor && (internalProps.columns[index].editor = colDefine.editor);
@@ -63,6 +63,12 @@ class ListTable extends core_1.BaseTable {
     get sortState() {
         return this.internalProps.sortState;
     }
+    get records() {
+        return this.dataSource.source;
+    }
+    get recordsCount() {
+        return this.dataSource.source.length;
+    }
     updateColumns(columns) {
         const oldHoverState = {
             col: this.stateManager.hover.cellPos.col,
@@ -103,6 +109,16 @@ class ListTable extends core_1.BaseTable {
             const {title: title} = table.internalProps.layoutMap.getHeader(col, row);
             return "function" == typeof title ? title() : title;
         }
+        if (table.internalProps.layoutMap.isAggregation(col, row)) {
+            if (table.internalProps.layoutMap.isTopAggregation(col, row)) {
+                const aggregator = table.internalProps.layoutMap.getAggregatorOnTop(col, row);
+                return (null == aggregator ? void 0 : aggregator.formatValue) ? aggregator.formatValue(col, row, this) : "";
+            }
+            if (table.internalProps.layoutMap.isBottomAggregation(col, row)) {
+                const aggregator = table.internalProps.layoutMap.getAggregatorOnBottom(col, row);
+                return (null == aggregator ? void 0 : aggregator.formatValue) ? aggregator.formatValue(col, row, this) : "";
+            }
+        }
         const {field: field, fieldFormat: fieldFormat} = table.internalProps.layoutMap.getBody(col, row);
         return table.getFieldData(fieldFormat || field, col, row);
     }
@@ -113,6 +129,16 @@ class ListTable extends core_1.BaseTable {
             const {title: title} = table.internalProps.layoutMap.getHeader(col, row);
             return "function" == typeof title ? title() : title;
         }
+        if (table.internalProps.layoutMap.isAggregation(col, row)) {
+            if (table.internalProps.layoutMap.isTopAggregation(col, row)) {
+                const aggregator = table.internalProps.layoutMap.getAggregatorOnTop(col, row);
+                return null == aggregator ? void 0 : aggregator.value();
+            }
+            if (table.internalProps.layoutMap.isBottomAggregation(col, row)) {
+                const aggregator = table.internalProps.layoutMap.getAggregatorOnBottom(col, row);
+                return null == aggregator ? void 0 : aggregator.value();
+            }
+        }
         const {field: field} = table.internalProps.layoutMap.getBody(col, row);
         return table.getFieldData(field, col, row);
     }
@@ -166,7 +192,7 @@ class ListTable extends core_1.BaseTable {
         var _a, _b;
         const internalProps = this.internalProps;
         return super.updateOption(options), internalProps.frozenColDragHeaderMode = options.frozenColDragHeaderMode, 
-        this.pagination = options.pagination, this.showHeader = null === (_a = options.showHeader) || void 0 === _a || _a, 
+        this.pagination = options.pagination, internalProps.dataConfig = {}, this.showHeader = null === (_a = options.showHeader) || void 0 === _a || _a, 
         internalProps.columns = options.columns ? (0, vutils_2.cloneDeep)(options.columns) : options.header ? (0, 
         vutils_2.cloneDeep)(options.header) : [], options.columns.forEach(((colDefine, index) => {
             colDefine.editor && (internalProps.columns[index].editor = colDefine.editor);
@@ -198,18 +224,18 @@ class ListTable extends core_1.BaseTable {
         this.refreshRowColCount();
     }
     refreshRowColCount() {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
         const table = this, {layoutMap: layoutMap} = table.internalProps;
-        layoutMap && (layoutMap.recordsCount = null !== (_b = null === (_a = table.internalProps.dataSource) || void 0 === _a ? void 0 : _a.length) && void 0 !== _b ? _b : 0, 
+        layoutMap && (layoutMap.recordsCount = (null !== (_b = null === (_a = table.internalProps.dataSource) || void 0 === _a ? void 0 : _a.length) && void 0 !== _b ? _b : 0) + layoutMap.hasAggregationOnTopCount + layoutMap.hasAggregationOnBottomCount, 
         table.transpose ? (table.rowCount = null !== (_c = layoutMap.rowCount) && void 0 !== _c ? _c : 0, 
-        table.colCount = (null !== (_e = null === (_d = table.internalProps.dataSource) || void 0 === _d ? void 0 : _d.length) && void 0 !== _e ? _e : 0) * layoutMap.bodyRowSpanCount + layoutMap.headerLevelCount, 
-        table.frozenRowCount = 0, this.internalProps.frozenColCount = null !== (_f = layoutMap.headerLevelCount) && void 0 !== _f ? _f : 0, 
-        table.bottomFrozenRowCount !== (null !== (_g = this.options.bottomFrozenRowCount) && void 0 !== _g ? _g : 0) && (table.bottomFrozenRowCount = null !== (_h = this.options.bottomFrozenRowCount) && void 0 !== _h ? _h : 0), 
-        table.rightFrozenColCount !== (null !== (_j = this.options.rightFrozenColCount) && void 0 !== _j ? _j : 0) && (table.rightFrozenColCount = null !== (_k = this.options.rightFrozenColCount) && void 0 !== _k ? _k : 0)) : (table.colCount = null !== (_l = layoutMap.colCount) && void 0 !== _l ? _l : 0, 
-        table.rowCount = (null !== (_o = null === (_m = table.internalProps.dataSource) || void 0 === _m ? void 0 : _m.length) && void 0 !== _o ? _o : 0) * layoutMap.bodyRowSpanCount + layoutMap.headerLevelCount, 
-        this.internalProps.frozenColCount = null !== (_p = this.options.frozenColCount) && void 0 !== _p ? _p : 0, 
-        table.frozenRowCount = layoutMap.headerLevelCount, table.bottomFrozenRowCount !== (null !== (_q = this.options.bottomFrozenRowCount) && void 0 !== _q ? _q : 0) && (table.bottomFrozenRowCount = null !== (_r = this.options.bottomFrozenRowCount) && void 0 !== _r ? _r : 0), 
-        table.rightFrozenColCount !== (null !== (_s = this.options.rightFrozenColCount) && void 0 !== _s ? _s : 0) && (table.rightFrozenColCount = null !== (_t = this.options.rightFrozenColCount) && void 0 !== _t ? _t : 0)), 
+        table.colCount = layoutMap.recordsCount * layoutMap.bodyRowSpanCount + layoutMap.headerLevelCount, 
+        table.frozenRowCount = 0, this.internalProps.frozenColCount = null !== (_d = layoutMap.headerLevelCount) && void 0 !== _d ? _d : 0, 
+        table.bottomFrozenRowCount !== (null !== (_e = this.options.bottomFrozenRowCount) && void 0 !== _e ? _e : 0) && (table.bottomFrozenRowCount = null !== (_f = this.options.bottomFrozenRowCount) && void 0 !== _f ? _f : 0), 
+        table.rightFrozenColCount !== (null !== (_g = this.options.rightFrozenColCount) && void 0 !== _g ? _g : 0) && (table.rightFrozenColCount = null !== (_h = this.options.rightFrozenColCount) && void 0 !== _h ? _h : 0)) : (table.colCount = null !== (_j = layoutMap.colCount) && void 0 !== _j ? _j : 0, 
+        table.rowCount = layoutMap.recordsCount * layoutMap.bodyRowSpanCount + layoutMap.headerLevelCount, 
+        this.internalProps.frozenColCount = null !== (_k = this.options.frozenColCount) && void 0 !== _k ? _k : 0, 
+        table.frozenRowCount = layoutMap.headerLevelCount, table.bottomFrozenRowCount !== (null !== (_l = this.options.bottomFrozenRowCount) && void 0 !== _l ? _l : 0) && (table.bottomFrozenRowCount = null !== (_m = this.options.bottomFrozenRowCount) && void 0 !== _m ? _m : 0), 
+        table.rightFrozenColCount !== (null !== (_o = this.options.rightFrozenColCount) && void 0 !== _o ? _o : 0) && (table.rightFrozenColCount = null !== (_p = this.options.rightFrozenColCount) && void 0 !== _p ? _p : 0)), 
         this.stateManager.setFrozenCol(this.internalProps.frozenColCount));
     }
     getFieldData(field, col, row) {
@@ -356,23 +382,26 @@ class ListTable extends core_1.BaseTable {
         if (sortState) this.internalProps.sortState = sortState; else if (this.internalProps.sortState) if (Array.isArray(this.internalProps.sortState)) for (let i = 0; i < this.internalProps.sortState.length; i++) {
             this.internalProps.sortState[i].order = "normal";
         } else this.internalProps.sortState.order = "normal";
-        let order, field, fieldKey;
-        if (Array.isArray(this.internalProps.sortState) ? ({order: order, field: field, fieldKey: fieldKey} = null === (_a = this.internalProps.sortState) || void 0 === _a ? void 0 : _a[0]) : ({order: order, field: field, fieldKey: fieldKey} = this.internalProps.sortState), 
+        let order, field;
+        if (Array.isArray(this.internalProps.sortState) ? ({order: order, field: field} = null === (_a = this.internalProps.sortState) || void 0 === _a ? void 0 : _a[0]) : ({order: order, field: field} = this.internalProps.sortState), 
         field && executeSort) {
-            const sortFunc = this._getSortFuncFromHeaderOption(this.internalProps.columns, field, fieldKey);
-            let hd;
-            hd = fieldKey ? this.internalProps.layoutMap.headerObjects.find((col => col && col.fieldKey === fieldKey)) : this.internalProps.layoutMap.headerObjects.find((col => col && col.field === field)), 
+            const sortFunc = this._getSortFuncFromHeaderOption(this.internalProps.columns, field), hd = this.internalProps.layoutMap.headerObjects.find((col => col && col.field === field));
             !1 !== hd.define.sort && (this.dataSource.sort(hd.field, order, sortFunc), this.internalProps.layoutMap.clearCellRangeMap(), 
             this.scenegraph.sortCell());
         }
         this.stateManager.updateSortState(sortState);
     }
+    updateFilterRules(filterRules) {
+        this.scenegraph.clearCells(), this.internalProps.dataConfig.filterRules = filterRules, 
+        this.sortState ? (this.dataSource.updateFilterRulesForSorted(filterRules), (0, tableHelper_1.sortRecords)(this)) : this.dataSource.updateFilterRules(filterRules), 
+        this.refreshRowColCount(), this.scenegraph.createSceneGraph();
+    }
     getCheckboxState(field) {
         return this.stateManager.checkedState.length < this.rowCount - this.columnHeaderLevelCount && this.stateManager.initLeftRecordsCheckState(this.records), 
         (0, vutils_1.isValid)(field) ? this.stateManager.checkedState.map((state => state[field])) : this.stateManager.checkedState;
     }
     getCellCheckboxState(col, row) {
-        const define = this.getBodyColumnDefine(col, row), field = null == define ? void 0 : define.field, cellType = null == define ? void 0 : define.cellType;
+        const define = this.getBodyColumnDefine(col, row), field = null == define ? void 0 : define.field, cellType = this.getCellType(col, row);
         if ((0, vutils_1.isValid)(field) && "checkbox" === cellType) {
             const dataIndex = this.dataSource.getIndexKey(this.getRecordShowIndexByCell(col, row));
             return this.stateManager.checkedState[dataIndex][field];
@@ -388,12 +417,10 @@ class ListTable extends core_1.BaseTable {
         if (this.scenegraph.clearCells(), void 0 !== sort && (this.internalProps.sortState = sort, 
         this.stateManager.setSortState(this.sortState)), records) {
             if ((0, tableHelper_1._setRecords)(this, records), this.sortState) {
-                let order, field, fieldKey;
-                if (Array.isArray(this.sortState) ? 0 !== this.sortState.length && ({order: order, field: field, fieldKey: fieldKey} = null === (_a = this.sortState) || void 0 === _a ? void 0 : _a[0]) : ({order: order, field: field, fieldKey: fieldKey} = this.sortState), 
+                let order, field;
+                if (Array.isArray(this.sortState) ? 0 !== this.sortState.length && ({order: order, field: field} = null === (_a = this.sortState) || void 0 === _a ? void 0 : _a[0]) : ({order: order, field: field} = this.sortState), 
                 order && field && "normal" !== order) {
-                    const sortFunc = this._getSortFuncFromHeaderOption(void 0, field, fieldKey);
-                    let hd;
-                    hd = fieldKey ? this.internalProps.layoutMap.headerObjects.find((col => col && col.fieldKey === fieldKey)) : this.internalProps.layoutMap.headerObjects.find((col => col && col.field === field)), 
+                    const sortFunc = this._getSortFuncFromHeaderOption(void 0, field), hd = this.internalProps.layoutMap.headerObjects.find((col => col && col.field === field));
                     !1 !== hd.define.sort && this.dataSource.sort(hd.field, order, null != sortFunc ? sortFunc : util_1.defaultOrderFn);
                 }
             }
@@ -438,6 +465,15 @@ class ListTable extends core_1.BaseTable {
     changeCellValue(col, row, value) {
         const recordIndex = this.getRecordShowIndexByCell(col, row), {field: field} = this.internalProps.layoutMap.getBody(col, row), beforeChangeValue = this.getCellRawValue(col, row);
         this.isHeader(col, row) ? this.internalProps.layoutMap.updateColumnTitle(col, row, value) : this.dataSource.changeFieldValue(value, recordIndex, field, col, row, this);
+        const aggregators = this.internalProps.layoutMap.getAggregators(col, row);
+        if (aggregators) {
+            if (Array.isArray(aggregators)) for (let i = 0; i < (null == aggregators ? void 0 : aggregators.length); i++) aggregators[i].recalculate(); else aggregators.recalculate();
+            const aggregatorCells = this.internalProps.layoutMap.getCellAddressHasAggregator(col, row);
+            for (let i = 0; i < aggregatorCells.length; i++) {
+                const range = this.getCellRange(aggregatorCells[i].col, aggregatorCells[i].row);
+                for (let sCol = range.start.col; sCol <= range.end.col; sCol++) for (let sRow = range.start.row; sRow <= range.end.row; sRow++) this.scenegraph.updateCellContent(sCol, sRow);
+            }
+        }
         const range = this.getCellRange(col, row);
         for (let sCol = range.start.col; sCol <= range.end.col; sCol++) for (let sRow = range.start.row; sRow <= range.end.row; sRow++) this.scenegraph.updateCellContent(sCol, sRow);
         if ("adaptive" === this.widthMode || this.autoFillWidth && this.getAllColsWidth() <= this.tableNoFrameWidth) 0 === this.internalProps._widthResizedColMap.size && this.scenegraph.recalculateColWidths(); else if (!this.internalProps._widthResizedColMap.has(col)) {
@@ -682,7 +718,7 @@ class ListTable extends core_1.BaseTable {
             }
         }
     }
-    hasCustomRenderOrLayout() {
+    _hasCustomRenderOrLayout() {
         var _a, _b, _c, _d;
         const {headerObjects: headerObjects} = this.internalProps.layoutMap;
         if (this.options.customRender) return !0;
@@ -692,6 +728,27 @@ class ListTable extends core_1.BaseTable {
         }
         return !1;
     }
+    getAggregateValuesByField(field) {
+        const columns = this.internalProps.layoutMap.getColumnByField(field), results = [];
+        for (let i = 0; i < columns.length; i++) {
+            const aggregator = columns[i].columnDefine.aggregator;
+            if (delete columns[i].columnDefine, aggregator) {
+                const columnAggregateValue = {
+                    col: columns[i].col,
+                    aggregateValue: null
+                };
+                if (columnAggregateValue.aggregateValue = [], Array.isArray(aggregator)) for (let j = 0; j < aggregator.length; j++) columnAggregateValue.aggregateValue.push({
+                    aggregationType: aggregator[j].type,
+                    value: aggregator[j].value()
+                }); else columnAggregateValue.aggregateValue.push({
+                    aggregationType: aggregator.type,
+                    value: aggregator.value()
+                });
+                results.push(columnAggregateValue);
+            }
+        }
+        return results;
+    }
 }
 
 exports.ListTable = ListTable;