office-viewer 0.2.1 → 0.3.0

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

@@ -0,0 +1,10 @@
+import { Attributes } from '../../openxml/Attributes';
+import { X14ConditionalFormattings } from './X14CF/X14ConditionalFormattings';
+import { X14SparklineGroups } from './X14Sparkline/X14SparklineGroups';
+export type Ext = {
+    'uri'?: string;
+    'x14:id'?: string;
+    'x14:conditionalFormattings'?: X14ConditionalFormattings;
+    'x14:sparklineGroups'?: X14SparklineGroups;
+};
+export declare const Ext_Attributes: Attributes;

package/esm/excel/types/Ext.js

@@ -0,0 +1,21 @@
+import { X14ConditionalFormattings_Attributes } from './X14CF/X14ConditionalFormattings.js';
+import { X14SparklineGroups_Attributes } from './X14Sparkline/X14SparklineGroups.js';
+
+var Ext_Attributes = {
+    'uri': {
+        type: 'string'
+    },
+    'x14:id': {
+        type: 'child-string'
+    },
+    'x14:conditionalFormattings': {
+        type: 'child',
+        childAttributes: X14ConditionalFormattings_Attributes
+    },
+    'x14:sparklineGroups': {
+        type: 'child',
+        childAttributes: X14SparklineGroups_Attributes
+    }
+};
+
+export { Ext_Attributes };

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

@@ -0,0 +1,7 @@
+/**
+ * 字体大小
+ */
+export interface FontSize {
+    width: number;
+    height: number;
+}

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

@@ -0,0 +1,16 @@
+import { ST_UnderlineValues } from '../../openxml/ExcelTypes';
+/**
+ * 解析后的各种字体信息，为了方便渲染做了简化，而且保证值是有效的，内部通常用这个而不是 CT_Font
+ */
+export interface FontStyle {
+    family: string;
+    size: number;
+    color: string;
+    b: boolean;
+    i: boolean;
+    strike: boolean;
+    outline: boolean;
+    shadow: boolean;
+    u: ST_UnderlineValues;
+    condense: boolean;
+}

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

@@ -0,0 +1,7 @@
+import { CT_ChartSpace } from '../../openxml/ChartTypes';
+export type IChartSpace = CT_ChartSpace & {
+    /**
+     * 图表全局 id，这个是为了渲染的时候标识是哪个图表
+     */
+    gid: string;
+};

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

@@ -0,0 +1,158 @@
+import { CT_Color, CT_ConditionalFormatting, CT_Dxf, CT_Font } from '../../openxml/ExcelTypes';
+import { HiddenRange } from '../sheet/getViewRange';
+import { CellInfo } from './CellInfo';
+import { CellValue } from './CellValue';
+import { FontSize } from './FontSize';
+import { FontStyle } from './FontStyle';
+import { IDrawing } from './IDrawing';
+import { ISheet } from './ISheet';
+import { RangeRef } from './RangeRef';
+import { CellData } from './worksheet/CellData';
+/**
+ * 数据获取方法，所有数据获取都通过这个方法调用
+ */
+export interface IDataProvider {
+    /**
+     * 获取指定行的数据
+     * @param sheetIndex 表索引，从 0 开始
+     * @param row，行索引，从 0 开始
+     */
+    getSheetRowData(sheetIndex: number, row: number): CellData[];
+    /**
+     * 获取指定单元格的数据
+     * @param sheetIndex
+     * @param row
+     * @param col
+     */
+    getCellData(sheetIndex: number, row: number, col: number): CellData | undefined;
+    /**
+     * 更新单元格信息
+     * @param sheetIndex
+     * @param row
+     * @param col
+     * @param data
+     */
+    updateCellData(sheetIndex: number, row: number, col: number, data: CellData): void;
+    /**
+     * 获取指定行的行高，理论上这里应该用异步
+     * @param sheetIndex
+     * @param row
+     */
+    getRowHeight(sheetIndex: number, row: number): number;
+    /**
+     * 获取指定列宽，这个一开始就能确定
+     * @param sheetIndex
+     * @param col
+     */
+    getColWidth(sheetIndex: number, col: number): number;
+    /**
+     * 获取隐藏的列范围
+     */
+    getColHiddenRange(sheetIndex: number): HiddenRange[];
+    /**
+     * 获取最大行数
+     */
+    getMaxRow(sheetIndex: number): number;
+    /**
+     * 当前行是否隐藏
+     */
+    isRowHidden(sheetIndex: number, row: number): boolean;
+    /**
+     * 当前列是否隐藏
+     */
+    isColHidden(sheetIndex: number, col: number): boolean;
+    /**
+     * 获取表的中数据高度，这个可能会返回预估值
+     * @param sheetIndex 表索引
+     */
+    getTotalHeight(sheetIndex: number): number;
+    /**
+     * 获取最大列数
+     */
+    getMaxCol(sheetIndex: number): number;
+    /**
+     * 获取表的中数据宽度，这个可能会返回预估值
+     * @param sheetIndex 表索引
+     */
+    getTotalWidth(sheetIndex: number): number;
+    /**
+     * 获取所有表
+     */
+    getSheets(): ISheet[];
+    /**
+     * 根据索引获取表
+     * @param sheetIndex
+     */
+    getSheetByIndex(sheetIndex: number): ISheet | undefined;
+    /**
+     * 根据名称获取表
+     * @param sheetName
+     */
+    getSheetByName(sheetName: string): ISheet | undefined;
+    /**
+     * 获取单元格的样式及数据
+     */
+    getCellInfo(sheetIndex: number, row: number, col: number): CellInfo;
+    /**
+     * 获取单元格的数据，这里仅返回数据，不包含样式
+     */
+    getCellValue(sheetIndex: number, row: number, col: number): CellValue;
+    /**
+     * 获取范围内的数据
+     * @param includeHidden 是否包含隐藏的单元格
+     */
+    getCellValueByRange(sheetIndex: number, range: RangeRef, includeHidden: boolean): CellValue[];
+    /**
+     * 查找文本
+     */
+    searchText(sheetIndex: number, text: string): CellValue[];
+    /**
+     * 获取最终颜色
+     */
+    getColor(color?: CT_Color, defaultColor?: string): string | 'none';
+    /**
+     * 获取默认字体大小
+     */
+    getDefaultFontSize(): FontSize;
+    /**
+     * 获取默认字体
+     */
+    getDefaultFontStyle(): FontStyle;
+    /**
+     * 获取合并单元格的配置
+     */
+    getMergeCells(sheetIndex: number): RangeRef[];
+    /**
+     * 获取图片
+     */
+    getDrawing(sheetIndex: number): IDrawing | null;
+    /**
+     * 获取条件格式
+     */
+    getConditionalFormatting(sheetIndex: number): CT_ConditionalFormatting[];
+    /**
+     * 获取 dxf 样式定义
+     */
+    getDxf(index: number): CT_Dxf | null;
+    /**
+     * TODO: 这个接口不应该暴露出来，CSV 不需要这个
+     */
+    getFontStyle(font?: CT_Font): FontStyle;
+    /**
+     * 是否是 1904 日期系统
+     * https://support.microsoft.com/en-us/office/date-systems-in-excel-e7fe7167-48a9-4b96-bb53-5612a800b487
+     */
+    is1904(): boolean;
+    /**
+     * 设置行排序
+     */
+    sortColumn(sheetIndex: number, range: RangeRef, sortOrder: 'asc' | 'desc'): void;
+    /**
+     * 修改行高
+     */
+    setRowHeight(sheetIndex: number, row: number, height: number): void;
+    /**
+     * 修改列宽
+     */
+    setColWidth(sheetIndex: number, col: number, width: number): void;
+}

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

@@ -0,0 +1,51 @@
+import { CT_AbsoluteAnchor, CT_OneCellAnchor, CT_Picture, CT_Shape, CT_ShapeProperties, CT_TwoCellAnchor } from '../../openxml/ExcelTypes';
+import { OutLine } from '../../openxml/drawing/ShapeProperties';
+import { IChartSpace } from './IChartSpace';
+import { RichText } from './RichText';
+export type IPicture = CT_Picture & {
+    /**
+     * 扩充的属性
+     */
+    imgURL?: string;
+    /**
+     * 图片全局 id
+     */
+    gid: string;
+};
+export type StyleColor = {
+    lnRefColor?: string;
+    fillRefColor?: string;
+    effectRefColor?: string;
+    fontRefColor?: string;
+};
+export type IShapeProperties = CT_ShapeProperties & {
+    /**
+     * 扩充一些 word 里用到的属性
+     */
+    outline?: OutLine;
+    fillColor?: string;
+};
+export type IShape = CT_Shape & {
+    spPr?: IShapeProperties;
+    /**
+     * 扩充一些 word 里用到的属性
+     */
+    styleColor?: StyleColor;
+    /**
+     * 解析出来的富文本属性
+     */
+    richText?: RichText;
+};
+export type IAnchorCommon = {
+    pic?: IPicture;
+    shape?: IShape;
+    chartSpace?: IChartSpace;
+};
+export type ITwoCellAnchor = CT_TwoCellAnchor & IAnchorCommon;
+export type IAbsoluteAnchor = CT_AbsoluteAnchor & IAnchorCommon;
+export type IOneCellAnchor = CT_OneCellAnchor & IAnchorCommon;
+export type IDrawing = {
+    oneCellAnchors: IOneCellAnchor[];
+    twoCellAnchors: ITwoCellAnchor[];
+    absoluteAnchors: IAbsoluteAnchor[];
+};

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

@@ -0,0 +1,11 @@
+/**
+ * 对应 CT_RElt
+ */
+import { IRPrElt } from './IRPrElt';
+/**
+ * CT_RElt
+ */
+export interface IRElt {
+    rPr?: IRPrElt;
+    t: string;
+}

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

@@ -0,0 +1,28 @@
+import { CT_Color, ST_FontScheme, ST_VerticalAlignRun } from '../../openxml/ExcelTypes';
+/**
+ * 对应 CT_RPrElt，很多属性在文档里没有，怀疑是不用了
+ */
+export interface IRPrElt {
+    /**
+     * This element is a string representing the name of the font assigned to display this run.
+     */
+    rFont?: string;
+    charset?: number;
+    family?: number;
+    b?: boolean;
+    i?: boolean;
+    /**
+     *
+  This element draws a strikethrough line through the horizontal middle of the text.
+     */
+    strike?: boolean;
+    outline?: boolean;
+    shadow?: boolean;
+    condense?: boolean;
+    extend?: boolean;
+    color?: CT_Color;
+    sz?: number;
+    u?: boolean;
+    vertAlign?: ST_VerticalAlignRun;
+    scheme?: ST_FontScheme;
+}

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

@@ -0,0 +1,10 @@
+/**
+ * Relationship 的定义
+ */
+export interface IRelationship {
+    id: string;
+    type: string;
+    target: string;
+    targetMode?: string;
+    targetOrigin?: string;
+}

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

@@ -0,0 +1,14 @@
+import { ST_SheetState } from '../../openxml/ExcelTypes';
+import { Attributes } from '../../openxml/Attributes';
+import { IWorksheet } from './IWorksheet';
+/**
+ * 类似 CT_Sheet，不同的是合入了 sheet1.xml 里的定义
+ */
+export interface ISheet {
+    'name': string;
+    'sheetId': string;
+    'state'?: ST_SheetState;
+    'r:id': string;
+    'worksheet'?: IWorksheet;
+}
+export declare const ISheet_Attributes: Attributes;

package/esm/excel/types/ISheet.js

@@ -0,0 +1,16 @@
+var ISheet_Attributes = {
+    'name': {
+        type: 'string'
+    },
+    'sheetId': {
+        type: 'string'
+    },
+    'state': {
+        type: 'string'
+    },
+    'r:id': {
+        type: 'string'
+    }
+};
+
+export { ISheet_Attributes };

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

@@ -0,0 +1,41 @@
+/**
+ * 数据表总入口
+ */
+import { IRelationship } from './IRelationship';
+import { ISheet } from './ISheet';
+import { CT_BookView, CT_CalcPr, CT_DefinedName, CT_Stylesheet, CT_WorkbookPr } from '../../openxml/ExcelTypes';
+import { CT_Theme } from './CT_Theme';
+export interface IWorkbook {
+    /**
+     * sheet 列表
+     */
+    sheets: ISheet[];
+    /**
+     * calc配置，只有部分配置
+     */
+    calcPr?: CT_CalcPr;
+    /**
+     * Defined Names
+     */
+    definedNames?: CT_DefinedName[];
+    /**
+     * workbookPr
+     */
+    workbookPr?: CT_WorkbookPr;
+    /**
+     * workbookView
+     */
+    workbookView?: CT_BookView;
+    /**
+     * workbookRelationships
+     */
+    workbookRelationships?: IRelationship[];
+    /**
+     * styles.xml
+     */
+    styleSheet?: CT_Stylesheet;
+    /**
+     * theme.xml
+     */
+    theme: CT_Theme;
+}

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

@@ -0,0 +1,37 @@
+import { CT_AutoFilter, CT_Col, CT_ConditionalFormatting, CT_Row, CT_SheetFormatPr, CT_SheetPr, CT_SheetView, CT_Table } from '../../openxml/ExcelTypes';
+import { CT_ExtensionList } from './CT_ExtensionList';
+import { IDrawing } from './IDrawing';
+import { RangeRef } from './RangeRef';
+import { CellData } from './worksheet/CellData';
+/**
+ * 对应 Worksheet
+ */
+export interface IWorksheet {
+    sheetPr?: CT_SheetPr;
+    dimension?: {
+        ref: string;
+    };
+    sheetViews?: CT_SheetView[];
+    sheetFormatPr?: CT_SheetFormatPr;
+    cols: CT_Col[];
+    /**
+     * 行属性，因为数据存在二维数据里，所以需要另一个地方来存行属性，这里的索引是行号，以 0 开始
+     */
+    rows: CT_Row[];
+    /**
+     * 数据存储，这里和 xml 里不一样，这里是用二维数组，而且值是解析后的值
+     */
+    cellData: CellData[][];
+    mergeCells: RangeRef[];
+    /**
+     * 条件格式化
+     */
+    conditionalFormatting: CT_ConditionalFormatting[];
+    /**
+     * 图片
+     */
+    drawing?: IDrawing;
+    extLst?: CT_ExtensionList;
+    tableParts?: CT_Table[];
+    autoFilter?: CT_AutoFilter;
+}

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

@@ -0,0 +1,21 @@
+/**
+ * 范围引用
+ */
+export interface RangeRef {
+    /**
+     * 开始行，从 0 开始
+     */
+    startRow: number;
+    /**
+     * 开始列，从 0 开始
+     */
+    startCol: number;
+    /**
+     * 结束的行
+     */
+    endRow: number;
+    /**
+     * 结束的列
+     */
+    endCol: number;
+}

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

@@ -0,0 +1,7 @@
+import { IRElt } from './IRElt';
+export interface RichText {
+    type: 'rich';
+    richText: IRElt[];
+    t?: number;
+    s?: number;
+}

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

@@ -0,0 +1,5 @@
+import { RichText } from './RichText';
+/**
+ * String Item，如果是纯文本直接用字符串，这样是为了节省内存，但导致了后面代码都得判断类型
+ */
+export type StringItem = string | RichText;

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

@@ -0,0 +1,8 @@
+/**
+ * 表格样式定义，包括内置和自定义的
+ */
+import { CT_Dxfs, CT_TableStyles } from '../../openxml/ExcelTypes';
+export type TableStyleDef = {
+    dxfs: CT_Dxfs;
+    tableStyles: CT_TableStyles;
+};

package/esm/excel/types/X14CF/CT_Cfvo.d.ts

@@ -0,0 +1,8 @@
+import { Attributes } from '../../../openxml/Attributes';
+import { ST_CfvoType } from './ST_CfvoType';
+export interface CT_Cfvo {
+    type?: ST_CfvoType;
+    val?: string;
+    gte?: boolean;
+}
+export declare const CT_Cfvo_Attributes: Attributes;

package/esm/excel/types/X14CF/CT_Cfvo.js

@@ -0,0 +1,14 @@
+var CT_Cfvo_Attributes = {
+    type: {
+        type: 'string'
+    },
+    val: {
+        type: 'string'
+    },
+    gte: {
+        type: 'boolean',
+        defaultValue: 'true'
+    }
+};
+
+export { CT_Cfvo_Attributes };

package/esm/excel/types/X14CF/ST_CfvoType.d.ts

@@ -0,0 +1 @@
+export type ST_CfvoType = 'num' | 'percent' | 'max' | 'min' | 'formula' | 'percentile';

package/esm/excel/types/X14CF/X14CfRule.d.ts

@@ -0,0 +1,10 @@
+import { Attributes } from '../../../openxml/Attributes';
+import { X14DataBar } from './X14DataBar';
+import { X14IconSet } from './X14IconSet';
+export type X14CfRule = {
+    'type'?: string;
+    'id'?: string;
+    'x14:dataBar'?: X14DataBar;
+    'x14:iconSet'?: X14IconSet;
+};
+export declare const X14CfRule_Attributes: Attributes;

package/esm/excel/types/X14CF/X14CfRule.js

@@ -0,0 +1,21 @@
+import { X14DataBar_Attributes } from './X14DataBar.js';
+import { X14IconSet_Attributes } from './X14IconSet.js';
+
+var X14CfRule_Attributes = {
+    'type': {
+        type: 'string'
+    },
+    'id': {
+        type: 'string'
+    },
+    'x14:dataBar': {
+        type: 'child',
+        childAttributes: X14DataBar_Attributes
+    },
+    'x14:iconSet': {
+        type: 'child',
+        childAttributes: X14IconSet_Attributes
+    }
+};
+
+export { X14CfRule_Attributes };

package/esm/excel/types/X14CF/X14ConditionalFormatting.d.ts

@@ -0,0 +1,6 @@
+import { Attributes } from '../../../openxml/Attributes';
+import { X14CfRule } from './X14CfRule';
+export type X14ConditionalFormatting = {
+    'x14:cfRule'?: X14CfRule[];
+};
+export declare const X14ConditionalFormatting_Attributes: Attributes;

package/esm/excel/types/X14CF/X14ConditionalFormatting.js

@@ -0,0 +1,11 @@
+import { X14CfRule_Attributes } from './X14CfRule.js';
+
+var X14ConditionalFormatting_Attributes = {
+    'x14:cfRule': {
+        type: 'child',
+        childAttributes: X14CfRule_Attributes,
+        childIsArray: true
+    }
+};
+
+export { X14ConditionalFormatting_Attributes };

package/esm/excel/types/X14CF/X14ConditionalFormattings.d.ts

@@ -0,0 +1,6 @@
+import { Attributes } from '../../../openxml/Attributes';
+import { X14ConditionalFormatting } from './X14ConditionalFormatting';
+export type X14ConditionalFormattings = {
+    'x14:conditionalFormatting'?: X14ConditionalFormatting[];
+};
+export declare const X14ConditionalFormattings_Attributes: Attributes;

package/esm/excel/types/X14CF/X14ConditionalFormattings.js

@@ -0,0 +1,11 @@
+import { X14ConditionalFormatting_Attributes } from './X14ConditionalFormatting.js';
+
+var X14ConditionalFormattings_Attributes = {
+    'x14:conditionalFormatting': {
+        type: 'child',
+        childAttributes: X14ConditionalFormatting_Attributes,
+        childIsArray: true
+    }
+};
+
+export { X14ConditionalFormattings_Attributes };

package/esm/excel/types/X14CF/X14DataBar.d.ts

@@ -0,0 +1,18 @@
+import { Attributes } from '../../../openxml/Attributes';
+import { CT_Color } from '../CT_Color';
+import { CT_Cfvo } from './CT_Cfvo';
+export type X14DataBar = {
+    'minLength'?: number;
+    'maxLength'?: number;
+    'border'?: boolean;
+    'gradient'?: boolean;
+    'direction'?: 'leftToRight' | 'rightToLeft';
+    'negativeBarBorderColorSameAsPositive'?: boolean;
+    'negativeBarColorSameAsPositive'?: boolean;
+    'x14:cfvo'?: CT_Cfvo[];
+    'x14:borderColor'?: CT_Color;
+    'x14:negativeFillColor'?: CT_Color;
+    'x14:negativeBorderColor'?: CT_Color;
+    'x14:axisColor'?: CT_Color;
+};
+export declare const X14DataBar_Attributes: Attributes;

package/esm/excel/types/X14CF/X14DataBar.js

@@ -0,0 +1,54 @@
+import { CT_Color_Attributes } from '../CT_Color.js';
+import { CT_Cfvo_Attributes } from './CT_Cfvo.js';
+
+var X14DataBar_Attributes = {
+    'minLength': {
+        type: 'int',
+        defaultValue: '10'
+    },
+    'maxLength': {
+        type: 'int',
+        defaultValue: '90'
+    },
+    'border': {
+        type: 'boolean',
+        defaultValue: 'false'
+    },
+    'gradient': {
+        type: 'boolean',
+        defaultValue: 'true'
+    },
+    'direction': {
+        type: 'string'
+    },
+    'negativeBarColorSameAsPositive': {
+        type: 'boolean'
+    },
+    'negativeBarBorderColorSameAsPositive': {
+        type: 'boolean',
+        defaultValue: 'false'
+    },
+    'x14:cfvo': {
+        type: 'child',
+        childAttributes: CT_Cfvo_Attributes,
+        childIsArray: true
+    },
+    'x14:borderColor': {
+        type: 'child',
+        childAttributes: CT_Color_Attributes
+    },
+    'x14:negativeFillColor': {
+        type: 'child',
+        childAttributes: CT_Color_Attributes
+    },
+    'x14:negativeBorderColor': {
+        type: 'child',
+        childAttributes: CT_Color_Attributes
+    },
+    'x14:axisColor': {
+        type: 'child',
+        childAttributes: CT_Color_Attributes
+    }
+};
+
+export { X14DataBar_Attributes };