@silurus/ooxml 0.1.0

package/dist/types/xlsx.d.ts

@@ -0,0 +1,375 @@
+export declare interface Border {
+    left: BorderEdge | null;
+    right: BorderEdge | null;
+    top: BorderEdge | null;
+    bottom: BorderEdge | null;
+    diagonalUp?: BorderEdge | null;
+    diagonalDown?: BorderEdge | null;
+}
+
+export declare interface BorderEdge {
+    style: string;
+    color: string | null;
+}
+
+export declare interface Cell {
+    col: number;
+    row: number;
+    colRef: string;
+    value: CellValue;
+    styleIndex: number;
+}
+
+declare interface CellRange {
+    top: number;
+    left: number;
+    bottom: number;
+    right: number;
+}
+
+export declare type CellValue = {
+    type: 'empty';
+} | {
+    type: 'text';
+    text: string;
+    runs?: Run[];
+} | {
+    type: 'number';
+    number: number;
+} | {
+    type: 'bool';
+    bool: boolean;
+} | {
+    type: 'error';
+    error: string;
+};
+
+export declare interface CellXf {
+    fontId: number;
+    fillId: number;
+    borderId: number;
+    numFmtId: number;
+    alignH: string | null;
+    alignV: string | null;
+    wrapText: boolean;
+    /** Indentation level (each level ≈ 3 characters, ECMA-376 §18.8.44) */
+    indent?: number;
+    /** Text rotation: 1–90 = counter-clockwise °, 91–180 = (val−90)° clockwise, 255 = stacked */
+    textRotation?: number;
+    shrinkToFit?: boolean;
+}
+
+declare type CfRule = {
+    type: 'cellIs';
+    operator: string;
+    formulas: string[];
+    dxfId: number | null;
+    priority: number;
+} | {
+    type: 'expression';
+    formula: string;
+    dxfId: number | null;
+    priority: number;
+} | {
+    type: 'colorScale';
+    stops: CfStop[];
+    priority: number;
+} | {
+    type: 'dataBar';
+    color: string;
+    min: CfValue;
+    max: CfValue;
+    priority: number;
+} | {
+    type: 'top10';
+    top: boolean;
+    percent: boolean;
+    rank: number;
+    dxfId: number | null;
+    priority: number;
+} | {
+    type: 'aboveAverage';
+    aboveAverage: boolean;
+    dxfId: number | null;
+    priority: number;
+} | {
+    type: 'iconSet';
+    iconSet: string;
+    cfvos: CfValue[];
+    reverse: boolean;
+    priority: number;
+} | {
+    type: 'other';
+    kind: string;
+    priority: number;
+};
+
+declare interface CfStop {
+    kind: string;
+    value: string | null;
+    color: string;
+}
+
+declare interface CfValue {
+    kind: string;
+    value: string | null;
+}
+
+declare interface ChartAnchor {
+    fromCol: number;
+    fromColOff: number;
+    fromRow: number;
+    fromRowOff: number;
+    toCol: number;
+    toColOff: number;
+    toRow: number;
+    toRowOff: number;
+    chart: ChartData;
+}
+
+/**
+ * XLSX parser's raw chart output. Retains parser-native `barDir` + `grouping`
+ * which the renderer combines into a canonical `ChartModel.chartType` (e.g.
+ * `clusteredBarH`, `stackedBarPct`) at render time.
+ */
+declare interface ChartData {
+    /** Primary chart type: "bar"|"line"|"area"|"pie"|"doughnut"|"radar"|"scatter" */
+    chartType: string;
+    /** "col" (vertical bars) | "row" (horizontal bars) */
+    barDir: string;
+    /** "clustered"|"stacked"|"standard"|"percentStacked" */
+    grouping: string;
+    title: string | null;
+    categories: string[];
+    series: XlsxChartSeries[];
+    /** Whether data labels are enabled (c:dLbls showVal/showPercent). */
+    showDataLabels?: boolean;
+    /** Category axis title (c:catAx/c:title). */
+    catAxisTitle?: string | null;
+    /** Value axis title (c:valAx/c:title). */
+    valAxisTitle?: string | null;
+}
+
+declare interface ConditionalFormat {
+    sqref: CellRange[];
+    rules: CfRule[];
+}
+
+declare interface Dxf {
+    font: Font | null;
+    fill: Fill | null;
+    border: Border | null;
+}
+
+export declare interface Fill {
+    patternType: string;
+    fgColor: string | null;
+    bgColor: string | null;
+}
+
+export declare interface Font {
+    bold: boolean;
+    italic: boolean;
+    underline: boolean;
+    strike: boolean;
+    size: number;
+    color: string | null;
+    name: string | null;
+}
+
+declare interface Hyperlink {
+    col: number;
+    row: number;
+    url: string | null;
+}
+
+/**
+ * Image anchored to a rectangle of cells (EMU offsets within the anchor cells).
+ * 914400 EMU = 1 inch, 9525 EMU = 1 px @ 96 DPI.
+ */
+declare interface ImageAnchor {
+    fromCol: number;
+    fromColOff: number;
+    fromRow: number;
+    fromRowOff: number;
+    toCol: number;
+    toColOff: number;
+    toRow: number;
+    toRowOff: number;
+    /** Data URL (data:image/png;base64,...) */
+    dataUrl: string;
+}
+
+export declare interface MergeCell {
+    top: number;
+    left: number;
+    bottom: number;
+    right: number;
+}
+
+export declare interface NumFmt {
+    numFmtId: number;
+    formatCode: string;
+}
+
+export declare interface ParsedWorkbook {
+    workbook: Workbook;
+    styles: Styles;
+    sharedStrings: SharedString[];
+}
+
+export declare interface RenderViewportOptions {
+    width?: number;
+    height?: number;
+    dpr?: number;
+    defaultFontFamily?: string;
+    defaultFontSize?: number;
+    scrollOffsetX?: number;
+    scrollOffsetY?: number;
+    freezeRows?: number;
+    freezeCols?: number;
+    /** Scale factor applied to all cell/header dimensions (default 1). */
+    cellScale?: number;
+    /** Pre-loaded Image elements keyed by their dataUrl (for ImageAnchor rendering). */
+    loadedImages?: Map<string, HTMLImageElement>;
+}
+
+export declare interface Row {
+    index: number;
+    height: number | null;
+    cells: Cell[];
+}
+
+declare interface Run {
+    text: string;
+    font?: RunFont;
+}
+
+declare interface RunFont {
+    bold: boolean;
+    italic: boolean;
+    underline: boolean;
+    strike: boolean;
+    size?: number;
+    color?: string | null;
+    name?: string | null;
+}
+
+declare interface SharedString {
+    text: string;
+    runs?: Run[];
+}
+
+export declare interface SheetMeta {
+    name: string;
+    sheetId: number;
+    rId: string;
+}
+
+export declare interface Styles {
+    fonts: Font[];
+    fills: Fill[];
+    borders: Border[];
+    cellXfs: CellXf[];
+    numFmts: NumFmt[];
+    dxfs: Dxf[];
+}
+
+export declare interface ViewportRange {
+    row: number;
+    col: number;
+    rows: number;
+    cols: number;
+}
+
+export declare interface Workbook {
+    sheets: SheetMeta[];
+}
+
+export declare interface Worksheet {
+    name: string;
+    rows: Row[];
+    colWidths: Record<number, number>;
+    rowHeights: Record<number, number>;
+    defaultColWidth: number;
+    defaultRowHeight: number;
+    mergeCells: MergeCell[];
+    freezeRows: number;
+    freezeCols: number;
+    conditionalFormats: ConditionalFormat[];
+    images: ImageAnchor[];
+    charts: ChartAnchor[];
+    /** Whether to display zero values (ECMA-376 §18.3.1.94). Defaults to true. */
+    showZeros?: boolean;
+    /** Sheet tab color (ECMA-376 §18.3.1.79). */
+    tabColor?: string | null;
+    /** AutoFilter header range (ECMA-376 §18.3.1.2). */
+    autoFilter?: CellRange | null;
+    /** Hyperlinks in this worksheet (ECMA-376 §18.3.1.47). */
+    hyperlinks?: Hyperlink[];
+}
+
+/**
+ * XLSX parser's raw chart series (includes XLSX-only `seriesType` for mixed
+ * charts). Adapted to `ChartSeries` from @silurus/ooxml-core before rendering.
+ */
+declare interface XlsxChartSeries {
+    name: string;
+    /** Chart sub-type for this series (allows mixed charts). */
+    seriesType: string;
+    categories: string[];
+    values: (number | null)[];
+    /** Explicit fill color hex (from c:spPr). Undefined = use palette. */
+    color?: string | null;
+}
+
+export declare class XlsxViewer {
+    private wb;
+    private canvas;
+    private canvasArea;
+    private scrollHost;
+    private spacer;
+    private tabBar;
+    private tabs;
+    private currentSheet;
+    private currentWorksheet;
+    private opts;
+    private resizeObserver;
+    constructor(container: HTMLElement, opts?: XlsxViewerOptions);
+    load(source: string | ArrayBuffer): Promise<void>;
+    showSheet(index: number): Promise<void>;
+    private buildTabs;
+    private updateTabActive;
+    private tabStyle;
+    private updateSpacerSize;
+    private renderCurrentSheet;
+    get sheetNames(): string[];
+    destroy(): void;
+}
+
+export declare interface XlsxViewerOptions {
+    /** Scale factor for cell/header dimensions (default 1). 0.5 = half size. */
+    cellScale?: number;
+    onReady?: (sheetNames: string[]) => void;
+    onSheetChange?: (index: number, name: string) => void;
+    onError?: (err: Error) => void;
+}
+
+export declare class XlsxWorkbook {
+    private worker;
+    private parsedWorkbook;
+    private sheetCache;
+    /** Cache of loaded images keyed by their data URL. Shared across sheets. */
+    private imageCache;
+    private rawData;
+    constructor();
+    load(source: string | ArrayBuffer): Promise<void>;
+    get sheetNames(): string[];
+    get sheetCount(): number;
+    getWorksheet(sheetIndex: number): Promise<Worksheet>;
+    renderViewport(target: HTMLCanvasElement | OffscreenCanvas, sheetIndex: number, viewport: ViewportRange, opts?: RenderViewportOptions): Promise<void>;
+    destroy(): void;
+    private sendMessage;
+}
+
+export { }