@univerjs/sheets-ui/lib/types/services/auto-fill/type.d.ts

UniverSheet normal ui-plugin-sheets

import { Direction, IAccessor, ICellData, IMutationInfo, IObjectMatrixPrimitiveType, Nullable } from '@univerjs/core';
import { IDiscreteRange } from '../../controllers/utils/range-tools';
export declare enum AutoFillHookType {
    Append = "APPEND",
    Default = "DEFAULT",
    Only = "ONLY"
}
export interface IAutoFillLocation {
    source: IDiscreteRange;
    target: IDiscreteRange;
    unitId: string;
    subUnitId: string;
}
export interface ISheetAutoFillHook {
    id: string;
    priority?: number;
    type?: AutoFillHookType;
    bindUnit?: string;
    disable?: (location: IAutoFillLocation, direction: Direction, applyType: APPLY_TYPE) => boolean;
    onBeforeFillData?(location: IAutoFillLocation, direction: Direction): APPLY_TYPE | void;
    onFillData?(location: IAutoFillLocation, direction: Direction, applyType: APPLY_TYPE): {
        undos: IMutationInfo[];
        redos: IMutationInfo[];
    };
    onAfterFillData?(location: IAutoFillLocation, direction: Direction, applyType: APPLY_TYPE): boolean | void;
    onBeforeSubmit?: (location: IAutoFillLocation, direction: Direction, applyType: APPLY_TYPE, cellValue: IObjectMatrixPrimitiveType<Nullable<ICellData>>) => void;
}
export declare enum DATA_TYPE {
    NUMBER = "number",
    DATE = "date",
    EXTEND_NUMBER = "extendNumber",
    CHN_NUMBER = "chnNumber",
    CHN_WEEK2 = "chnWeek2",
    CHN_WEEK3 = "chnWeek3",
    LOOP_SERIES = "loopSeries",
    FORMULA = "formula",
    OTHER = "other"
}
export interface ICopyDataPiece {
    [key: string]: ICopyDataInType[];
}
export interface ICopyDataInType {
    data: Array<Nullable<ICellData>>;
    index: ICopyDataInTypeIndexInfo;
}
export type ICopyDataInTypeIndexInfo = number[];
export interface IAutoFillRule {
    type: string;
    match: (cellData: Nullable<ICellData>, accessor: IAccessor) => boolean;
    isContinue: (prev: IRuleConfirmedData, cur: Nullable<ICellData>) => boolean;
    applyFunctions?: APPLY_FUNCTIONS;
    priority: number;
}
export interface IMutations {
    redos: IMutationInfo[];
    undos: IMutationInfo[];
}
export interface IRuleConfirmedData {
    type?: string;
    cellData: Nullable<ICellData>;
}
export type APPLY_FUNCTIONS = {
    [key in APPLY_TYPE]?: (dataWithIndex: ICopyDataInType, len: number, direction: Direction, copyDataPiece: ICopyDataPiece, location?: IAutoFillLocation) => Array<Nullable<ICellData>>;
};
export declare enum APPLY_TYPE {
    COPY = "COPY",
    SERIES = "SERIES",
    ONLY_FORMAT = "ONLY_FORMAT",
    NO_FORMAT = "NO_FORMAT"
}