@univerjs/sheets 1.0.0-rc.0 → 1.0.0

package/lib/types/model/range-theme-util.d.ts

@@ -0,0 +1,113 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { IStyleData, Nullable } from '@univerjs/core';
+export type IRangeThemeStyleItem = Pick<IStyleData, 'bg' | 'ol' | 'bd' | 'cl' | 'ht' | 'vt' | 'bl'>;
+export interface IRangeThemeStyleJSON {
+    name: string;
+    wholeStyle?: IRangeThemeStyleItem;
+    headerRowStyle?: IRangeThemeStyleItem;
+    headerColumnStyle?: IRangeThemeStyleItem;
+    firstRowStyle?: IRangeThemeStyleItem;
+    secondRowStyle?: IRangeThemeStyleItem;
+    lastRowStyle?: IRangeThemeStyleItem;
+    firstColumnStyle?: IRangeThemeStyleItem;
+    secondColumnStyle?: IRangeThemeStyleItem;
+    lastColumnStyle?: IRangeThemeStyleItem;
+}
+export declare function composeStyles(styles: IStyleData[]): IRangeThemeStyleItem;
+/**
+ * Range theme style
+ * @description The range theme style is used to set the style of the range.This class is used to create a build-in theme style or a custom theme style.
+ */
+export declare class RangeThemeStyle {
+    private _name;
+    /**
+     * @property {Nullable<IRangeThemeStyleItem>} wholeStyle effect for the whole range.
+     */
+    wholeStyle: Nullable<IRangeThemeStyleItem>;
+    /**
+     * @property {Nullable<IRangeThemeStyleItem>} headerRowStyle effect for the header row.
+     */
+    headerRowStyle: Nullable<IRangeThemeStyleItem>;
+    /**
+     * @property {Nullable<IRangeThemeStyleItem>} headerColumnStyle effect for the header column.
+     */
+    headerColumnStyle: Nullable<IRangeThemeStyleItem>;
+    /**
+     * @property {Nullable<IRangeThemeStyleItem>} firstRowStyle effect for the first row.
+     */
+    firstRowStyle: Nullable<IRangeThemeStyleItem>;
+    /**
+     * @property {Nullable<IRangeThemeStyleItem>} secondRowStyle effect for the second row.
+     */
+    secondRowStyle: Nullable<IRangeThemeStyleItem>;
+    /**
+     * @property {Nullable<IRangeThemeStyleItem>} lastRowStyle effect for the last row.
+     */
+    lastRowStyle: Nullable<IRangeThemeStyleItem>;
+    /**
+     * @property {Nullable<IRangeThemeStyleItem>} firstColumnStyle effect for the first column.
+     */
+    firstColumnStyle: Nullable<IRangeThemeStyleItem>;
+    /**
+     * @property {Nullable<IRangeThemeStyleItem>} secondColumnStyle effect for the second column.
+     */
+    secondColumnStyle: Nullable<IRangeThemeStyleItem>;
+    /**
+     * @property {Nullable<IRangeThemeStyleItem>} lastColumnStyle effect for the last column.
+     */
+    lastColumnStyle: Nullable<IRangeThemeStyleItem>;
+    /**
+     * @property {Nullable<IRangeThemeStyleItem>} quickly get merge style
+     */
+    private _mergeCacheMap;
+    /**
+     * @constructor
+     * @param {string} name The name of the range theme style, it used to identify the range theme style.
+     * @param {IRangeThemeStyleJSON} [options] The options to initialize the range theme style.
+     */
+    constructor(name: string, options?: Omit<IRangeThemeStyleJSON, 'name'>);
+    /**
+     * Gets the name of the range theme style.The name is read only, and use to identifier the range theme style.
+     * @returns {string} The name of the range theme style.
+     */
+    getName(): string;
+    getWholeStyle(): Nullable<IRangeThemeStyleItem>;
+    setWholeStyle(style: Nullable<IRangeThemeStyleItem>): void;
+    getFirstRowStyle(): Nullable<IRangeThemeStyleItem>;
+    setFirstRowStyle(style: Nullable<IRangeThemeStyleItem>): void;
+    getSecondRowStyle(): Nullable<IRangeThemeStyleItem>;
+    setSecondRowStyle(style: Nullable<IRangeThemeStyleItem>): void;
+    getLastRowStyle(): Nullable<IRangeThemeStyleItem>;
+    setLastRowStyle(style: Nullable<IRangeThemeStyleItem>): void;
+    getFirstColumnStyle(): Nullable<IRangeThemeStyleItem>;
+    setFirstColumnStyle(style: Nullable<IRangeThemeStyleItem>): void;
+    getSecondColumnStyle(): Nullable<IRangeThemeStyleItem>;
+    setSecondColumnStyle(style: Nullable<IRangeThemeStyleItem>): void;
+    getLastColumnStyle(): Nullable<IRangeThemeStyleItem>;
+    setLastColumnStyle(style: Nullable<IRangeThemeStyleItem>): void;
+    getHeaderRowStyle(): Nullable<IRangeThemeStyleItem>;
+    setHeaderRowStyle(style: Nullable<IRangeThemeStyleItem>): void;
+    getHeaderColumnStyle(): Nullable<IRangeThemeStyleItem>;
+    setHeaderColumnStyle(style: Nullable<IRangeThemeStyleItem>): void;
+    getStyle(offsetRow: number, offsetCol: number, isLastRow: boolean, isLastCol: boolean, isToggled: boolean): IRangeThemeStyleItem | null;
+    private _getMergeStyle;
+    private _mergeStyle;
+    private _resetStyleCache;
+    toJson(): IRangeThemeStyleJSON;
+    fromJson(json: IRangeThemeStyleJSON): void;
+    dispose(): void;
+}

package/lib/types/model/range-themes/build-in-theme.factory.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { RangeThemeStyle } from '../range-theme-util';
+export declare const lightRangeThemeBuilder: (baseName: string, header: string, color: string) => RangeThemeStyle;
+export declare const middleRangeThemeBuilder: (baseName: string, rowHeader: string, colHeader: string) => RangeThemeStyle;
+export declare const darkRangeThemeBuilder: (baseName: string, rowHeader: string, firstRow: string, secondRow: string) => RangeThemeStyle;
+export declare const buildInThemes: RangeThemeStyle[];

package/lib/types/model/range-themes/default.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { RangeThemeStyle } from '../range-theme-util';
+export declare const defaultRangeThemeStyle: RangeThemeStyle;
+export declare const defaultRangeThemeStyleJSONWithLastRowStyle: RangeThemeStyle;

package/lib/types/model/zebra-crossing-cache.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { IRange } from '@univerjs/core';
+type IVisibleFunc = (row: number) => boolean;
+type IToggleRange = [number, number];
+/**
+ * This class is used for caching zebra crossing toggle ranges.
+ * `toggleRanges` represents the ranges within the visible area where the original odd/even row state is reversed due to hidden rows.
+ * Based on the following rules:
+ * 1. If there is an odd number of hidden rows before a certain row, the odd/even state of that row will be reversed.
+ * 2. If there is an even number of hidden rows before a certain row, the odd/even state of that row will not be reversed.
+ * 3. If there are no hidden rows before a certain row, the odd/even state of that row will not be reversed.
+ *
+ * Example:
+ * Given rows 1 to 10, where rows 3 and 7 are hidden:
+ * - Rows 1 and 2 remain in their original odd/even state.
+ * - Row 4's state is reversed because there is 1 hidden row (odd) before it.
+ * - Row 8's state is reversed because there are 2 hidden rows (even) before it.
+ * - Rows 9 and 10 remain in their original odd/even state.
+ */
+export declare class ZebraCrossingCache {
+    private _toggleRanges;
+    /**
+     * Refresh the cache based on the given range and visibility function.
+     * This method calculates toggle ranges for rows that are visible within the specified range.
+     * Hidden rows are excluded from the toggle calculation.
+     * @param range The range of rows to refresh (startRow and endRow are required).
+     * @param visibleFunc A function to determine if a row is visible.
+     */
+    refresh(range: IRange, visibleFunc: IVisibleFunc): void;
+    /**
+     * This function returns the toggle ranges. Only for testing purposes. In production, you should use `getIsToggled` to check if a row is toggled.
+     * @returns [IToggleRange[]] The toggle ranges calculated by the last refresh.
+     */
+    getToggleRanges(): IToggleRange[];
+    /**
+     * Check if the given row is toggled (odd/even state).
+     * This method uses binary search to efficiently determine if the row is within a toggle range.
+     * @param row The row to check.
+     * @returns True if the row is toggled (odd), false otherwise (even or hidden).
+     */
+    getIsToggled(row: number): boolean;
+}
+export {};

package/lib/types/services/auto-fill/tools.d.ts

@@ -45,6 +45,8 @@ declare function fillCopy(data: Array<Nullable<ICellData>>, len: number): {
     v: import("@univerjs/core").CellValue | null;
     t: CellValueType | null;
     f: string | null;
+    ft?: Nullable<import("@univerjs/core").FormulaType>;
+    fd?: Nullable<import("@univerjs/core").BooleanNumber>;
     ref?: Nullable<string>;
     xf?: Nullable<string>;
     si: string | null;