office-viewer 0.2.0 → 0.3.0

package/esm/excel/sheet/getViewRange.js

@@ -0,0 +1,193 @@
+import { __values } from 'tslib';
+
+/**
+ * 使用二分查找第一个大于等于目标值的索引，也就是在某个偏移量下能看到的第一个单元格
+ * @param rangeCache
+ * @param target
+ * @returns
+ */
+function findStartInCache(rangeCache, target) {
+    var start = 0, end = rangeCache.length - 1;
+    var found = -1;
+    while (start < end) {
+        var mid = Math.floor((start + end) / 2);
+        var indexInfo = rangeCache[mid];
+        // 找不到说明 bug 了
+        if (!indexInfo) {
+            console.error('findStartInCache indexInfo is undefined');
+            break;
+        }
+        var indexRange = indexInfo.offset + indexInfo.size;
+        if (indexRange === target) {
+            found = mid;
+            break;
+        }
+        else if (indexRange < target) {
+            start = mid + 1;
+        }
+        else {
+            end = mid;
+        }
+    }
+    if (found !== -1) {
+        return found;
+    }
+    else {
+        return start;
+    }
+}
+/**
+ * 获取范围内的索引列表
+ * @param offset 滚动条偏移
+ * @param shift 表头导致的偏移
+ * @param totalLength 总长度
+ * @param getHeight 获取长度的方法
+ * @param hiddenRange 隐藏的范围
+ * @param rangeCache 位置信息缓存
+ * @returns
+ */
+function getRange(offset, shift, totalLength, getHeight, hiddenRange, rangeCache) {
+    var e_1, _a;
+    if (hiddenRange === void 0) { hiddenRange = []; }
+    if (rangeCache === void 0) { rangeCache = []; }
+    // 从零开始遍历直到找到
+    var foundStart = false;
+    var foundEnd = false;
+    var index = 0;
+    var startOffset = 0;
+    var currentOffset = 0;
+    // 这些都不能为 undefined，避免后面计算死循环
+    offset = offset || 0;
+    totalLength = totalLength || 0;
+    var indexes = [];
+    var sizes = [];
+    var MAX_LOOP = 10000;
+    var loop = 0;
+    if (rangeCache.length) {
+        var lastRangeCache = rangeCache[rangeCache.length - 1];
+        if (lastRangeCache.offset < offset) {
+            index = rangeCache.length;
+            currentOffset = lastRangeCache.offset;
+        }
+        else {
+            var foundIndex = findStartInCache(rangeCache, offset);
+            // 这时肯定有找到，为 -1 基本上是 bug
+            if (foundIndex !== -1) {
+                index = foundIndex;
+                currentOffset = rangeCache[index].offset;
+            }
+        }
+    }
+    while (!(foundStart && foundEnd)) {
+        try {
+            // 如果有隐藏列就直接跳到下一个不隐藏的列，避免很大隐藏列导致性能卡顿
+            for (var hiddenRange_1 = (e_1 = void 0, __values(hiddenRange)), hiddenRange_1_1 = hiddenRange_1.next(); !hiddenRange_1_1.done; hiddenRange_1_1 = hiddenRange_1.next()) {
+                var range = hiddenRange_1_1.value;
+                if (index >= range.min && index <= range.max) {
+                    index = range.max + 1;
+                    // 将索引信息加入到缓存中，只处理一次
+                    if (range.max > rangeCache.length - 1) {
+                        for (var i = range.min; i <= range.max; i++) {
+                            rangeCache[i] = {
+                                offset: currentOffset,
+                                size: 0
+                            };
+                        }
+                    }
+                    continue;
+                }
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (hiddenRange_1_1 && !hiddenRange_1_1.done && (_a = hiddenRange_1.return)) _a.call(hiddenRange_1);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        var cellLength = getHeight(index) || 0;
+        rangeCache[index] = {
+            offset: currentOffset,
+            size: cellLength
+        };
+        // 第一次大于 offset 就找到了开始位置
+        if (currentOffset + cellLength >= offset && !foundStart) {
+            startOffset = currentOffset - offset;
+            foundStart = true;
+            indexes.push(index);
+            sizes.push({
+                size: cellLength,
+                offset: currentOffset - offset + shift
+            });
+            currentOffset += cellLength;
+            index = index + 1;
+            continue;
+        }
+        // 第一次大于结束位置就找到了结束位置
+        if (currentOffset + cellLength >= offset + totalLength && !foundEnd) {
+            foundEnd = true;
+            indexes.push(index);
+            sizes.push({
+                size: cellLength,
+                offset: currentOffset - offset + shift
+            });
+        }
+        // 中间节点
+        if (foundStart && !foundEnd) {
+            indexes.push(index);
+            sizes.push({
+                size: cellLength,
+                offset: currentOffset - offset + shift
+            });
+        }
+        currentOffset += cellLength;
+        // 避免是死循环
+        if (loop++ > MAX_LOOP) {
+            console.error('getRange loop too many times');
+            break;
+        }
+        index = index + 1;
+    }
+    return {
+        indexes: indexes,
+        sizes: sizes,
+        startOffset: startOffset,
+        length: totalLength + shift
+    };
+}
+/**
+ * 获取视口范围的单元格区域，拆分单独函数是为了方便单元测试，这部分逻辑不需要依赖 UI 展现
+ *
+ * @param scrollLeft 水平滚动条
+ * @param scrollTop 垂直滚动条
+ * @param leftShift 左偏移量，主要是表头导致的偏移量
+ * @param topShift 上偏移量，主要是表头导致的偏移量
+ * @param height 窗口高度
+ * @param width 窗口宽度
+ * @param defaultRowHeight 行默认高度
+ * @param defaultColWidth 列默认宽度
+ * @param customRowHeight 自定义行高
+ * @param customColWidth 自定义列宽
+ *
+ * @returns 从 0 开始的行和列，以及初始的坐标
+ */
+function getViewRange(scrollLeft, scrollTop, leftShift, topShift, height, width, getRowHeight, rowPositionCache, getColWidth, colPositionCache, colHiddenRange) {
+    if (rowPositionCache === void 0) { rowPositionCache = []; }
+    if (colPositionCache === void 0) { colPositionCache = []; }
+    if (colHiddenRange === void 0) { colHiddenRange = []; }
+    var _a = getRange(scrollTop, topShift, height, getRowHeight, [], rowPositionCache), rows = _a.indexes, startRowOffset = _a.startOffset, rowSizes = _a.sizes;
+    var _b = getRange(scrollLeft, leftShift, width, getColWidth, colHiddenRange, colPositionCache), cols = _b.indexes, startColOffset = _b.startOffset, colSizes = _b.sizes;
+    return {
+        region: 'normal',
+        rows: rows,
+        rowSizes: rowSizes,
+        height: height,
+        startRowOffset: startRowOffset,
+        cols: cols,
+        colSizes: colSizes,
+        width: width,
+        startColOffset: startColOffset
+    };
+}
+
+export { findStartInCache, getRange, getViewRange };

package/esm/excel/sheet/table/__test__/calcTableRelativePosition.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/excel/sheet/table/applyTableStyle.d.ts

@@ -0,0 +1,5 @@
+import { CT_Table } from '../../../openxml/ExcelTypes';
+import { CellInfo } from '../../types/CellInfo';
+import { RangeRef } from '../../types/RangeRef';
+import { Sheet } from '../Sheet';
+export declare function applyTableStyle(cellInfo: CellInfo, tablePart: CT_Table, ref: RangeRef, sheet: Sheet, row: number, col: number): void;

package/esm/excel/sheet/table/applyTableStyle.js

@@ -0,0 +1,87 @@
+import { presetTableStyles } from '../../io/excel/preset/presetTableStyles.js';
+import { applyDxf } from '../applyDxf.js';
+import { buildTableStyle } from './buildTableStyle.js';
+import { calcTableRelativePosition } from './calcTableRelativePosition.js';
+
+function applyTableStyle(cellInfo, tablePart, ref, sheet, row, col) {
+    var _a;
+    var headerRowCount = (_a = tablePart.headerRowCount) !== null && _a !== void 0 ? _a : 1;
+    var totalsRowShown = tablePart.totalsRowShown || true;
+    var totalsRowCount = tablePart.totalsRowCount || 0;
+    // 这是来自 MS-OI29500 P291 的说明，如果 totalsRowCount 为 0，那么 totalsRowShown 必须为 true
+    if (totalsRowCount > 0) {
+        totalsRowShown = true;
+    }
+    var tableStyleInfo = tablePart.tableStyleInfo;
+    if (!tableStyleInfo) {
+        console.warn('表格缺少 tableStyleInfo 字段', tablePart);
+        return;
+    }
+    var name = tableStyleInfo.name;
+    // 表格名称
+    if (!name) {
+        console.warn('表格缺少 name 字段', tablePart);
+        return;
+    }
+    var tableStyle = presetTableStyles[name];
+    if (!tableStyle) {
+        console.warn('未知的表格样式', name);
+        return;
+    }
+    var tablePosition = calcTableRelativePosition(ref, function (r) { return sheet.isRowHidden(r); }, function (c) { return sheet.isColHidden(c); }, row, col, headerRowCount, totalsRowCount, totalsRowShown);
+    var showFirstColumn = tableStyleInfo.showFirstColumn || false;
+    var showLastColumn = tableStyleInfo.showLastColumn || false;
+    var showRowStripes = tableStyleInfo.showRowStripes || false;
+    var showColumnStripes = tableStyleInfo.showColumnStripes || false;
+    var dxfs = tableStyle.dxfs.dxf || [];
+    var tableStyles = buildTableStyle(tableStyle);
+    if (tableStyles.wholeTable !== undefined) {
+        applyDxf(cellInfo, dxfs[tableStyles.wholeTable]);
+    }
+    if (showRowStripes &&
+        tablePosition.rowType === 'odd' &&
+        tableStyles.firstRowStripe !== undefined) {
+        applyDxf(cellInfo, dxfs[tableStyles.firstRowStripe]);
+    }
+    if (showColumnStripes &&
+        tablePosition.colType === 'odd' &&
+        tableStyles.firstColumnStripe !== undefined) {
+        applyDxf(cellInfo, dxfs[tableStyles.firstColumnStripe]);
+    }
+    if (tablePosition.rowType === 'header' &&
+        tableStyles.headerRow !== undefined) {
+        applyDxf(cellInfo, dxfs[tableStyles.headerRow]);
+    }
+    if (tablePosition.rowType === 'total' && tableStyles.totalRow !== undefined) {
+        applyDxf(cellInfo, dxfs[tableStyles.totalRow]);
+    }
+    if (showFirstColumn &&
+        tablePosition.colPosition === 'first' &&
+        tableStyles.firstColumn !== undefined) {
+        applyDxf(cellInfo, dxfs[tableStyles.firstColumn]);
+    }
+    if (showLastColumn &&
+        tablePosition.colPosition === 'last' &&
+        tableStyles.lastColumn !== undefined) {
+        applyDxf(cellInfo, dxfs[tableStyles.lastColumn]);
+    }
+    // 表格内部添加默认白色分隔线，目前不知道这样做是否正确
+    if (!cellInfo.border) {
+        cellInfo.border = {
+            bottom: {
+                color: {
+                    rgb: 'FFFFFFFF'
+                },
+                style: 'thin'
+            },
+            right: {
+                color: {
+                    rgb: 'FFFFFFFF'
+                },
+                style: 'thin'
+            }
+        };
+    }
+}
+
+export { applyTableStyle };

package/esm/excel/sheet/table/buildTableStyle.d.ts

@@ -0,0 +1,13 @@
+import { TableStyleDef } from '../../types/TableStyleDef';
+/**
+ * 构建演示表，这个主要原因是样式应用有顺序要求，所以先构建为对象格式
+ */
+export declare function buildTableStyle(tableStyle: TableStyleDef): {
+    wholeTable: number | undefined;
+    headerRow: number | undefined;
+    firstRowStripe: number | undefined;
+    firstColumnStripe: number | undefined;
+    totalRow: number | undefined;
+    firstColumn: number | undefined;
+    lastColumn: number | undefined;
+};

package/esm/excel/sheet/table/buildTableStyle.js

@@ -0,0 +1,68 @@
+import { __values } from 'tslib';
+
+/**
+ * 构建演示表，这个主要原因是样式应用有顺序要求，所以先构建为对象格式
+ */
+function buildTableStyle(tableStyle) {
+    var e_1, _a;
+    var _b, _c, _d;
+    var wholeTable;
+    var headerRow;
+    var firstRowStripe;
+    var firstColumnStripe;
+    var totalRow;
+    var firstColumn;
+    var lastColumn;
+    try {
+        for (var _e = __values(((_c = (_b = tableStyle.tableStyles.tableStyle) === null || _b === void 0 ? void 0 : _b[0]) === null || _c === void 0 ? void 0 : _c.tableStyleElement) || []), _f = _e.next(); !_f.done; _f = _e.next()) {
+            var tableStyleElement = _f.value;
+            var type = tableStyleElement.type;
+            var dxfId = (_d = tableStyleElement.dxfId) !== null && _d !== void 0 ? _d : 1;
+            // 文档里说是从 0 开始，但其实是从 1 开始
+            dxfId = dxfId - 1;
+            switch (type) {
+                case 'wholeTable':
+                    wholeTable = dxfId;
+                    break;
+                case 'headerRow':
+                    headerRow = dxfId;
+                    break;
+                case 'firstRowStripe':
+                    firstRowStripe = dxfId;
+                    break;
+                case 'firstColumnStripe':
+                    firstColumnStripe = dxfId;
+                    break;
+                case 'totalRow':
+                    totalRow = dxfId;
+                    break;
+                case 'firstColumn':
+                    firstColumn = dxfId;
+                    break;
+                case 'lastColumn':
+                    lastColumn = dxfId;
+                    break;
+                default:
+                    break;
+            }
+        }
+    }
+    catch (e_1_1) { e_1 = { error: e_1_1 }; }
+    finally {
+        try {
+            if (_f && !_f.done && (_a = _e.return)) _a.call(_e);
+        }
+        finally { if (e_1) throw e_1.error; }
+    }
+    return {
+        wholeTable: wholeTable,
+        headerRow: headerRow,
+        firstRowStripe: firstRowStripe,
+        firstColumnStripe: firstColumnStripe,
+        totalRow: totalRow,
+        firstColumn: firstColumn,
+        lastColumn: lastColumn
+    };
+}
+
+export { buildTableStyle };

package/esm/excel/sheet/table/calcTableRelativePosition.d.ts

@@ -0,0 +1,11 @@
+import { RangeRef } from '../../types/RangeRef';
+export type RelationPosition = {
+    rowType: 'header' | 'odd' | 'even' | 'total';
+    colType: 'odd' | 'even';
+    rowPosition: 'header' | 'first' | 'last' | 'middle' | 'total';
+    colPosition: 'first' | 'last' | 'middle';
+};
+/**
+ * 计算出这个位置相对于表格区域的位置，这个可以缓存的，但先不优化
+ */
+export declare function calcTableRelativePosition(tableRange: RangeRef, isRowHidden: (rowIndex: number) => boolean, isColHidden: (colIndex: number) => boolean, row: number, col: number, headerRowCount: number, totalsRowCount: number, totalsRowShown: boolean): RelationPosition;

package/esm/excel/sheet/table/calcTableRelativePosition.js

@@ -0,0 +1,90 @@
+/**
+ * 计算出这个位置相对于表格区域的位置，这个可以缓存的，但先不优化
+ */
+function calcTableRelativePosition(tableRange, isRowHidden, isColHidden, row, col, headerRowCount, totalsRowCount, totalsRowShown) {
+    var rowType = undefined;
+    var colType = undefined;
+    var rowPosition = 'middle';
+    var colPosition = 'middle';
+    // 总行数
+    var rowCount = 0;
+    // 当前行在表格中的相对位置，这个是包含表头的
+    var relativeRow = 0;
+    for (var rowIndex = tableRange.startRow; rowIndex <= tableRange.endRow; rowIndex++) {
+        if (!isRowHidden(rowIndex)) {
+            rowCount++;
+        }
+        if (rowIndex === row) {
+            relativeRow = rowCount - 1;
+        }
+    }
+    // 当前行在表格中的相对位置，这个是去掉表头的
+    var relativeRowWithoutHeader = relativeRow;
+    if (headerRowCount > 0) {
+        relativeRowWithoutHeader = relativeRowWithoutHeader - headerRowCount;
+    }
+    if (relativeRowWithoutHeader % 2 === 0) {
+        rowType = 'odd';
+    }
+    else {
+        rowType = 'even';
+    }
+    if (relativeRowWithoutHeader === 0) {
+        rowPosition = 'first';
+    }
+    if (headerRowCount && relativeRow < headerRowCount) {
+        rowPosition = 'header';
+        rowType = 'header';
+    }
+    if (relativeRowWithoutHeader ===
+        rowCount - headerRowCount - totalsRowCount - 1) {
+        rowPosition = 'last';
+    }
+    if (totalsRowShown) {
+        if (relativeRowWithoutHeader >=
+            rowCount - headerRowCount - totalsRowCount) {
+            rowType = 'total';
+            rowPosition = 'total';
+        }
+    }
+    // 总列数
+    var colCount = 0;
+    // 当前列在表格中的相对位置
+    var relativeCol = 0;
+    for (var colIndex = tableRange.startCol; colIndex <= tableRange.endCol; colIndex++) {
+        if (!isColHidden(colIndex)) {
+            colCount++;
+        }
+        if (colIndex === col) {
+            relativeCol = colCount - 1;
+        }
+    }
+    if (relativeCol % 2 === 0) {
+        colType = 'odd';
+    }
+    else {
+        colType = 'even';
+    }
+    if (relativeCol === 0) {
+        colPosition = 'first';
+    }
+    if (relativeCol === colCount - 1) {
+        colPosition = 'last';
+    }
+    if (rowType === undefined) {
+        console.warn('calcRelativeType error', row, col, tableRange);
+        rowType = 'odd';
+    }
+    if (colType === undefined) {
+        console.warn('calcRelativeType error', row, col, tableRange);
+        colType = 'odd';
+    }
+    return {
+        rowType: rowType,
+        colType: colType,
+        rowPosition: rowPosition,
+        colPosition: colPosition
+    };
+}
+
+export { calcTableRelativePosition };

package/esm/excel/types/CT_Color.d.ts

@@ -0,0 +1,9 @@
+import { Attributes } from '../../openxml/Attributes';
+export interface CT_Color {
+    auto?: boolean;
+    indexed?: number;
+    rgb?: string;
+    theme?: number;
+    tint?: number;
+}
+export declare const CT_Color_Attributes: Attributes;

package/esm/excel/types/CT_Color.js

@@ -0,0 +1,20 @@
+var CT_Color_Attributes = {
+    auto: {
+        type: 'boolean'
+    },
+    indexed: {
+        type: 'int'
+    },
+    rgb: {
+        type: 'string'
+    },
+    theme: {
+        type: 'int'
+    },
+    tint: {
+        type: 'double',
+        defaultValue: '0.0'
+    }
+};
+
+export { CT_Color_Attributes };

package/esm/excel/types/CT_ExtensionList.d.ts

@@ -0,0 +1,6 @@
+import { Attributes } from '../../openxml/Attributes';
+import { Ext } from './Ext';
+export type CT_ExtensionList = {
+    ext?: Ext[];
+};
+export declare const CT_ExtensionList_Attributes: Attributes;

package/esm/excel/types/CT_ExtensionList.js

@@ -0,0 +1,11 @@
+import { Ext_Attributes } from './Ext.js';
+
+var CT_ExtensionList_Attributes = {
+    ext: {
+        type: 'child',
+        childAttributes: Ext_Attributes,
+        childIsArray: true
+    }
+};
+
+export { CT_ExtensionList_Attributes };

package/esm/excel/types/CT_Theme.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 补充了 clrSchemes 方便查找
+ */
+import { CT_BaseStyles, CT_Color, CT_ColorSchemeList, CT_CustomColorList, CT_ObjectStyleDefaults, CT_OfficeArtExtensionList, CT_OfficeStyleSheet } from '../../openxml/DMLTypes';
+export interface CT_Theme extends CT_OfficeStyleSheet {
+    themeElements?: CT_MyBaseStyles;
+    objectDefaults?: CT_ObjectStyleDefaults;
+    extraClrSchemeLst?: CT_ColorSchemeList;
+    custClrLst?: CT_CustomColorList;
+    extLst?: CT_OfficeArtExtensionList;
+    name?: string;
+}
+export interface CT_MyBaseStyles extends CT_BaseStyles {
+    clrSchemes?: CT_Color[];
+}

package/esm/excel/types/CellInfo.d.ts

@@ -0,0 +1,57 @@
+import { CT_Border, CT_CellAlignment, CT_Fill, CT_Font } from '../../openxml/ExcelTypes';
+import { CellData } from './worksheet/CellData';
+import { DataBarDisplay } from './DataBarDisplay';
+import { IconNames } from '../io/excel/preset/presetIcons';
+/**
+ * 单元格信息，主要是用于展现
+ */
+export interface CellInfo {
+    /**
+     * 行号
+     */
+    row: number;
+    /**
+     * 列号
+     */
+    col: number;
+    /**
+     * 字体
+     */
+    font: CT_Font;
+    /**
+     * 背景色
+     */
+    fill?: CT_Fill;
+    /**
+     * 边框
+     */
+    border?: CT_Border;
+    /**
+     * 最终展现的文本
+     */
+    text: string;
+    /**
+     * 文本对齐方式
+     */
+    alignment?: CT_CellAlignment;
+    /**
+     * dataBar 展现配置
+     */
+    dataBarDisplay?: DataBarDisplay;
+    /**
+     * 图标，用于 iconSet
+     */
+    icon?: IconNames;
+    /**
+     * 原始值，可能是空字符串
+     */
+    value: string;
+    /**
+     * 原始数据
+     */
+    cellData: CellData;
+    /**
+     * 是否需要裁剪，这个用来支持自动裁剪，参考 autoClip.ts
+     */
+    needClip?: boolean;
+}

package/esm/excel/types/CellValue.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 单元格的值
+ */
+export type CellValue = {
+    row: number;
+    col: number;
+    /**
+     * 单元格最终展现的文本
+     */
+    text: string;
+    value: string;
+    color?: string;
+    isDate?: boolean;
+};

package/esm/excel/types/DataBarDisplay.d.ts

@@ -0,0 +1,58 @@
+/**
+ * data bar 的展现定义，用于渲染时的绘制
+ */
+import { X14DataBar } from './X14CF/X14DataBar';
+export type DataBarDisplay = {
+    /**
+     * 是否显示数值
+     */
+    showValue: boolean;
+    /**
+     * 百分比，可能是负数
+     */
+    percent: number;
+    /**
+     * 展现的颜色
+     */
+    color: string;
+    /**
+     * 是否有边框
+     */
+    border: boolean;
+    /**
+     * 是否渐变
+     */
+    gradient: boolean;
+    /**
+     * 渐变颜色
+     */
+    colorGradient: string;
+    /**
+     * 边框颜色
+     */
+    borderColor: string;
+    /**
+     * 负数的填充颜色
+     */
+    negativeFillColor: string;
+    /**
+     * 负数的填充渐变颜色
+     */
+    negativeFillColorGradient: string;
+    /**
+     * 负数的边框颜色
+     */
+    negativeBorderColor: string;
+    /**
+     * 坐标轴颜色
+     */
+    axisColor: string;
+    /**
+     * 方向
+     */
+    direction: X14DataBar['direction'];
+    /**
+     * 是否双向显示，左边是负数，右边是正数
+     */
+    biDirectional: boolean;
+};

package/esm/excel/types/ExcelFile.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Excel 文件定义主入口，包括所有相关文件
+ */
+import { ContentTypes } from '../../openxml/ContentType';
+import { IWorkbook } from './IWorkbook';
+export interface ExcelFile {
+    /**
+     * [Content_Types].xml，暂时不详细解析
+     */
+    contentTypes: ContentTypes;
+    workbook: IWorkbook;
+}