@univerjs-pro/engine-pivot 0.4.2 → 0.5.0-alpha.0

package/lib/types/types/interface.d.ts

@@ -1,187 +0,0 @@
-import { PivotDataFieldDataTypeEnum, PivotDataFieldSortOperatorEnum, PivotFilterTypeEnum, PivotShowAsTypeEnum, PivotSubtotalTypeEnum, ST_PivotFilterOperatorEnum } from './enum';
-export interface IDateValue {
-    /**
-     * @description the date value,  it stores the number of seconds since January 1, 1970, 00:00:00 UTC, it is same to excel date value
-     */
-    v: number;
-    /**
-     * @description only date type has this property, we can use it to format the date
-     */
-    f: string;
-}
-type IBlankValue = null | undefined;
-/**
- * Represents the value of a data field in a pivot table data field
- */
-export type IDataFieldValue = string | number | boolean | IDateValue | IBlankValue;
-export interface IDataFieldInfo {
-    id: string;
-    name: string;
-    fieldDataType: PivotDataFieldDataTypeEnum;
-    format: string;
-    maxNumber: number;
-    minNumber: number;
-    maxDate: number;
-    minDate: number;
-    records: IDataFieldValue[];
-    rangeKey: string;
-}
-export interface IPivotField {
-    id: string;
-    displayName: string;
-    subtotalType: PivotSubtotalTypeEnum;
-}
-/**
- * @description using Wefloder to store the pivot table data
- * @typedef Tuple
- * @property {number} sum - The sum of the values in the tuple.
- * @property {number} count - The count of the values in the tuple.
- * @property {number} countN - The count of the number values in the tuple.
- * @property {number} product - The product of the values in the tuple.
- * @property {number} min - The minimum value in the tuple.
- * @property {number} max - The maximum value in the tuple.
- * @property {number} squareSum - The sum of the squares of the values in the tuple.
- */
-export interface IPivotTuple {
-    sum: number;
-    count: number;
-    countN: number;
-    product: number;
-    min: number;
-    max: number;
-    squareSum: number;
-}
-export type IPivotTableFilterInfo = IPivotTableManualFilter | IPivotTableCustomFilter | IPivotTableValueFilter;
-export type IPivotTableSortInfo = IPivotTableLabelSortInfo | IPivotTableValueSortInfo;
-export interface IPivotTableLabelSortInfo {
-    type: PivotDataFieldSortOperatorEnum;
-}
-export interface IPivotTableValueSortInfo {
-    /**
-     * @property {PivotDataFieldSortOperatorEnum} - The sort operator of the field items.
-     */
-    type: PivotDataFieldSortOperatorEnum;
-    /**
-     * @property {string} - The base field id of the field items to sort.
-     */
-    baseFieldId: string;
-    /**
-     * @property {string[]} - The path list of field items to sort.
-     */
-    sortItems: string[];
-}
-/**
- * Represents the Pivot Table Manual Filter info
- */
-export interface IPivotTableManualFilter {
-    /**
-     * @property {PivotFilterTypeEnum} - The filter type.
-     */
-    type: PivotFilterTypeEnum.ManualFilter;
-    /**
-     * @property {string[]} - The list of selected items.
-     */
-    list: string[];
-    isAll?: boolean;
-}
-export interface IPivotTableCustomFilter {
-    type: PivotFilterTypeEnum.CustomFilter;
-    operator: ST_PivotFilterOperatorEnum;
-    expected: any;
-}
-export interface IPivotTableValueFilter {
-    type: PivotFilterTypeEnum.ValueFilter;
-    operator: ST_PivotFilterOperatorEnum;
-    expected: any;
-}
-export interface IPivotTableShowDataAsInfo {
-    type: PivotShowAsTypeEnum;
-    baseFieldId: string;
-    baseItem: string;
-}
-/**
- * Represents the query data for a label field in a pivot table.
- */
-export interface IPivotTableLabelFieldQueryData {
-    /**
-     * The unique identifier of the label field.
-     */
-    id: string;
-    /**
-     * The unique identifier of the data field associated with the label field.
-     */
-    dataFieldId: string;
-    /**
-     * The display name of the label field.
-     */
-    displayName: string;
-    /**
-     * Information about the filter applied to the label field.
-     */
-    filterInfo?: IPivotTableFilterInfo;
-    /**
-     * Information about the sort applied to the label field.
-     */
-    sortInfo: IPivotTableSortInfo;
-}
-/**
- * Represents the data structure for a pivot table query.
- */
-export interface IPivotTableQueryData {
-    /**
-     * The query info of row fields in the pivot table.
-     */
-    rowQueryInfo: IPivotTableLabelFieldQueryData[];
-    /**
-     * The query info of column fields in the pivot table.
-     */
-    colQueryInfo: IPivotTableLabelFieldQueryData[];
-    /**
-     * The query info of filter fields in the pivot table.
-     */
-    filterQueryInfo: IPivotTableLabelFieldQueryData[];
-    /**
-     * The query info of value fields in the pivot table.
-     */
-    valueQueryInfo: IPivotTableValueFieldQueryData[];
-    /**
-     * The collapse state of the fields.
-     * @property {Record<string, boolean|Record<string, boolean>>} - The collapse state of the pivot table.
-     */
-    collapseInfo: Record<string, boolean | Record<string, boolean>>;
-}
-/**
- * Represents the query data for a value field in a pivot table.
- */
-export interface IPivotTableValueFieldQueryData {
-    /**
-     * The unique identifier of the value field.
-     */
-    id: string;
-    /**
-     * The unique identifier of the data field associated with the value field.
-     */
-    dataFieldId: string;
-    /**
-     * The display name of the value field.
-     */
-    displayName: string;
-    /**
-     * The type of subtotal to be displayed for this value field.
-     */
-    subtotal: PivotSubtotalTypeEnum;
-    /**
-     * Information about how to show the data for this value field.
-     */
-    showDataAs: IPivotTableShowDataAsInfo;
-}
-/**
- * Represents the query data for a measure field in a pivot table.
- */
-export interface IPivotTableMeasureData {
-    /**
-     * @property {IPivotTableLabelFieldQueryData[]} - The query data for the value fields.
-     */
-    values: IPivotTableValueFieldQueryData[];
-}
-export {};

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

@@ -1,184 +0,0 @@
-import { PivotLayoutTypeEnum, PivotSubtotalTypeEnum, PivotTableFiledAreaEnum, PivotTableValuePositionEnum } from './enum';
-import { IPivotTableFilterInfo, IPivotTableShowDataAsInfo, IPivotTableSortInfo } from './interface';
-import { IPivotTableOptions } from './layout-type';
-export interface IPivotTableValueFieldJSON {
-    dataFieldId: string;
-    id: string;
-    sourceName: string;
-    displayName: string;
-    format: string | undefined;
-    subtotal: PivotSubtotalTypeEnum;
-    showDataAs: IPivotTableShowDataAsInfo;
-}
-export interface IPivotTableLabelFieldJSON {
-    dataFieldId: string;
-    id: string;
-    sourceName: string;
-    displayName: string;
-    format: string | undefined;
-    sortInfo?: IPivotTableSortInfo;
-    filterInfo?: IPivotTableFilterInfo;
-}
-/**
- * Represents a snapshot of a pivot table.
- */
-export interface IPivotTableSnapshot {
-    /**
-     * Represents the label fields in the pivot table.
-     */
-    dimension: Record<string, IPivotTableLabelFieldJSON>;
-    /**
-     * Represents the value fields in the pivot table.
-     */
-    measure: Record<string, IPivotTableValueFieldJSON>;
-    /**
-     * Represents the fields id used for grouping value in the pivot table.
-     */
-    valueFields: string[];
-    /**
-     * Represents the fields id used for filtering in the pivot table.
-     */
-    filterFields: string[];
-    /**
-     * Represents the fields id used for grouping rows in the pivot table.
-     */
-    rowFields: string[];
-    /**
-     * Represents the fields id used for grouping columns in the pivot table.
-     */
-    columnFields: string[];
-    /**
-     * Represents the fields id that are hidden in the pivot table.
-     */
-    hiddenFields: string[];
-    /**
-     * Represents the special ΣValue fields order index in the dimension fields.
-     */
-    valueIndex: number;
-    /**
-     * Represents the special ΣValue fields position in row or column area.
-     */
-    valuePosition: PivotTableValuePositionEnum;
-    /**
-     * Represents the layout of the pivot table.
-     */
-    layout: PivotLayoutTypeEnum;
-    /**
-     * Represents the collapse information of the pivot table.
-     */
-    collapseInfo: Record<string, any>;
-    options: IPivotTableOptions;
-}
-export interface IFieldsCollectionJSON {
-    fieldIds: string[];
-    customFields: IDataFieldJSON[];
-    displayNameRecord: Record<string, string>;
-    dataRecordCount: number;
-    range: unknown;
-    fields: Record<string, IDataFieldJSON>;
-}
-/**
- * Represents the data field serialized to JSON data structure.
- */
-export interface IDataFieldJSON {
-    id: string;
-    name: string;
-    hexCode: string;
-    rangeKey: string;
-}
-export interface IDataFieldManagerBaseJSON {
-    collections: Record<string, IFieldsCollectionJSON>;
-    dataFields: Record<string, IDataFieldJSON>;
-}
-export declare enum PivotTableChangeTypeEnum {
-    AddField = 0,
-    SetSubtotalType = 1,
-    RemoveField = 2,
-    RenameField = 3,
-    SetFilterInfo = 4,
-    SetSortInfo = 5,
-    UpdateFieldPosition = 6,
-    UpdateValuePosition = 7,
-    SetOptions = 8,
-    SetFieldFormat = 9,
-    SetCollapse = 10,
-    UpdateSource = 11
-}
-export interface IPivotTableAddFieldChange {
-    type: PivotTableChangeTypeEnum.AddField;
-    fieldJson: IPivotTableValueFieldJSON | IPivotTableLabelFieldJSON;
-    area: PivotTableFiledAreaEnum;
-    index: number;
-}
-export interface IPivotUpdateSourceChange {
-    type: PivotTableChangeTypeEnum.UpdateSource;
-    tableFieldId: string;
-    oldSourceName: string;
-    newSourceName: string;
-    oldDataFieldId: string;
-    newDataFieldId: string;
-}
-export interface IPivotTableSetSubtotalTypeChange {
-    type: PivotTableChangeTypeEnum.SetSubtotalType;
-    fieldId: string;
-    newSubtotalType: PivotSubtotalTypeEnum;
-    oldSubtotalType: PivotSubtotalTypeEnum;
-}
-export interface IPivotTableRemoveFieldChange {
-    type: PivotTableChangeTypeEnum.RemoveField;
-    fieldId: string;
-    area: PivotTableFiledAreaEnum;
-    index: number;
-    fieldJson: IPivotTableValueFieldJSON | IPivotTableLabelFieldJSON;
-}
-export interface IPivotTableRenameFieldChange {
-    type: PivotTableChangeTypeEnum.RenameField;
-    fieldId: string;
-    oldName: string;
-    newName: string;
-}
-export interface IPivotTableUpdatePositionChange {
-    type: PivotTableChangeTypeEnum.UpdateFieldPosition;
-    fieldId: string;
-    oldArea: PivotTableFiledAreaEnum;
-    newArea: PivotTableFiledAreaEnum;
-    oldIndex: number;
-    newIndex: number;
-}
-export interface IPivotTableSetOptionsChange {
-    type: PivotTableChangeTypeEnum.SetOptions;
-    oldOptions: IPivotTableOptions;
-    newOptions: IPivotTableOptions;
-}
-export interface IPivotTableUpdateValuePositionChange {
-    type: PivotTableChangeTypeEnum.UpdateValuePosition;
-    oldValuePosition: PivotTableValuePositionEnum;
-    newValuePosition: PivotTableValuePositionEnum;
-    oldIndex: number;
-    newIndex: number;
-}
-export interface IPivotTableSetFilterInfoChange {
-    type: PivotTableChangeTypeEnum.SetFilterInfo;
-    fieldId: string;
-    oldFilterInfo: IPivotTableFilterInfo;
-    newFilterInfo: IPivotTableFilterInfo;
-}
-export interface IPivotTableSetSortInfoChange {
-    type: PivotTableChangeTypeEnum.SetSortInfo;
-    fieldId: string;
-    oldSortInfo: IPivotTableSortInfo | undefined;
-    newSortInfo: IPivotTableSortInfo | undefined;
-}
-export interface IPivotTableSetFormatChange {
-    type: PivotTableChangeTypeEnum.SetFieldFormat;
-    fieldId: string;
-    oldFormat: string | undefined;
-    newFormat: string | undefined;
-}
-export interface IPivotTableSetCollapseChange {
-    type: PivotTableChangeTypeEnum.SetCollapse;
-    fieldId: string;
-    collapse: boolean;
-    item?: string;
-}
-export type IPivotTableChangeSet = IPivotTableAddFieldChange | IPivotTableSetSubtotalTypeChange | IPivotTableRemoveFieldChange | IPivotTableRenameFieldChange | IPivotTableSetFilterInfoChange | IPivotTableSetSortInfoChange | IPivotTableUpdatePositionChange | IPivotTableUpdateValuePositionChange | IPivotTableSetOptionsChange | IPivotTableSetFormatChange | IPivotTableSetCollapseChange | IPivotUpdateSourceChange;

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

@@ -1,237 +0,0 @@
-import { PivotView } from '../layout/pivot-view';
-import { NodeTree } from '../summary/node-tree';
-import { SummaryManager } from '../summary/summary-manager';
-import { PivotErrorTypeEnum } from './enum';
-import { IPivotTableQueryData, IPivotTableValueFieldQueryData } from './interface';
-export interface IPivotViewItemData {
-    [row: number]: IPivotViewColData;
-}
-export interface IPivotViewPrefixValue {
-    prefix: string;
-    value: string;
-}
-export interface IPivotViewErrorValue {
-    errorType: PivotErrorTypeEnum;
-}
-export type IPivotViewValueType = number | string | undefined | IPivotViewErrorValue | IPivotViewPrefixValue;
-interface IPivotViewColData {
-    [col: number]: IPivotViewCellData;
-}
-export interface IPivotViewCellData {
-    v?: IPivotViewValueType;
-    s?: PivotCellStyleTypeEnum;
-    /**
-     * @description only for the pivot table page filter cell, the value is the page filter index
-     */
-    i?: number;
-    /**
-     * means the cell is blank, the  only value is 1
-     */
-    t?: PivotViewCellValueTypeEnum;
-}
-export declare enum PivotViewCellValueTypeEnum {
-    blank = 2,
-    date = 4
-}
-/**
- * Represents the pivot view info data structure, which is used to store row /col path and value index
- */
-export interface IPivotViewInfo {
-    /**
-     * The pivot table field id
-     */
-    tableFieldId: string;
-    /**
-     * The paths of the row/col
-     */
-    paths: string[];
-    /**
-     * The value index of the row/col
-     */
-    valueIndex: number;
-    /**
-     * is this row/col is bottom total, in excel, maybe has top total in outline layout
-     */
-    isBottomTotal?: boolean;
-    /**
-     * the node level of row or col
-     */
-    level: number;
-    /**
-     * only for col view, to match some node does not save in node tree
-     */
-    colPathMap?: Record<string, number>;
-    /**
-     * the info is ΣValue
-     */
-    isValue?: boolean;
-    /**
-     * the data field id
-     */
-    dataFieldId?: string;
-}
-/**
- * Represents the pivot cell style type enum
- */
-export declare enum PivotCellStyleTypeEnum {
-    /**
-     * the pivot table page filter selected all
-     */
-    FilterAll = 1,
-    /**
-     * the pivot table page filter selected partial
-     */
-    FilterPartial = 2,
-    /**
-     * the pivot table page filter selected one
-     */
-    FilterSingle = 3,
-    /**
-     * the pivot table area cell is blank
-     */
-    BlankValue = 4,
-    /**
-     * the pivot table dimension cell has filter but not sort
-     */
-    FilteredSortNone = 5,
-    /**
-     * the pivot table dimension cell has filter and sort asc
-     */
-    FilteredSortAsc = 6,
-    /**
-     * the pivot table dimension cell has filter and sort desc
-     */
-    FilteredSortDesc = 7,
-    /**
-     * the pivot table dimension cell has no filter and sort
-     */
-    FilterNoneSortNone = 8,
-    /**
-     * the pivot table dimension cell has no filter and sort asc
-     */
-    FilterNoneSortAsc = 9,
-    /**
-     * the pivot table dimension cell has no filter and sort desc
-     */
-    FilterNoneSortDesc = 10,
-    /**
-     * the branch node of tree can be collapse
-     */
-    Collapse = 11,
-    /**
-     * the branch node of tree can be expand
-     */
-    Expand = 12,
-    /**
-     * the subtotal cell, the real value should be  `${value} Total` or `${value} 汇总`
-     */
-    Subtotal = 13,
-    /**
-     * the grand total cell, the value template should be `GrandTotal` or `总计`
-     */
-    GrandTotal = 14,
-    /**
-     * the grandtotal has more than oen value,  the real value should be  `Total ${value}` or `总计 ${value}`
-     */
-    MultipleGrandTotal = 15
-}
-/**
- * Represents the data structure for a pivot table config, which is match CT_pivotTableDefinition
- */
-export interface IPivotTableOptions {
-    /**
-     * The page wrap, it is the wrap of page, the page will wrap to next row when the wrapCursor is equal to pageWrap
-     */
-    pageWrap?: number;
-    /**
-     * The page over then down, it is the layout of page, if the pageOverThenDown is true, the page will layout over then down, otherwise, the page will layout down then over
-     */
-    pageOverThenDown?: boolean;
-    showColHeaders?: boolean;
-    showColStripes?: boolean;
-    showLastColumn?: boolean;
-    showRowHeaders?: boolean;
-    showRowStripes?: boolean;
-    /**
-     * use span in the pivot table header
-     */
-    mergeItems?: boolean;
-}
-export interface INodeSizeInfo {
-    /**
-     * The size of the item
-     */
-    itemSize: number;
-    /**
-     *  The size of the children item top total size
-     */
-    topTotalSize: number;
-    /**
-     * The size of the children item bottom total size
-     */
-    bottomTotalSize: number;
-}
-export interface IColumnNodeSizeInfo extends INodeSizeInfo {
-    colPathMap: Record<string, number>;
-}
-export interface IRowNodeSizeInfo extends INodeSizeInfo {
-    valueIndex?: number;
-}
-export interface IPivotLayoutCtx {
-    view: PivotView;
-    rowDeep: number;
-    colDeep: number;
-    rowNodeTree: NodeTree;
-    colNodeTree: NodeTree;
-    measureCount: number;
-    pageWrap: number;
-    pageOverThenDown: boolean;
-    queryData: IPivotTableQueryData;
-    isColMultiMeasure: boolean;
-    isRowMultiMeasure: boolean;
-    valueIndex: number;
-    valueQueryInfo: IPivotTableValueFieldQueryData[];
-    measuresMap: Record<string, IPivotTableValueFieldQueryData>;
-    colMap: Record<string, number>;
-    summaryManager: SummaryManager;
-    measureIndexesMap: Record<string, number>;
-    collapseInfo: Record<string, boolean | Record<string, boolean>>;
-}
-export interface IPageViewItemRange {
-    row: number;
-    col: number;
-    rowCount: number;
-    colCount: number;
-}
-export interface ILabelViewHeaderMapItem {
-    isValue: boolean;
-    level: number;
-    tableFieldId: string;
-    dataFieldId: string;
-}
-export interface IPivotViewItemJSON {
-    data: IPivotViewItemData;
-    info: IPivotViewInfo[];
-    rowCount: number;
-    colCount: number;
-    lastCol: number;
-    lastRow: number;
-}
-export interface IPageViewItemJSON extends IPivotViewItemJSON {
-    lastRow: number;
-    lastCol: number;
-    ranges: IPageViewItemRange[];
-}
-export interface ILabelViewItemJSON extends IPivotViewItemJSON {
-    headerMap: ILabelViewHeaderMapItem[];
-}
-export interface IPivotViewJSON {
-    pageView: IPageViewItemJSON;
-    rowView: ILabelViewItemJSON;
-    colView: ILabelViewItemJSON;
-    dataView: IPivotViewItemJSON;
-    cornerView: IPivotViewItemJSON;
-    version: number;
-    formatMap: Record<string, string>;
-}
-export {};

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

@@ -1,41 +0,0 @@
-import { DataField } from '../field/data-field';
-import { PivotTuple } from '../summary/pivot-tuple';
-import { PivotDataFieldDataTypeEnum, PivotErrorTypeEnum, PivotSubtotalTypeEnum } from './enum';
-export interface ITupleItem {
-    path: string[];
-    types: PivotDataFieldDataTypeEnum[];
-    tuple: IMeasureTupleItem;
-    indexes: number[];
-    summary?: Record<string, ITupleItemSummary>;
-}
-export interface ITPivotTupleInfo {
-    sum: number;
-    count: number;
-    countN: number;
-    product: number;
-    min: number;
-    max: number;
-    squareSum: number;
-}
-export interface IMeasureTupleItem {
-    [DataFieldId: string]: PivotTuple;
-}
-export type ITupleItemSummary = ITPivotTupleInfo & {
-    [subtotalType in PivotSubtotalTypeEnum]?: number | {
-        errorType: PivotErrorTypeEnum;
-    };
-};
-export interface IMeasuresMapItem {
-    field: DataField;
-    subTotal: PivotSubtotalTypeEnum[];
-}
-export interface IDimensionMapItem {
-    field: DataField;
-}
-export interface IPivotSummaryLevelPool {
-    [level: number]: IPivotSummaryLevelPoolItem[];
-}
-export interface IPivotSummaryLevelPoolItem {
-    v: number;
-    p: number;
-}