@univerjs-pro/engine-pivot 0.5.3 → 0.5.4

package/lib/types/types/json-types.d.ts

@@ -90,95 +90,329 @@ export interface IDataFieldManagerBaseJSON {
     collections: Record<string, IFieldsCollectionJSON>;
     dataFields: Record<string, IDataFieldJSON>;
 }
+/**
+ * Represents the change type of the pivot table.
+ */
 export declare enum PivotTableChangeTypeEnum {
+    /**
+     * Add field to the pivot table.
+     */
     AddField = 0,
+    /**
+     * Set subtotal to the field in the pivot table.
+     */
     SetSubtotalType = 1,
+    /**
+     * Remove field from the pivot table.
+     */
     RemoveField = 2,
+    /**
+     * Rename the field in the pivot table.
+     */
     RenameField = 3,
+    /**
+     * Set filter information to the field in the pivot table.
+     */
     SetFilterInfo = 4,
+    /**
+     * Set sort information to the field in the pivot table.
+     */
     SetSortInfo = 5,
+    /**
+     * Update field position in the pivot table.
+     */
     UpdateFieldPosition = 6,
+    /**
+     * Set options to the pivot table.
+     */
     UpdateValuePosition = 7,
+    /**
+     * Set options to the pivot table.
+     */
     SetOptions = 8,
+    /**
+     * Set format to the field in the pivot table.
+     */
     SetFieldFormat = 9,
+    /**
+     * Set collapse to the field in the pivot table.
+     */
     SetCollapse = 10,
+    /**
+     * Update source of the field in the pivot table.
+     */
     UpdateSource = 11
 }
+/**
+ * The change of adding field to the pivot table.
+ */
 export interface IPivotTableAddFieldChange {
+    /**
+     * @property {PivotTableChangeTypeEnum} type The type of the change.
+     */
     type: PivotTableChangeTypeEnum.AddField;
+    /**
+     * @property {IPivotTableValueFieldJSON | IPivotTableLabelFieldJSON} fieldJson The field json.
+     */
     fieldJson: IPivotTableValueFieldJSON | IPivotTableLabelFieldJSON;
+    /**
+     * @property {PivotTableFiledAreaEnum} area Which area the field is added to.
+     */
     area: PivotTableFiledAreaEnum;
+    /**
+     * @property {number} index The index of the field in the area.
+     */
     index: number;
 }
+/**
+ * The change of updating source of the field in the pivot table.
+ */
 export interface IPivotUpdateSourceChange {
+    /**
+     * @property {PivotTableChangeTypeEnum} type The type of the change.
+     */
     type: PivotTableChangeTypeEnum.UpdateSource;
+    /**
+     * @property {string} tableFieldId The pivot field id.
+     */
     tableFieldId: string;
+    /**
+     * @property {string} oldSourceName The old source name.
+     */
     oldSourceName: string;
+    /**
+     * @property {string} newSourceName The new source name.
+     */
     newSourceName: string;
+    /**
+     * @property {string} oldDataFieldId The old data field id.
+     */
     oldDataFieldId: string;
+    /**
+     * @property {string} newDataFieldId The new data field id.
+     */
     newDataFieldId: string;
 }
+/**
+ * The change of setting subtotal type to the field in the pivot table.
+ */
 export interface IPivotTableSetSubtotalTypeChange {
+    /**
+     * @property {PivotTableChangeTypeEnum} type The type of the change.
+     */
     type: PivotTableChangeTypeEnum.SetSubtotalType;
+    /**
+     * @property {string} fieldId The pivot table field id.
+     */
     fieldId: string;
+    /**
+     * @property {PivotSubtotalTypeEnum} newSubtotalType The new subtotal type.
+     */
     newSubtotalType: PivotSubtotalTypeEnum;
+    /**
+     * @property {PivotSubtotalTypeEnum} oldSubtotalType The old subtotal type.
+     */
     oldSubtotalType: PivotSubtotalTypeEnum;
 }
+/**
+ * The change of removing field from the pivot table.
+ */
 export interface IPivotTableRemoveFieldChange {
+    /**
+     * @property {PivotTableChangeTypeEnum} type The type of the change.
+     */
     type: PivotTableChangeTypeEnum.RemoveField;
+    /**
+     * @property {string} fieldId The pivot table field id.
+     */
     fieldId: string;
+    /**
+     * @property {PivotTableFiledAreaEnum} area Which area the field is removed from.
+     */
     area: PivotTableFiledAreaEnum;
+    /**
+     * @property {number} index The index of the field in the area.
+     */
     index: number;
+    /**
+     * @property {IPivotTableValueFieldJSON | IPivotTableLabelFieldJSON} fieldJson The field json.
+     */
     fieldJson: IPivotTableValueFieldJSON | IPivotTableLabelFieldJSON;
 }
+/**
+ * The change of renaming the field in the pivot table.
+ */
 export interface IPivotTableRenameFieldChange {
+    /**
+     * @property {PivotTableChangeTypeEnum} type The type of the change.
+     */
     type: PivotTableChangeTypeEnum.RenameField;
+    /**
+     * @property {string} fieldId The pivot table field id.
+     */
     fieldId: string;
+    /**
+     * @property {string} oldName The old name of the field.
+     */
     oldName: string;
+    /**
+     * @property {string} newName The new name of the field.
+     */
     newName: string;
 }
+/**
+ * The change of updating field position in the pivot table.
+ */
 export interface IPivotTableUpdatePositionChange {
+    /**
+     * @property {PivotTableChangeTypeEnum} type The type of the change.
+     */
     type: PivotTableChangeTypeEnum.UpdateFieldPosition;
+    /**
+     * @property {string} fieldId The pivot table field id.
+     */
     fieldId: string;
+    /**
+     * @property {PivotTableFiledAreaEnum} oldArea The old area of the field.
+     */
     oldArea: PivotTableFiledAreaEnum;
+    /**
+     * @property {PivotTableFiledAreaEnum} newArea The new area of the field.
+     */
     newArea: PivotTableFiledAreaEnum;
+    /**
+     * @property {number} oldIndex The old index of the field in the area.
+     */
     oldIndex: number;
+    /**
+     * @property {number} newIndex The new index of the field in the area.
+     */
     newIndex: number;
 }
+/**
+ * The change of setting options to the pivot table.
+ */
 export interface IPivotTableSetOptionsChange {
+    /**
+     * @property {PivotTableChangeTypeEnum} type The type of the change.
+     */
     type: PivotTableChangeTypeEnum.SetOptions;
+    /**
+     * @property {IPivotTableOptions} oldOptions The old options of the pivot table.
+     */
     oldOptions: IPivotTableOptions;
+    /**
+     * @property {IPivotTableOptions} newOptions The new options of the pivot table.
+     */
     newOptions: IPivotTableOptions;
 }
+/**
+ * The change of updating value position in the pivot table.
+ */
 export interface IPivotTableUpdateValuePositionChange {
+    /**
+     * @property {PivotTableChangeTypeEnum} type The type of the change.
+     */
     type: PivotTableChangeTypeEnum.UpdateValuePosition;
+    /**
+     * @property {PivotTableValuePositionEnum} oldValuePosition The old value position.
+     */
     oldValuePosition: PivotTableValuePositionEnum;
+    /**
+     * @property {PivotTableValuePositionEnum} newValuePosition The new value position.
+     */
     newValuePosition: PivotTableValuePositionEnum;
+    /**
+     * @property {number} oldIndex The old index of the value position.
+     */
     oldIndex: number;
+    /**
+     * @property {number} newIndex The new index of the value position.
+     */
     newIndex: number;
 }
+/**
+ * The change of setting filter information to the field in the pivot table.
+ */
 export interface IPivotTableSetFilterInfoChange {
+    /**
+     * @property {PivotTableChangeTypeEnum} type The type of the change.
+     */
     type: PivotTableChangeTypeEnum.SetFilterInfo;
+    /**
+     * @property {string} fieldId The pivot table field id.
+     */
     fieldId: string;
+    /**
+     * @property {IPivotTableFilterInfo} oldFilterInfo The old filter information.
+     */
     oldFilterInfo: IPivotTableFilterInfo;
+    /**
+     * @property {IPivotTableFilterInfo} newFilterInfo The new filter information.
+     */
     newFilterInfo: IPivotTableFilterInfo;
 }
+/**
+ * The change of setting sort information to the field in the pivot table.
+ */
 export interface IPivotTableSetSortInfoChange {
+    /**
+     * @property {PivotTableChangeTypeEnum} type The type of the change.
+     */
     type: PivotTableChangeTypeEnum.SetSortInfo;
+    /**
+     * @property {string} fieldId The pivot table field id.
+     */
     fieldId: string;
+    /**
+     * @property {IPivotTableSortInfo | undefined} oldSortInfo The old sort information.
+     */
     oldSortInfo: IPivotTableSortInfo | undefined;
+    /**
+     * @property {IPivotTableSortInfo | undefined} newSortInfo The new sort information.
+     */
     newSortInfo: IPivotTableSortInfo | undefined;
 }
+/**
+ * The change of setting format to the field in the pivot table.
+ */
 export interface IPivotTableSetFormatChange {
+    /**
+     * @property {PivotTableChangeTypeEnum} type The type of the change.
+     */
     type: PivotTableChangeTypeEnum.SetFieldFormat;
+    /**
+     * @property {string} fieldId The pivot table field id.
+     */
     fieldId: string;
+    /**
+     * @property {string | undefined} oldFormat The old format of the field.
+     */
     oldFormat: string | undefined;
+    /**
+     * @property {string | undefined} newFormat The new format of the field.
+     */
     newFormat: string | undefined;
 }
+/**
+ * The change of setting collapse to the field in the pivot table.
+ */
 export interface IPivotTableSetCollapseChange {
+    /**
+     * @property {PivotTableChangeTypeEnum} type The type of the change.
+     */
     type: PivotTableChangeTypeEnum.SetCollapse;
+    /**
+     * @property {string} fieldId The pivot table field id.
+     */
     fieldId: string;
+    /**
+     * @property {boolean} collapse The collapse state of the field.
+     */
     collapse: boolean;
+    /**
+     * @property {string} [item] The item associated with the collapse state.
+     */
     item?: string;
 }
 export type IPivotTableChangeSet = IPivotTableAddFieldChange | IPivotTableSetSubtotalTypeChange | IPivotTableRemoveFieldChange | IPivotTableRenameFieldChange | IPivotTableSetFilterInfoChange | IPivotTableSetSortInfoChange | IPivotTableUpdatePositionChange | IPivotTableUpdateValuePositionChange | IPivotTableSetOptionsChange | IPivotTableSetFormatChange | IPivotTableSetCollapseChange | IPivotUpdateSourceChange;