@univerjs-pro/engine-pivot 0.25.0 → 1.0.0-alpha.0

package/lib/types/layout/compact.d.ts

@@ -1,9 +1,43 @@
 import type { PivotTable } from '../pivot/pivot-table';
+import type { NodeTree } from '../summary/node-tree';
 import type { SummaryManager } from '../summary/summary-manager';
-import type { IPivotLayoutCtx, IPivotTableQueryData } from '../types';
+import type { IPivotLayoutCtx, IPivotTableQueryData, IPivotViewInfo, IPivotViewValueType } from '../types';
 import type { PivotView } from './pivot-view';
-import { BaseLayout } from './base-layout';
-export declare class CompactLayout extends BaseLayout {
-    static layout(pivotTable: PivotTable, SummaryManager: SummaryManager, queryData: IPivotTableQueryData): PivotView;
-    static layoutRow(ctx: IPivotLayoutCtx): void;
+import { TabularLayout } from './tabular';
+export declare class CompactLayout extends TabularLayout {
+    static layout(pivotTable: PivotTable, summaryManager: SummaryManager, queryData: IPivotTableQueryData): PivotView;
+    static layoutRowFields(ctx: IPivotLayoutCtx): void;
+    static shouldSplitRootByValues(ctx: IPivotLayoutCtx): boolean;
+    static layoutRowChildren(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number, valueIds: string[]): number;
+    static layoutRowNode(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number, valueIds: string[]): {
+        itemSize: number;
+        topTotalSize: number;
+        bottomTotalSize: number;
+    };
+    static layoutRowNodeToCursor(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number, valueIds: string[]): number;
+    static shouldWriteSubtotalAtBottom(ctx: IPivotLayoutCtx): boolean;
+    static shouldWriteMultiValueSubtotalAtBottom(ctx: IPivotLayoutCtx, nodeTree: NodeTree): boolean;
+    static writeParentItemRow(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number): number;
+    static writeValueHeaderRow(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number, valueId: string): number;
+    static writeRootValueHeaderRow(ctx: IPivotLayoutCtx, row: number, valueId: string): number;
+    static writeParentRows(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number, valueIds: string[]): number;
+    static writeParentRow(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number, valueIndex: number, valueLabel?: string): void;
+    static writeBottomSubtotalRows(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number, valueIds: string[]): number;
+    static writeBottomSubtotalRow(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number, valueIndex: number, valueLabel?: string): void;
+    static writeLeafRows(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number, valueIds: string[]): number;
+    static shouldWriteLeafValuesUnderItem(ctx: IPivotLayoutCtx): boolean;
+    static writeLeafItemRow(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number): number;
+    static writeLeafValueRow(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number, valueIndex: number, valueLabel: string): void;
+    static writeGrandTotalRows(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number, valueIds: string[]): number;
+    static layoutGrandTotalValues(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number, measureIndex: number): void;
+    static createRowInfo(nodeTree: NodeTree, extra: Partial<IPivotViewInfo>): IPivotViewInfo;
+    static createGrandTotalInfo(nodeTree: NodeTree, valueIndex: number): IPivotViewInfo;
+    static getRowColCount(ctx: IPivotLayoutCtx): number;
+    static getRowLabelCol(_ctx: IPivotLayoutCtx, _nodeLevel: number): number;
+    static getValueLabelCol(_ctx: IPivotLayoutCtx, _nodeLevel: number): number;
+    static getNodeDisplayValue(nodeTree: NodeTree): IPivotViewValueType;
+    static applyNodeValueType(rowView: IPivotLayoutCtx['view']['rowView'], row: number, col: number, nodeTree: NodeTree): void;
+    static repeatRowLabelsForNode(_ctx: IPivotLayoutCtx, _nodeTree: NodeTree, _row: number): void;
+    static layoutColHeader(ctx: IPivotLayoutCtx): void;
+    static layoutCorner(ctx: IPivotLayoutCtx): void;
 }

package/lib/types/layout/outline.d.ts

@@ -1,9 +1,40 @@
 import type { PivotTable } from '../pivot/pivot-table';
+import type { NodeTree } from '../summary/node-tree';
 import type { SummaryManager } from '../summary/summary-manager';
-import type { IPivotLayoutCtx, IPivotTableQueryData } from '../types';
+import type { IPivotLayoutCtx, IPivotTableQueryData, IPivotViewInfo, IPivotViewValueType } from '../types';
 import type { PivotView } from './pivot-view';
-import { BaseLayout } from './base-layout';
-export declare class OutlineLayout extends BaseLayout {
-    static layout(pivotTable: PivotTable, SummaryManager: SummaryManager, queryData: IPivotTableQueryData): PivotView;
-    static layoutRow(ctx: IPivotLayoutCtx): void;
+import { TabularLayout } from './tabular';
+export declare class OutlineLayout extends TabularLayout {
+    static layout(pivotTable: PivotTable, summaryManager: SummaryManager, queryData: IPivotTableQueryData): PivotView;
+    static layoutRowFields(ctx: IPivotLayoutCtx): void;
+    static shouldSplitRootByValues(ctx: IPivotLayoutCtx): boolean;
+    static layoutRowChildren(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number, valueIds: string[]): number;
+    static layoutRowNode(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number, valueIds: string[]): {
+        itemSize: number;
+        topTotalSize: number;
+        bottomTotalSize: number;
+    };
+    static layoutRowNodeToCursor(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number, valueIds: string[]): number;
+    static shouldWriteSubtotalAtBottom(ctx: IPivotLayoutCtx): boolean;
+    static shouldWriteMultiValueSubtotalAtBottom(ctx: IPivotLayoutCtx, nodeTree: NodeTree): boolean;
+    static writeParentItemRow(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number): number;
+    static writeValueHeaderRow(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number, valueId: string): number;
+    static writeRootValueHeaderRow(ctx: IPivotLayoutCtx, row: number, valueId: string): number;
+    static writeParentRows(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number, valueIds: string[]): number;
+    static writeParentRow(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number, valueIndex: number, valueLabel?: string): void;
+    static writeBottomSubtotalRows(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number, valueIds: string[]): number;
+    static writeBottomSubtotalRow(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number, valueIndex: number, valueLabel?: string): void;
+    static writeLeafRows(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number, valueIds: string[]): number;
+    static shouldWriteLeafValuesUnderItem(ctx: IPivotLayoutCtx): boolean;
+    static writeLeafItemRow(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number): number;
+    static writeLeafValueRow(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number, valueIndex: number, valueLabel: string): void;
+    static writeGrandTotalRows(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number, valueIds: string[]): number;
+    static layoutGrandTotalValues(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number, measureIndex: number): void;
+    static createRowInfo(nodeTree: NodeTree, extra: Partial<IPivotViewInfo>): IPivotViewInfo;
+    static createGrandTotalInfo(nodeTree: NodeTree, valueIndex: number): IPivotViewInfo;
+    static getRowColCount(ctx: IPivotLayoutCtx): number;
+    static getRowLabelCol(ctx: IPivotLayoutCtx, nodeLevel: number): number;
+    static getValueLabelCol(ctx: IPivotLayoutCtx, nodeLevel: number): number;
+    static getNodeDisplayValue(nodeTree: NodeTree): IPivotViewValueType;
+    static applyNodeValueType(rowView: IPivotLayoutCtx['view']['rowView'], row: number, col: number, nodeTree: NodeTree): void;
 }

package/lib/types/layout/tabular.d.ts

@@ -22,6 +22,7 @@ export declare class TabularLayout extends BaseLayout {
     static getMeasureInfoByIndex(ctx: IPivotLayoutCtx, valueQueryInfo: IPivotTableValueFieldQueryData[], rowInfo: IPivotViewInfo, colInfo: IPivotViewInfo): IPivotTableValueFieldQueryData;
     static layoutValueLeafNode(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number, paths: string[], measureIndex: number): void;
     static getColIndexForRowHeader(nodeLevel: number, valueIndex: number, hasMultiValue: boolean): number;
+    static repeatRowLabelsForNode(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number): void;
     static doRowBrachNode(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number, valueIds: string[]): INodeSizeInfo;
     static layoutRowNode(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number, valueIds: string[]): INodeSizeInfo;
     static updateRowSubtotal(ctx: IPivotLayoutCtx, row: number, nodeTree: NodeTree, valueIds: string[]): void;

package/lib/types/pivot/model.d.ts

@@ -97,6 +97,8 @@ export declare class PivotModel {
      * @returns {IPivotTableOptions} - The options of the pivot table.
      */
     getOptions(): IPivotTableOptions;
+    setLayout(layout: PivotLayoutTypeEnum): void;
+    getLayout(): PivotLayoutTypeEnum;
     /**
      * @description Set the collapse status of the field. Those properties are used to save the collapse status of the field in the pivot table.
      * @param {string} fieldId - The id of the field.

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

@@ -2,7 +2,7 @@ import type { DataField } from '../field/data-field';
 import type { FieldsCollection } from '../field/fields-collection';
 import type { PivotView } from '../layout/pivot-view';
 import type { IPivotTableChangeSet, IPivotTableFilterInfo, IPivotTableOptions, IPivotTableQueryData, IPivotTableSnapshot, IPivotTableSortInfo, IPivotTableValueFilter, PivotTableFiledAreaEnum, PivotTableValuePositionEnum } from '../types';
-import { PivotCallbackEnum, PivotDataFieldDataTypeEnum, PivotSubtotalTypeEnum } from '../types';
+import { PivotCallbackEnum, PivotDataFieldDataTypeEnum, PivotLayoutTypeEnum, PivotSubtotalTypeEnum } from '../types';
 import { PivotModel } from './model';
 import { PivotTableLabelField, PivotTableValueField } from './table-field';
 /**
@@ -140,6 +140,8 @@ export declare class PivotTable {
      */
     addFieldWithSourceId(dataFieldId: string, area: PivotTableFiledAreaEnum, index?: number, provideTableFieldId?: string): PivotTableLabelField | PivotTableValueField | undefined;
     setOptions(options: IPivotTableOptions): void;
+    setLayout(layout: PivotLayoutTypeEnum): void;
+    getLayout(): PivotLayoutTypeEnum;
     /**
      *  the func is only use for when refresh
      * @param {string} fieldId the table field id
@@ -285,6 +287,7 @@ export declare class PivotTable {
     setDirty(dirty: boolean): void;
     reset(area?: PivotTableFiledAreaEnum): void;
     query(config?: IPivotTableQueryData): PivotView;
+    private _layout;
     toJSON(): IPivotTableSnapshot;
     fromJSON(data: IPivotTableSnapshot): void;
     dispose(): void;

package/lib/types/types/enum.d.ts

@@ -630,6 +630,21 @@ export declare enum PivotLayoutTypeEnum {
      */
     tabular = 3
 }
+/**
+ * Enum for pivot table row subtotal display position.
+ * @readonly
+ * @enum {number}
+ */
+export declare enum PivotSubtotalPositionEnum {
+    /**
+     * @property {number} top - show row subtotals at the top of each group
+     */
+    top = 1,
+    /**
+     * @property {number} bottom - show row subtotals at the bottom of each group
+     */
+    bottom = 2
+}
 /**
  * Enum the execution time of callback functions
  * @enum {string}

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

@@ -166,7 +166,11 @@ export declare enum PivotTableChangeTypeEnum {
     /**
      * Set value filter to the field in the pivot table.
      */
-    SetValueFilter = 12
+    SetValueFilter = 12,
+    /**
+     * Set report layout of the pivot table.
+     */
+    SetLayout = 13
 }
 /**
  * The change of adding field to the pivot table.
@@ -331,6 +335,23 @@ export interface IPivotTableSetOptionsChange {
      */
     newOptions: IPivotTableOptions;
 }
+/**
+ * The change of setting report layout to the pivot table.
+ */
+export interface IPivotTableSetLayoutChange {
+    /**
+     * @property {PivotTableChangeTypeEnum} type The type of the change.
+     */
+    type: PivotTableChangeTypeEnum.SetLayout;
+    /**
+     * @property {PivotLayoutTypeEnum} oldLayout The old layout of the pivot table.
+     */
+    oldLayout: PivotLayoutTypeEnum;
+    /**
+     * @property {PivotLayoutTypeEnum} newLayout The new layout of the pivot table.
+     */
+    newLayout: PivotLayoutTypeEnum;
+}
 /**
  * The change of updating value position in the pivot table.
  */
@@ -458,4 +479,4 @@ export interface IPivotTableSetCollapseChange {
      */
     item?: string;
 }
-export type IPivotTableChangeSet = IPivotTableAddFieldChange | IPivotTableSetSubtotalTypeChange | IPivotTableRemoveFieldChange | IPivotTableRenameFieldChange | IPivotTableSetFilterInfoChange | IPivotTableSetSortInfoChange | IPivotTableUpdatePositionChange | IPivotTableUpdateValuePositionChange | IPivotTableSetOptionsChange | IPivotTableSetFormatChange | IPivotTableSetCollapseChange | IPivotUpdateSourceChange | IPivotTableSetValueFilterChange;
+export type IPivotTableChangeSet = IPivotTableAddFieldChange | IPivotTableSetSubtotalTypeChange | IPivotTableRemoveFieldChange | IPivotTableRenameFieldChange | IPivotTableSetFilterInfoChange | IPivotTableSetSortInfoChange | IPivotTableUpdatePositionChange | IPivotTableUpdateValuePositionChange | IPivotTableSetOptionsChange | IPivotTableSetFormatChange | IPivotTableSetCollapseChange | IPivotUpdateSourceChange | IPivotTableSetValueFilterChange | IPivotTableSetLayoutChange;

package/lib/types/types/layout-type.d.ts

@@ -1,7 +1,7 @@
 import type { PivotView } from '../layout/pivot-view';
 import type { NodeTree } from '../summary/node-tree';
 import type { SummaryManager } from '../summary/summary-manager';
-import type { PivotErrorTypeEnum } from './enum';
+import type { PivotErrorTypeEnum, PivotSubtotalPositionEnum } from './enum';
 import type { IPivotTableGroupInfo, IPivotTableQueryData, IPivotTableValueFieldQueryData, IValueFilterInfoItem } from './interface';
 export interface IPivotViewItemData {
     [row: number]: IPivotViewColData;
@@ -70,6 +70,27 @@ export interface IPivotViewInfo {
      * the data field id
      */
     dataFieldId?: string;
+    /**
+     * Whether this row/column item is a top total. Compact and outline layouts can show subtotals
+     * on the parent row while keeping isBottomTotal for existing consumers that treat totals uniformly.
+     */
+    isTopTotal?: boolean;
+    /**
+     * Whether this item is a subtotal row/column.
+     */
+    isSubtotal?: boolean;
+    /**
+     * Whether this item represents a leaf row/column item.
+     */
+    isLeaf?: boolean;
+    /**
+     * Explicit semantic type for row-oriented consumers. Existing layouts can omit this field.
+     */
+    rowType?: 'item' | 'subtotal' | 'grandTotal' | 'value';
+    /**
+     * Whether this corner header should render as the compact row-label caption.
+     */
+    isRowLabel?: boolean;
 }
 /**
  * Represents the pivot cell style type enum
@@ -177,6 +198,10 @@ export interface IPivotTableOptions {
      * Whether to show grand total in column, if showColGrandTotal is false, the grand total in column will not be calculated and rendered
      */
     showColGrandTotal?: boolean;
+    /**
+     * Where row subtotals are displayed for outline layout.
+     */
+    rowSubtotalPosition?: PivotSubtotalPositionEnum;
 }
 export interface INodeSizeInfo {
     /**
@@ -223,6 +248,7 @@ export interface IPivotLayoutCtx {
     showRowGrandTotal: boolean;
     showColSubtotal: boolean;
     showColGrandTotal: boolean;
+    rowSubtotalPosition: PivotSubtotalPositionEnum;
 }
 export interface IPageViewItemRange {
     row: number;
@@ -232,6 +258,7 @@ export interface IPageViewItemRange {
 }
 export interface ILabelViewHeaderMapItem {
     isValue: boolean;
+    isColumnLabel?: boolean;
     level: number;
     tableFieldId: string;
     dataFieldId: string;