@univerjs-pro/sheets-pivot/lib/types/commands/command/add-pivot-field.command.d.ts

Pivot table integration for Univer Sheets.

import type { PivotTableFiledAreaEnum } from '@univerjs-pro/engine-pivot';
import type { ICommand } from '@univerjs/core';
export interface IAddPivotFieldCommandParams {
    /**
     * @property {string} unitId  The unit id of workbook which the pivot table belongs to.
     */
    unitId: string;
    /**
     * @property {string} subUnitId  The sub unit id of worksheet which the pivot table belongs to.
     */
    subUnitId: string;
    /**
     * @property {string} pivotTableId  The pivot table id.
     */
    pivotTableId: string;
    /**
     * @property {string} dataFieldId  The data field id. Which is the data source field id.
     */
    dataFieldId: string;
    /**
     * @property {PivotTableFiledAreaEnum} fieldArea  The field area to add the data field.
     */
    fieldArea: PivotTableFiledAreaEnum;
    /**
     * @property {number} index  The index to add the data field. Which is base-on 0.
     */
    index: number;
}
export declare const AddPivotFieldCommand: ICommand<IAddPivotFieldCommandParams>;