@silurus/ooxml 0.11.0 → 0.13.0

package/dist/types/xlsx.d.ts

@@ -56,7 +56,18 @@ export declare interface Cell {
     formula?: string;
 }
 
-declare interface CellRange {
+export declare interface CellAddress {
+    row: number;
+    col: number;
+}
+
+export declare interface CellRange {
+    anchor: CellAddress;
+    active: CellAddress;
+    mode: SelectionMode_2;
+}
+
+declare interface CellRange_2 {
     top: number;
     left: number;
     bottom: number;
@@ -206,10 +217,40 @@ declare interface ChartData {
     catAxisFontSizeHpt?: number | null;
     /** Value axis tick-label font size in hpt. */
     valAxisFontSizeHpt?: number | null;
+    /** Outer chartSpace background (ECMA-376 §21.2.2.5 `<c:spPr>`). Hex without
+     *  '#' for a solid fill, undefined for `<a:noFill/>` or an absent spPr.
+     *  Combine with `hasChartSpPr` to distinguish explicit-transparent from
+     *  default-opaque-white. */
+    chartBg?: string | null;
+    /** True when the parser saw a `<c:chartSpace><c:spPr>` element. Lets the
+     *  adapter tell "spec said noFill → transparent" from "no spPr → default". */
+    hasChartSpPr?: boolean;
+    /** `<c:legend><c:manualLayout>` fractions of chart space (§21.2.2.31). */
+    legendManualLayout?: LegendManualLayout | null;
+    /** `<c:catAx><c:delete val="1"/>` — hide the category axis (§21.2.2.40). */
+    catAxisHidden?: boolean;
+    /** `<c:valAx><c:delete val="1"/>` — hide the value axis (§21.2.2.40). */
+    valAxisHidden?: boolean;
+    /** `<c:valAx><c:numFmt@formatCode>` — number format for value-axis tick
+     *  labels (ECMA-376 §21.2.2.21). */
+    valAxisFormatCode?: string | null;
+    /** `<c:barChart><c:gapWidth>` — space between category groups as a percent
+     *  of bar width (§21.2.2.13). */
+    barGapWidth?: number | null;
+    /** `<c:barChart><c:overlap>` — signed percent overlap between bars in a
+     *  cluster (§21.2.2.25). Negative = gap. */
+    barOverlap?: number | null;
+    /** `<c:dLbls><c:dLblPos>` — data label position (§21.2.2.16). */
+    dataLabelPosition?: string | null;
+    /** Hex (no `#`) for data label text color, resolved from `<c:dLbls><c:txPr>`. */
+    dataLabelFontColor?: string | null;
+    /** `<c:dLbls><c:numFmt@formatCode>` — chart-level override for data label
+     *  number format (§21.2.2.35). */
+    dataLabelFormatCode?: string | null;
 }
 
 declare interface ConditionalFormat {
-    sqref: CellRange[];
+    sqref: CellRange_2[];
     rules: CfRule[];
 }
 
@@ -222,6 +263,11 @@ declare interface Dxf {
     font: Font | null;
     fill: Fill | null;
     border: Border | null;
+    /** Number format override from the dxf (ECMA-376 §18.8.17). When a
+     *  conditional-formatting rule matches, this numFmt replaces the cell's own
+     *  style numFmt for rendering — e.g. switching a calendar cell from `d` to
+     *  `m"月"d"日"` on the first day of each month. */
+    numFmt?: NumFmt | null;
 }
 
 export declare interface Fill {
@@ -281,6 +327,15 @@ declare interface ImageAnchor {
     dataUrl: string;
 }
 
+declare interface LegendManualLayout {
+    xMode: string;
+    yMode: string;
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+}
+
 export declare interface MergeCell {
     top: number;
     left: number;
@@ -299,6 +354,47 @@ export declare interface ParsedWorkbook {
     sharedStrings: SharedString[];
 }
 
+declare type PathCmd = {
+    op: 'moveTo';
+    x: number;
+    y: number;
+} | {
+    op: 'lineTo';
+    x: number;
+    y: number;
+} | {
+    op: 'cubicBezTo';
+    x1: number;
+    y1: number;
+    x2: number;
+    y2: number;
+    x3: number;
+    y3: number;
+} | {
+    op: 'quadBezTo';
+    x1: number;
+    y1: number;
+    x2: number;
+    y2: number;
+}
+/** ECMA-376 §20.1.9.3. stAng/swAng in 60000ths of a degree. wr/hr in
+*  the path's own coordinate units. Pen position is the arc start. */
+| {
+    op: 'arcTo';
+    wr: number;
+    hr: number;
+    stAng: number;
+    swAng: number;
+} | {
+    op: 'close';
+};
+
+declare interface PathInfo {
+    w: number;
+    h: number;
+    commands: PathCmd[];
+}
+
 export declare interface RenderViewportOptions {
     width?: number;
     height?: number;
@@ -313,6 +409,8 @@ export declare interface RenderViewportOptions {
     cellScale?: number;
     /** Pre-loaded Image elements keyed by their dataUrl (for ImageAnchor rendering). */
     loadedImages?: Map<string, HTMLImageElement>;
+    /** Called once per cell that contains text, with canvas-pixel position and cell address. */
+    onTextRun?: (info: TextRunInfo) => void;
 }
 
 export declare interface Row {
@@ -336,6 +434,51 @@ declare interface RunFont {
     name?: string | null;
 }
 
+declare type SelectionMode_2 = 'cells' | 'rows' | 'cols' | 'all';
+export { SelectionMode_2 as SelectionMode }
+
+declare interface ShapeAnchor {
+    fromCol: number;
+    fromColOff: number;
+    fromRow: number;
+    fromRowOff: number;
+    toCol: number;
+    toColOff: number;
+    toRow: number;
+    toRowOff: number;
+    shapes: ShapeInfo[];
+}
+
+declare type ShapeGeom = {
+    type: 'preset';
+    name: string;
+} | {
+    type: 'custom';
+    paths: PathInfo[];
+}
+/** Bitmap picture leaf inside a `<xdr:grpSp>`. `dataUrl` is a pre-encoded
+*  `data:<mime>;base64,…` produced by the Rust parser from the drawing's
+*  relationship target. */
+| {
+    type: 'image';
+    dataUrl: string;
+};
+
+declare interface ShapeInfo {
+    /** Normalized [0,1] position/size relative to the anchor rect. */
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+    /** Rotation in degrees, clockwise. */
+    rot: number;
+    fillColor?: string;
+    strokeColor?: string;
+    /** Stroke width in EMU. 0 = no stroke. */
+    strokeWidth: number;
+    geom: ShapeGeom;
+}
+
 declare interface SharedString {
     text: string;
     runs?: Run[];
@@ -347,6 +490,24 @@ export declare interface SheetMeta {
     rId: string;
 }
 
+declare interface SlicerAnchor {
+    fromCol: number;
+    fromColOff: number;
+    fromRow: number;
+    fromRowOff: number;
+    toCol: number;
+    toColOff: number;
+    toRow: number;
+    toRowOff: number;
+    caption: string;
+    items: SlicerItem[];
+}
+
+declare interface SlicerItem {
+    name: string;
+    selected: boolean;
+}
+
 export declare interface Styles {
     fonts: Font[];
     fills: Fill[];
@@ -357,7 +518,7 @@ export declare interface Styles {
 }
 
 declare interface TableInfo {
-    range: CellRange;
+    range: CellRange_2;
     styleName: string;
     headerRowCount: number;
     totalsRowCount: number;
@@ -377,6 +538,21 @@ declare interface TableInfo {
     headerRowDxf?: number;
 }
 
+/** Emitted once per cell that has text, with the cell's canvas-pixel bounds. */
+export declare interface TextRunInfo {
+    text: string;
+    /** Canvas CSS-pixel x of the cell's top-left corner. */
+    x: number;
+    /** Canvas CSS-pixel y of the cell's top-left corner. */
+    y: number;
+    /** Cell width in canvas CSS pixels. */
+    width: number;
+    /** Cell height in canvas CSS pixels. */
+    height: number;
+    row: number;
+    col: number;
+}
+
 export declare interface ViewportRange {
     row: number;
     col: number;
@@ -401,6 +577,10 @@ export declare interface Worksheet {
     conditionalFormats: ConditionalFormat[];
     images: ImageAnchor[];
     charts: ChartAnchor[];
+    /** Grouped shapes from `<xdr:grpSp>` inside twoCellAnchors
+     *  (ECMA-376 §20.5.2.17). Each anchor holds leaf shapes pre-flattened
+     *  with normalized [0,1] geometry relative to the anchor rect. */
+    shapeGroups?: ShapeAnchor[];
     /** Whether to display zero values (ECMA-376 §18.3.1.94). Defaults to true. */
     showZeros?: boolean;
     /** Whether to draw default grid lines (ECMA-376 §18.3.1.83
@@ -410,7 +590,7 @@ export declare interface Worksheet {
     /** Sheet tab color (ECMA-376 §18.3.1.79). */
     tabColor?: string | null;
     /** AutoFilter header range (ECMA-376 §18.3.1.2). */
-    autoFilter?: CellRange | null;
+    autoFilter?: CellRange_2 | null;
     /** Hyperlinks in this worksheet (ECMA-376 §18.3.1.47). */
     hyperlinks?: Hyperlink[];
     /** A1-style cell refs of commented cells (ECMA-376 §18.7.3). Rendered as a
@@ -423,6 +603,10 @@ export declare interface Worksheet {
     /** Excel Tables on this sheet (ECMA-376 §18.5). The renderer overlays a
      *  built-in style (bold header, banded rows) on the given ranges. */
     tables?: TableInfo[];
+    /** Pivot / table slicers (Office 2010+ extension). Each anchor carries a
+     *  caption and the saved item list (with selection flags) so the renderer
+     *  can draw a static button bank without the live pivot engine. */
+    slicers?: SlicerAnchor[];
 }
 
 /**
@@ -440,6 +624,11 @@ declare interface XlsxChartSeries {
     /** Marker visibility resolved from `<c:marker>`/chart-level default
      *  (ECMA-376 §21.2.2.32). */
     showMarker?: boolean;
+    /** `<c:val>/<c:numRef>/<c:formatCode>` — Excel number format for series
+     *  values (ECMA-376 §21.2.2.37). */
+    valFormatCode?: string | null;
+    /** `<c:ser><c:order>` — stacking/legend display order (§21.2.2.28). */
+    order?: number;
 }
 
 export declare class XlsxViewer {
@@ -454,9 +643,30 @@ export declare class XlsxViewer {
     private currentWorksheet;
     private opts;
     private resizeObserver;
+    private anchorCell;
+    private activeCell;
+    private selectionMode;
+    private isSelecting;
+    private selectionOverlay;
+    private keydownHandler;
     constructor(container: HTMLElement, opts?: XlsxViewerOptions);
     load(source: string | ArrayBuffer): Promise<void>;
     showSheet(index: number): Promise<void>;
+    /** Returns the cell at canvas-client coordinates, or null if outside the cell grid. */
+    getCellAt(clientX: number, clientY: number): CellAddress | null;
+    /** Returns the CSS-pixel rect of a cell within canvasArea, or null if not computable. */
+    private getCellRect;
+    /** Returns the current selection, including mode. */
+    get selection(): CellRange | null;
+    /**
+     * Returns what the header area contains at the given client coordinates.
+     * Returns null when the point is in the cell grid (not a header).
+     */
+    private getHeaderHit;
+    /** Copy the selected cell range as tab-separated text to the clipboard. */
+    private copySelection;
+    private updateSelectionOverlay;
+    private setupSelectionEvents;
     private buildTabs;
     private updateTabActive;
     private tabStyle;
@@ -472,6 +682,8 @@ export declare interface XlsxViewerOptions {
     onReady?: (sheetNames: string[]) => void;
     onSheetChange?: (index: number, name: string) => void;
     onError?: (err: Error) => void;
+    /** Called when the selected cell range changes. null means no selection. */
+    onSelectionChange?: (selection: CellRange | null) => void;
 }
 
 export declare class XlsxWorkbook {