@univerjs-pro/sheets-pivot/lib/types/commands/command/update-pivot-setting.command.d.ts

Univer Sheets Pivot Table

import { PivotSubtotalTypeEnum } from '@univerjs-pro/engine-pivot';
import { ICommand } from '@univerjs/core';
import { IPivotPanelSourceList, IPivotPanelTableListItemBase } from '../../const/type';
export interface IUpdatePivotFieldSettingCommandParams {
    /**
     * @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} tableFieldId  The table field id. Which is the field id of pivot table.
     */
    tableFieldId: string;
    /**
     * @property {string} pivotTableId  The pivot table id.
     */
    pivotTableId: string;
    /**
     * @property {string} displayName  The display name to of pivot table field.
     */
    displayName?: string;
    /**
     * @property {string} format  The format code of pivot table field.
     */
    format?: string;
    /**
     * @property {PivotSubtotalTypeEnum} subtotalType  The subtotal type of pivot table field.
     */
    subtotalType?: PivotSubtotalTypeEnum;
    /**
     * @property {IPivotPanelTableListItemBase} tableFieldInfo  The table field info.
     */
    tableFieldInfo: IPivotPanelTableListItemBase;
    /**
     * @property {IPivotPanelSourceList} dataFieldInfo  The data field info.
     */
    dataFieldInfo: IPivotPanelSourceList;
}
export declare const UpdatePivotFieldSettingCommand: ICommand<IUpdatePivotFieldSettingCommandParams>;