office-viewer 0.2.0 → 0.3.0

package/esm/excel/sheet/BuiltInNumFmt.js

@@ -0,0 +1,39 @@
+/**
+ * 内置 numfmt，来自 ssf.js，做了修改，主要是将 yy 都改成了 yyyy，不然太容易混淆了
+ */
+var BuiltInNumFmt = [];
+BuiltInNumFmt[0] = 'General';
+BuiltInNumFmt[1] = '0';
+BuiltInNumFmt[2] = '0.00';
+BuiltInNumFmt[3] = '#,##0';
+BuiltInNumFmt[4] = '#,##0.00';
+BuiltInNumFmt[9] = '0%';
+BuiltInNumFmt[10] = '0.00%';
+BuiltInNumFmt[11] = '0.00E+00';
+BuiltInNumFmt[12] = '# ?/?';
+BuiltInNumFmt[13] = '# ??/??';
+// 将原本的 yy 改成 yyyy 了，并换了顺序
+BuiltInNumFmt[14] = 'yyyy/m/d';
+// 将原本的 yy 改成 yyyy 了，并换了顺序
+BuiltInNumFmt[15] = 'yyyy-mmm-d';
+BuiltInNumFmt[16] = 'mmm-d';
+// 将原本的 yy 改成 yyyy 了，并换了顺序
+BuiltInNumFmt[17] = 'yyyy-mmm';
+BuiltInNumFmt[18] = 'h:mm AM/PM';
+BuiltInNumFmt[19] = 'h:mm:ss AM/PM';
+BuiltInNumFmt[20] = 'h:mm';
+BuiltInNumFmt[21] = 'h:mm:ss';
+// 将原本的 yy 改成 yyyy 了，并换了顺序
+BuiltInNumFmt[22] = 'yyyy/m/d h:mm';
+BuiltInNumFmt[37] = '#,##0 ;(#,##0)';
+BuiltInNumFmt[38] = '#,##0 ;[Red](#,##0)';
+BuiltInNumFmt[39] = '#,##0.00;(#,##0.00)';
+BuiltInNumFmt[40] = '#,##0.00;[Red](#,##0.00)';
+BuiltInNumFmt[45] = 'mm:ss';
+BuiltInNumFmt[46] = '[h]:mm:ss';
+BuiltInNumFmt[47] = 'mmss.0';
+BuiltInNumFmt[48] = '##0.0E+0';
+BuiltInNumFmt[49] = '@';
+BuiltInNumFmt[56] = '"上午/下午 "hh"時"mm"分"ss"秒 "';
+
+export { BuiltInNumFmt as default };

package/esm/excel/sheet/ColWidth.d.ts

@@ -0,0 +1,19 @@
+/**
+ * col 宽度相关的工具函数
+ */
+/**
+ * 用于根据字符数获取列宽
+ * @returns 返回宽度像素
+ */
+export declare function baseColWidth2px(colWidth: number, fontWidth: number): number;
+/**
+ * 根据列宽获取 px，这个减去 0.83203125 是 Excel 默认加的
+ * 这个计算方法可能不太准，还得进一步调研
+ * @param colWidth
+ * @returns 返回宽度像素
+ */
+export declare function colWidth2px(colWidth: number, fontWidth: number): number;
+/**
+ * 根据像素反算列宽
+ */
+export declare function px2colWidth(px: number, fontWidth: number): number;

package/esm/excel/sheet/ColWidth.js

@@ -0,0 +1,30 @@
+/**
+ * col 宽度相关的工具函数
+ */
+/**
+ * 用于根据字符数获取列宽
+ * @returns 返回宽度像素
+ */
+function baseColWidth2px(colWidth, fontWidth) {
+    // 文档（P.1685）里的说法是
+    // defaultColWidth = baseColumnWidth + {margin padding (2 pixels on each side, totalling 4 pixels)} + {gridline (1pixel)}
+    // 所以这里加 5
+    return colWidth * fontWidth + 5;
+}
+/**
+ * 根据列宽获取 px，这个减去 0.83203125 是 Excel 默认加的
+ * 这个计算方法可能不太准，还得进一步调研
+ * @param colWidth
+ * @returns 返回宽度像素
+ */
+function colWidth2px(colWidth, fontWidth) {
+    return baseColWidth2px(colWidth - 0.83203125, fontWidth);
+}
+/**
+ * 根据像素反算列宽
+ */
+function px2colWidth(px, fontWidth) {
+    return (px - 5) / fontWidth + 0.83203125;
+}
+
+export { baseColWidth2px, colWidth2px, px2colWidth };

package/esm/excel/sheet/ExcelRenderOptions.d.ts

@@ -0,0 +1,149 @@
+import { RenderOptions } from '../../RenderOptions';
+import { HitTestResult } from '../render/selection/hitTest';
+export interface RowColHeadersOptions {
+    /**
+     * 是否显示表头，这个会覆盖默认设置
+     */
+    showRowColHeaders: boolean;
+    /**
+     * 字体颜色
+     */
+    rowColHeadersColor: string;
+    /**
+     * 表头背景色
+     */
+    rowColHeadersBackgroundColor: string;
+    /**
+     * 表头线颜色
+     */
+    rowColHeadersLineColor: string;
+    /**
+     * 有隐藏内容时的字体颜色
+     */
+    hiddenRowColHeadersColor: string;
+    /**
+     * 有隐藏内容时的线颜色
+     */
+    hiddenRowColHeadersLineColor: string;
+    /**
+     * 有隐藏内容时的线大小
+     */
+    hiddenRowColHeadersLineSize: number;
+}
+export interface GridLineOptions {
+    /**
+     * 是否显示网格线
+     */
+    showGridLines?: boolean;
+    /**
+     * 网格线宽度
+     */
+    gridLineWidth?: number;
+    /**
+     * 网格线颜色
+     */
+    gridLineColor: string;
+    /**
+     * 拖动网格线时的颜色
+     */
+    dragGridLineColor: string;
+    /**
+     * 冻结线宽度
+     */
+    frozenLineWidth?: number;
+    /**
+     * 冻结线颜色
+     */
+    frozenLineColor: string;
+    /**
+     * 点击到线上的范围，当鼠标靠近这个距离内时，会认为点击到了线上
+     */
+    gridLineHitRange: number;
+}
+export interface SelectionOptions {
+    /**
+     * 选中的边框颜色
+     */
+    selectionBorderColor: string;
+    /**
+     * 选中区域右下角的方块大小
+     */
+    selectionSquareSize: number;
+    /**
+     * 选中区域的背景色
+     */
+    selectionBackgroundColor: string;
+    /**
+     * 选中区域的背景色透明度
+     */
+    selectionBackgroundOpacity: number;
+}
+export interface Debug {
+    /**
+     * 鼠标移动时的回调，主要用于调试
+     */
+    mousePositionTracker?: (x: number, y: number, hitTestResult: HitTestResult | null) => void;
+}
+export interface ExcelRenderOptions extends RenderOptions, RowColHeadersOptions, GridLineOptions, SelectionOptions, Debug {
+    /**
+     * 是否使用 web worker 避免解析时卡顿，默认不开启
+     */
+    useWorker?: boolean;
+    /**
+     * 是否加载时强制计算所有公式，这个在 workbook 的 calcPr 中也能配置
+     */
+    fullCalcOnLoad?: boolean;
+    /**
+     * 渲染宽度
+     */
+    width?: number;
+    /**
+     * 渲染高度
+     */
+    height?: number;
+    /**
+     * 语言，使用 http://www.rfc-editor.org/rfc/bcp/bcp47.txt，主要用于 numfmt
+     */
+    locale: string;
+    /**
+     * 缩放比例
+     */
+    scale?: number;
+    /**
+     * 单个缩进大小
+     */
+    indentSize: number;
+    /**
+     * 背景色
+     */
+    backgroundColor: string;
+    /**
+     * 单元格默认背景色
+     */
+    cellBackgroundColor: string;
+    /**
+     * 是否显示公式栏
+     */
+    showFormulaBar: boolean;
+    /**
+     * 是否显示 sheet 标签
+     */
+    showSheetTabBar: boolean;
+    /**
+     * 嵌入模式，在这个模式下滚动条滚到底部会出发继续滚动事件，滚动页面本身
+     */
+    embed: boolean;
+    /**
+     * 是否可编辑
+     */
+    editable: boolean;
+    /**
+     * 打印可以覆盖其它配置
+     */
+    printOptions?: ExcelRenderOptions;
+    printWaitTime?: number;
+    /**
+     * 字体 url，用于加载字体
+     */
+    fontURL: Record<string, string>;
+}

package/esm/excel/sheet/RangeCache.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 范围缓存，方便数据变化的时候自动清空
+ */
+import { RangeRef } from '../types/RangeRef';
+/**
+ * 范围的缓存 key
+ */
+export declare function rangeCacheKey(range: RangeRef): string;
+export declare function rangeCacheKeyToRange(key: string): {
+    startRow: number;
+    startCol: number;
+    endRow: number;
+    endCol: number;
+};
+export declare class RangeCache {
+    /**
+     * 缓存
+     */
+    private cache;
+    /**
+     * 设置缓存
+     */
+    set(ranges: RangeRef[], key: string, value: any): void;
+    /**
+     * 获取缓存
+     */
+    get(ranges: RangeRef[], key: string): any;
+    /**
+     * 清理相关缓存，会判断是否相交
+     */
+    clear(ranges: RangeRef[]): void;
+}

package/esm/excel/sheet/RangeCache.js

@@ -0,0 +1,99 @@
+import { __values, __read } from 'tslib';
+import { rangeIntersect } from '../io/excel/util/Range.js';
+
+/**
+ * 范围缓存，方便数据变化的时候自动清空
+ */
+/**
+ * 范围的缓存 key
+ */
+function rangeCacheKey(range) {
+    return "".concat(range.startRow, "-").concat(range.startCol, "-").concat(range.endRow, "-").concat(range.endCol);
+}
+function rangeCacheKeyToRange(key) {
+    var _a = __read(key.split('-'), 4), startRow = _a[0], startCol = _a[1], endRow = _a[2], endCol = _a[3];
+    return {
+        startRow: parseInt(startRow, 10),
+        startCol: parseInt(startCol, 10),
+        endRow: parseInt(endRow, 10),
+        endCol: parseInt(endCol, 10)
+    };
+}
+var RangeCache = /** @class */ (function () {
+    function RangeCache() {
+        /**
+         * 缓存
+         */
+        this.cache = new Map();
+    }
+    /**
+     * 设置缓存
+     */
+    RangeCache.prototype.set = function (ranges, key, value) {
+        var cacheKey = ranges.map(rangeCacheKey).join(' ');
+        if (!this.cache.has(cacheKey)) {
+            this.cache.set(cacheKey, new Map());
+        }
+        this.cache.get(cacheKey).set(key, value);
+    };
+    /**
+     * 获取缓存
+     */
+    RangeCache.prototype.get = function (ranges, key) {
+        var cacheKey = ranges.map(rangeCacheKey).join(' ');
+        if (this.cache.has(cacheKey)) {
+            return this.cache.get(cacheKey).get(key);
+        }
+        return null;
+    };
+    /**
+     * 清理相关缓存，会判断是否相交
+     */
+    RangeCache.prototype.clear = function (ranges) {
+        var e_1, _a, e_2, _b, e_3, _c;
+        try {
+            for (var ranges_1 = __values(ranges), ranges_1_1 = ranges_1.next(); !ranges_1_1.done; ranges_1_1 = ranges_1.next()) {
+                var range = ranges_1_1.value;
+                try {
+                    for (var _d = (e_2 = void 0, __values(this.cache.keys())), _e = _d.next(); !_e.done; _e = _d.next()) {
+                        var rangeKeys = _e.value;
+                        var cacheRanges = rangeKeys.split(' ').map(rangeCacheKeyToRange);
+                        try {
+                            for (var cacheRanges_1 = (e_3 = void 0, __values(cacheRanges)), cacheRanges_1_1 = cacheRanges_1.next(); !cacheRanges_1_1.done; cacheRanges_1_1 = cacheRanges_1.next()) {
+                                var cacheRange = cacheRanges_1_1.value;
+                                if (rangeIntersect(range, cacheRange)) {
+                                    this.cache.delete(rangeKeys);
+                                    break;
+                                }
+                            }
+                        }
+                        catch (e_3_1) { e_3 = { error: e_3_1 }; }
+                        finally {
+                            try {
+                                if (cacheRanges_1_1 && !cacheRanges_1_1.done && (_c = cacheRanges_1.return)) _c.call(cacheRanges_1);
+                            }
+                            finally { if (e_3) throw e_3.error; }
+                        }
+                    }
+                }
+                catch (e_2_1) { e_2 = { error: e_2_1 }; }
+                finally {
+                    try {
+                        if (_e && !_e.done && (_b = _d.return)) _b.call(_d);
+                    }
+                    finally { if (e_2) throw e_2.error; }
+                }
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (ranges_1_1 && !ranges_1_1.done && (_a = ranges_1.return)) _a.call(ranges_1);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+    };
+    return RangeCache;
+}());
+
+export { RangeCache, rangeCacheKey, rangeCacheKeyToRange };

package/esm/excel/sheet/RowFilter.d.ts

@@ -0,0 +1,3 @@
+/**
+ * 行过滤配置
+ */

package/esm/excel/sheet/Sheet.d.ts

@@ -0,0 +1,280 @@
+/**
+ * sheet 的相关操作及临时状态
+ */
+import type { ExcelRenderOptions } from '../sheet/ExcelRenderOptions';
+import { CT_AutoFilter, CT_SheetView } from '../../openxml/ExcelTypes';
+import type { Workbook } from '../Workbook';
+import { IDataProvider } from '../types/IDataProvider';
+import { FontSize } from '../types/FontSize';
+import { CellInfo } from '../types/CellInfo';
+import { ISheet } from '../types/ISheet';
+import { RangeRef } from '../types/RangeRef';
+import { CellData } from '../types/worksheet/CellData';
+import { ViewRange } from './ViewRange';
+import { FrozenViewRange } from '../render/cell/frozen/drawFrozen';
+import { HitTestResult } from '../render/selection/hitTest';
+import { SheetSelection } from '../render/selection/SheetSelection';
+import { Rect } from '../render/Rect';
+import { RangeCache } from './RangeCache';
+import { CellValue } from '../types/CellValue';
+import { AutoFilterIconUI } from '../render/autoFilter/AutoFilterIconUI';
+import { EnKeys } from '../lang/en_US';
+export type DisplayData = {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    row: number;
+    col: number;
+    value: CellData;
+    /**
+     * 是否需要清空
+     */
+    needClear: boolean;
+};
+export declare class Sheet {
+    /**
+     * 数据提供者
+     */
+    dataProvider: IDataProvider;
+    /**
+     * 当前的 sheet 的索引，根据这个来获取数据
+     */
+    private sheetIndex;
+    workbook: Workbook;
+    rangeCache: RangeCache;
+    /**
+     * 水平滚动条位置
+     */
+    private scrollLeft;
+    /**
+     * 垂直滚动条位置
+     */
+    private scrollTop;
+    /**
+     * 行高，这里只记录自定义的行高
+     */
+    customRowHeight: number[];
+    /**
+     * 列宽，这里只记录自定义的列宽
+     */
+    customColumnWidth: number[];
+    /**
+     * 渲染配置项
+     */
+    renderOptions: ExcelRenderOptions;
+    /**
+     * 表头的宽度，这个会随着滚动而变化，这里设置个初始值
+     */
+    rowHeaderWidth: number;
+    /**
+     * 表头的高度，这个是固定的，如果不显示
+     */
+    colHeaderHeight: number;
+    /**
+     * 缩放比例
+     */
+    private zoomLevel;
+    /**
+     * 选区
+     */
+    selection?: SheetSelection;
+    sheetData: ISheet;
+    private currentSheetView;
+    /**
+     * 内容及冻结区的访问，主要用于判断当前鼠标下是哪个单元格
+     */
+    private dataViewRange?;
+    private frozenViewRange?;
+    /**
+     * 默认字体大小，用于一些计算
+     */
+    defaultFontSize: FontSize;
+    /**
+     * 最新的 AutoFilterIcon 图标实例，主要用于关闭
+     */
+    private lastAutoFilterIcon?;
+    constructor(sheetIndex: number, dataProvider: IDataProvider, sheetData: ISheet, workbook: Workbook, renderOptions: ExcelRenderOptions);
+    handleChangeSelection(selection: SheetSelection): void;
+    getSheetName(): string;
+    /**
+     * 获取当前 sheet 的视图设置
+     */
+    getCurrentSheetView(): CT_SheetView;
+    getScrollLeft(): number;
+    setScrollLeft(scrollLeft: number): void;
+    updateViewRange(viewRange: ViewRange): void;
+    updateFrozenViewRange(viewRange: FrozenViewRange): void;
+    getViewRange(): ViewRange | undefined;
+    getFrozenViewRange(): FrozenViewRange | undefined;
+    /**
+     * 增量修改水平滚动条
+     */
+    deltaScrollLeft(delta: number): void;
+    getScrollTop(): number;
+    setScrollTop(scrollTop: number): void;
+    /**
+     * 增量修改垂直滚动条
+     */
+    deltaScrollTop(delta: number): void;
+    /**
+     * 判断当前坐标下是什么
+     * @param offsetX
+     * @param offsetY
+     * @returns
+     */
+    hitTest(offsetX: number, offsetY: number): HitTestResult | null;
+    /**
+     * 判断是否点到图形上
+     */
+    hitTestDrawing(offsetX: number, offsetY: number): HitTestResult | null;
+    /**
+     * 将绝对地址转成在视图内的相对地址
+     */
+    absolutePositionToRelativePosition(absolutePos: Rect): {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+    /**
+     * 是否显示网格线，如果没有设置就使用 sheet 里的设置
+     */
+    showGridLines(): boolean | undefined;
+    showRowColHeaders(): boolean | undefined;
+    /**
+     * 滚动时需要动态更新当前表的表头宽度
+     */
+    updateRowHeaderWidth(viewRange: ViewRange): void;
+    /**
+     * 获取表头的大小
+     */
+    getRowColSize(): {
+        rowHeaderWidth: number;
+        colHeaderHeight: number;
+    };
+    /**
+     * 获取范围内的数据
+     */
+    getCellValueByRange(range: RangeRef, includeHidden?: boolean): CellValue[];
+    /**
+     * 获取多个范围内的数据
+     */
+    getCellValueByRanges(ranges: RangeRef[], includeHidden?: boolean): CellValue[];
+    /**
+     * 返回可视区域的数据及位置信息
+     */
+    getViewPointData(viewRange: ViewRange): DisplayData[];
+    getSheetRowData(row: number): CellData[];
+    getRowHeight(row: number): number;
+    getColWidth(col: number): number;
+    getTotalWidth(): number;
+    getTotalHeight(): number;
+    /**
+     * 获取某个单元格的实际位置信息
+     * 如果这个单元格属于某个合并单元格，这里将返回合并单元格的位置信息
+     *
+     * @param x 单元格的 x 坐标
+     * @param y 单元格的 y 坐标
+     */
+    getCellDisplaySize(row: number, col: number, x: number, y: number): {
+        x: number;
+        y: number;
+        height: number;
+        width: number;
+    };
+    /**
+     * 获取最大行数
+     */
+    getMaxRow(): number;
+    /**
+     * 获取最大列数
+     */
+    getMaxCol(): number;
+    private rowPositionCache;
+    private colPositionCache;
+    /**
+     * 获取可视范围内的数据范围，这个包括没有数据的部分，这个函数的性能很关键
+     * @returns 从 0 开始的行和列
+     */
+    getViewPointRange(width: number, height: number): ViewRange;
+    getFrozenTopLeftViewPointRange(xSplit: number, ySplit: number): ViewRange;
+    getFrozenTopViewPointRange(ySplit: number, width: number): ViewRange;
+    getFrozenLeftViewPointRange(xSplit: number, height: number): ViewRange;
+    /**
+     * 获取单元格样式及数据
+     */
+    getCellInfo(row: number, col: number): CellInfo;
+    getCellData(row: number, col: number): CellData | undefined;
+    getCellValue(row: number, col: number): CellValue;
+    /**
+     * 获取某个单元格在渲染时的位置信息，这个方法可以获取到没在渲染区域内的单元格位置
+     */
+    getCellPosition(row: number, col: number): {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+    getMergeCells(): RangeRef[];
+    getSelection(): SheetSelection | undefined;
+    maxDrawingHeightAndWidthCache: {
+        height: number;
+        width: number;
+    } | null;
+    /**
+     * 获取最大 drawing 的高度和宽度，这个主要是为了滚动条计算
+     */
+    getMaxDrawingHeightAndWidth(): {
+        height: number;
+        width: number;
+    };
+    /**
+     * 判断是否是某个合并单元格
+     */
+    isMergeCell(mergeCell: RangeRef): boolean;
+    getDrawing(): import("../types/IDrawing").IDrawing | null;
+    /**
+     * 获取当前 sheet 的显示区域
+     */
+    getDisplayRect(): Rect;
+    /**
+     * 获取数据区域的显示区域
+     */
+    getDataDisplayRect(): Rect;
+    getZoomLevel(): number;
+    setZoomLevel(zoomLevel: number): void;
+    getIndex(): number;
+    getConditionalFormatting(): import("../../openxml/ExcelTypes").CT_ConditionalFormatting[];
+    getRangeCache(): RangeCache;
+    getWorkbook(): Workbook;
+    getExtLst(): import("../types/CT_ExtensionList").CT_ExtensionList | undefined;
+    getSparklineGroups(): import("../types/X14Sparkline/X14SparklineGroup").X14SparklineGroup[];
+    isHidden(): boolean;
+    getTableParts(): import("../../openxml/ExcelTypes").CT_Table[];
+    isRowHidden(row: number): boolean;
+    isColHidden(col: number): boolean;
+    getAutoFilter(): CT_AutoFilter | undefined;
+    getTables(): import("../../openxml/ExcelTypes").CT_Table[];
+    getLastAutoFilterIcon(): AutoFilterIconUI | undefined;
+    setLastAutoFilterIcon(autoFilterIcon: AutoFilterIconUI): void;
+    translate(key: EnKeys): string;
+    /**
+     * 同步 AutoFilter，当 AutoFilter 有变化的时候调用
+     */
+    syncAutoFilter(): void;
+    /**
+     * 应用单个 AutoFilter
+     */
+    applyAutoFilter(autoFilter: CT_AutoFilter, headerRowCount?: number): void;
+    getSheetPr(): import("../../openxml/ExcelTypes").CT_SheetPr | undefined;
+    getTabColor(): string;
+    updateCellValue(row: number, col: number, data: CellData): void;
+    /**
+     * 修改行高
+     * @param row
+     * @param height 行高，使用 px
+     */
+    setRowHeight(row: number, height: number): void;
+    setColWidth(col: number, width: number): void;
+}