@univerjs-pro/sheets-pivot 0.5.0-alpha.0 → 0.5.0-beta.0

package/lib/types/facade/f-pivot-table.d.ts

@@ -0,0 +1,83 @@
+import { Injector, Nullable } from '@univerjs/core';
+import { IPivotTableSortInfo, PivotSubtotalTypeEnum, PivotTableFiledAreaEnum, PivotTableValuePositionEnum } from '@univerjs-pro/engine-pivot';
+import { IPivotTableConfig } from '@univerjs-pro/sheets-pivot';
+export declare class FPivotTable {
+    unitId: string;
+    subUnitId: string;
+    pivotTableId: string;
+    private _injector;
+    constructor(unitId: string, subUnitId: string, pivotTableId: string, injector: Injector);
+    /**
+     * @description Get the pivot table config by the pivot table id.
+     * @typedef NPivotTableConfig
+     * @property {TargetInfo} targetCellInfo  The target cell info of the pivot table.
+     * @property {SourceInfo} sourceRangeInfo The source data range info of the pivot table.
+     * @property {boolean} isEmpty The pivot table is empty or not.
+     * @property {object} fieldsConfig The snapshot of the pivot table fields config.
+     * @returns {PivotTableConfig|undefined} The pivot table config or undefined.
+     */
+    getConfig(): Nullable<IPivotTableConfig>;
+    /**
+     * @description Remove a pivot table from the workbook by pivot table id
+     */
+    remove(): Promise<boolean>;
+    /**
+     *@description Add a pivot field to the pivot table.
+     * @param {string|number} dataFieldIdOrIndex The data field id.
+     * @param {PivotTableFiledAreaEnum} fieldArea The area of the field.
+     * @param {number} index The index of the field in the target area.
+     * @returns {boolean} Whether the pivot field is added successfully.
+     */
+    addField(dataFieldIdOrIndex: string | number, fieldArea: PivotTableFiledAreaEnum, index: number): Promise<boolean>;
+    /**
+     * @description Remove a pivot field from the pivot table
+     * @param {string[]} fieldIds The deleted field ids.
+     * @returns {boolean} Whether the pivot field is removed successfully.
+     */
+    removeField(fieldIds: string[]): Promise<boolean>;
+    /**
+     * @description Update the pivot table field position.
+     * @param {string} fieldId - The moved field id.
+     * @param {PivotTableFiledAreaEnum} area - The target area of the field.
+     * @param {number} index - The target index of the field, if the index is bigger than the field count in the target area, the field will be moved to the last, if the index is smaller than 0, the field will be moved to the first.
+     * @returns {boolean} Whether the pivot field is moved successfully.
+     */
+    updateFieldPosition(fieldId: string, area: PivotTableFiledAreaEnum, index: number): Promise<boolean>;
+    /**
+     * @description If there are multiple value fields in the pivot table, you can update the position of the value field, which only can be position in row or column.
+     * @param {PivotTableValuePositionEnum} position - The position of the value field.
+     * @param {number} index - The index of the value field.
+     * @returns {boolean} Whether the pivot value field is moved successfully.
+     */
+    updateValuePosition(position: PivotTableValuePositionEnum, index: number): Promise<boolean>;
+    /**
+     * @description Set the pivot table subtotal type for value field, it only works for the value field.
+     * @param {string} fieldId - The field id.
+     * @param {PivotSubtotalTypeEnum} subtotalType - The subtotal type of the field.
+     * @returns {boolean} Whether the pivot table subtotal type is set successfully.
+     */
+    setSubtotalType(fieldId: string, subtotalType: PivotSubtotalTypeEnum): Promise<boolean>;
+    /**
+     * @description Set the pivot table sort info.
+     * @param {string} tableFieldId - The field id of the sort.
+     * @param {PivotTableSortInfo} info - The sort info.
+     * @typedef PivotTableSortInfo
+     * @property {PivotDataFieldSortOperatorEnum} type The sort operator of the field items.
+     * @returns {boolean} Whether the pivot table sort info is set successfully.
+     */
+    setLabelSort(tableFieldId: string, info: IPivotTableSortInfo): Promise<boolean>;
+    /**
+     * @description Set the pivot table manual filter.
+     * @param {string} tableFieldId - The field id of the filter.
+     * @param {string[]} items - The items of the filter.
+     * @returns {boolean} Whether the pivot table filter is set successfully.
+     */
+    setLabelManualFilter(tableFieldId: string, items: string[], isAll?: boolean): Promise<boolean>;
+    /**
+     * @description Rename the pivot table field.
+     * @param {string} fieldId - The field id.
+     * @param {string} name - The new name of the field.
+     * @returns {boolean} Whether the pivot table field is renamed successfully.
+     */
+    renameField(fieldId: string, name: string): Promise<boolean>;
+}

package/lib/types/facade/f-workbook.d.ts

@@ -0,0 +1,72 @@
+import { IUnitRangeName } from '@univerjs/core';
+import { IPivotCellPositionInfo, PositionType } from '@univerjs-pro/sheets-pivot';
+import { FPivotTable } from './f-pivot-table';
+interface IFWorkbookSheetsPivotMixin {
+    /**
+     * @description Add a pivot table to the Workbook.
+     * @typedef SourceInfo
+     * @property {string} unitId - The unit id of the source data.
+     * @property {string} subUnitId - The sub unit id of the source data.
+     * @property {string} sheetName - The sheet name of the source data.
+     * @property {IRange} range - The range of the source data.
+     * @typedef AnchorCellInfo - The target cell info of the pivot table.
+     * @property {string} unitId - The unit id of the target data.
+     * @property {string} subUnitId - The sub unit id of the target data.
+     * @property {number} row - The range of the target data.
+     * @property {number} col - The range of the target data.
+     * @param {SourceInfo} sourceInfo The source data  range info of the pivot table.
+     * @param {PositionType} positionType whether new a sheet or insert a pivot table to the existing sheet.
+     * @param {AnchorCellInfo} anchorCellInfo The target cell info of the pivot table.
+     * @returns {string|undefined} The added pivot table id.
+     * @example
+     * ```typescript
+     * // should ensure the sheet range {0,0,8,6} is not empty
+     * const fWorkbook = univerAPI.getActiveWorkbook()
+     * const unitId = fWorkbook.getId()
+     * const fSheet = fWorkbook.getActiveSheet();
+     * const subUnitId = fSheet.getSheetId()
+     * const sheetName = fSheet.getSheetName();
+     * const sourceInfo = {
+     *     unitId,
+     *     subUnitId,
+     *     sheetName,
+     *     range: {
+     *         startRow: 0,
+     *         endRow: 8,
+     *         startColumn: 0,
+     *         endColumn: 6
+     *     }
+     * }
+     * const anchorCellInfo = {
+     *     unitId,
+     *     subUnitId,
+     *     row: 0,
+     *     col: 8
+     * }
+     * const fp = await fWorkbook.addPivotTable(sourceInfo, 'exiting', anchorCellInfo)
+     * // the addPivotTable is async, you can add pivot fields after the pivot table is added
+     * // in the future, we will support pivot table added event, you can add pivot fields in the event handler
+     * setTimeout(function() {
+     *     fp.addField(1, 2)
+     *     fp.addField(1, 3)
+     * }, 1000)
+     * ```
+     */
+    addPivotTable(sourceInfo: IUnitRangeName & {
+        subUnitId: string;
+    }, positionType: PositionType, anchorCellInfo: IPivotCellPositionInfo): Promise<FPivotTable | undefined>;
+    /**
+     * @description Get the pivot table id by the cell.
+     * @param {string} unitId The unit id of workbook.
+     * @param {string} subUnitId The sheet id, which  pivot table belongs to.
+     * @param {number} row The checked row.
+     * @param {number} col The checked column.
+     * @returns {string|undefined} The pivot table id or undefined.
+     */
+    getPivotTableByCell(unitId: string, subUnitId: string, row: number, col: number): FPivotTable | undefined;
+}
+declare module '@univerjs/sheets/facade' {
+    interface FWorkbook extends IFWorkbookSheetsPivotMixin {
+    }
+}
+export {};

package/lib/types/facade/index.d.ts

@@ -0,0 +1,2 @@
+import './f-workbook';
+export { FPivotTable } from './f-pivot-table';