vastgrid 0.1.1 → 0.2.0

package/dist/canvas/grid-canvas.d.ts

@@ -0,0 +1,161 @@
+import { type Column, type JsonValue } from "vastgrid-spec";
+import type { GridStore } from "../core/store.js";
+import { Geometry } from "./geometry.js";
+import type { CellAction, CellHooks, CellStyle, ColumnGroup, GridCell } from "./hooks.js";
+/** The rows on screen once scrolling pauses, for the accessibility rows. */
+export interface Settled {
+    top: number;
+    rows: number;
+    /** The first and last display positions on screen. */
+    left: number;
+    right: number;
+    version: number;
+}
+export interface CanvasElements {
+    root: HTMLElement;
+    canvas: HTMLCanvasElement;
+    scroller: HTMLElement;
+    sizer: HTMLElement;
+}
+export interface CanvasOptions {
+    rowHeight?: number;
+    headerHeight?: number;
+    groupHeaderHeight?: number;
+}
+/**
+ * Draws the view on screen of a store onto a canvas and scrolls it, without React (§1 and §6 of react.md):
+ * cells, headers, row numbers, the selection and the columns pinned at each side, at most once per frame and only
+ * what is on screen. It tells the store which rows it shows, so that the store reads them.
+ */
+export declare class GridCanvas {
+    private options;
+    readonly geometry: Geometry;
+    /** Where dragged columns would go, while a header is dragged. */
+    private dropX;
+    private wrapLines;
+    private hooks;
+    private groups;
+    /** The row height of the theme or the props; rows are taller while a column wraps. */
+    private baseRowHeight;
+    private locale;
+    /** By column name: the text of its values by its format, and its style rules (§5.1). */
+    private formatters;
+    private rules;
+    /** Columns that the style rules read besides those on screen. */
+    private ruleColumns;
+    private store;
+    private elements;
+    private context;
+    private theme;
+    private cellText;
+    private headerText;
+    private ratio;
+    private frame;
+    private snapshot;
+    private columns;
+    private index;
+    private readonly measured;
+    private resizing;
+    private texts;
+    private textsView;
+    private settleTimer;
+    private settled;
+    private readonly settledListeners;
+    private scrolling;
+    private lastActive;
+    private lastScroll;
+    private lastView;
+    private durations;
+    private readonly frameListeners;
+    constructor(options?: CanvasOptions);
+    /** Shows where dragged columns would go, a line at `x`, or nothing. */
+    previewDrop(x: number | null): void;
+    /** Shows a column at a width while it is dragged, before the command that sets it. */
+    previewWidth(column: number, width: number | null): void;
+    /** Text, colors, drawing and actions of cells from the host (§5.1: they win over the document). */
+    setHooks(hooks: CellHooks): void;
+    /** Groups of columns in header rows above the names, each `groupHeight` pixels high (or the CSS's). */
+    setColumnGroups(groups: readonly ColumnGroup[] | undefined, groupHeight: number | undefined): void;
+    /** How many lines rows have while a displayed column wraps its text. */
+    setWrapLines(lines: number | undefined): void;
+    /** Shows a check box for each row in the gutter, and one for every row in the corner. */
+    setCheckboxes(on: boolean): void;
+    /** The language that formats show numbers and dates in (§5.1). */
+    setLocale(locale: string | undefined): void;
+    /** The row height for displayed columns: room for `WRAP_LINES` lines when one of them wraps. */
+    private wrappedHeight;
+    /** Row and header heights given as props, instead of the CSS custom properties. */
+    setSizes(rowHeight: number | undefined, headerHeight: number | undefined): void;
+    /** Draws `store` into the elements and follows both; gives the function that stops it. */
+    attach(elements: CanvasElements, store: GridStore): () => void;
+    /** Reads the theme again, after the grid's class or style changed. */
+    refreshTheme(): void;
+    private onState;
+    private onRows;
+    /** The columns and their widths for the displayed columns of the snapshot. */
+    relayout(): void;
+    /** Fits the columns without a width to the values on screen, growing them only. */
+    private measure;
+    private onScroll;
+    private updateViewport;
+    /** Scrolls so that a row is at the top, or just visible. */
+    scrollToRow(row: number, place: "top" | "nearest"): void;
+    /** Scrolls so that a cell is on screen. */
+    reveal(row: number, column: number): void;
+    /** Puts the place on screen in the session (§5.2) once scrolling pauses. */
+    private reportScroll;
+    getSettled: () => Settled;
+    subscribeSettled: (listener: () => void) => (() => void);
+    private bumpSettled;
+    /** The text of a cell as the grid shows it: the value's text form (§2.4). */
+    text(row: number, column: Column, value: JsonValue): string;
+    /** Follows the frames the canvas draws, for what is placed over it (the cell editor). */
+    subscribeFrames: (listener: () => void) => (() => void);
+    schedule(): void;
+    /** Draws now, as layout effects do before the browser paints. */
+    draw(): void;
+    /** Durations of the recent frames in milliseconds, for the bench. */
+    frameTimes(): readonly number[];
+    private resizeCanvas;
+    /** A position for a line one device pixel wide. */
+    private snap;
+    private paint;
+    private clipped;
+    private drawCells;
+    private drawLines;
+    /** The selected ranges (§5.2) and the active cell, within the display positions `[from, to]`. */
+    private drawSelection;
+    private drawHeaders;
+    /** The columns of a group header: the run of display positions next to `column` in the same group. */
+    groupSpan(column: number, level: number): [number, number] | null;
+    /** The names of a column's groups, from the outermost, for screen readers. */
+    groupNames(column: number): string[];
+    /**
+     * The rows of groups over display positions `[from, to]` of one region: each group over the run of its columns
+     * that are next to each other there, so a group whose columns were moved apart, hidden or pinned is split, and
+     * each part shows its name.
+     */
+    private drawGroups;
+    private drawGutter;
+    /** The colors of a cell: the host's `cellStyle`, or else the column's style rules. */
+    private cellStyleOf;
+    /** What a cell does, by the host's `cellAction`. */
+    private actionOf;
+    /** The action of a cell at a display position, while its value is read; null for plain cells. */
+    actionAt(row: number, columnIndex: number): {
+        action: CellAction;
+        cell: GridCell;
+    } | null;
+    /** The style rule that colors a cell: the first whose `when` is true for its row (§5.1); undefined for none. */
+    styleOf(row: number, name: string): CellStyle | undefined;
+    /** A check box in the gutter, centered at `middle`: checked, not checked, or unknown (a dash). */
+    private drawCheck;
+    /** The text of a column's total; undefined while it is read. */
+    private totalText;
+    /**
+     * The totals row, at the bottom: each displayed column's total (§5.1), in the column's format and alignment, a
+     * placeholder while it is read, and Σ in the gutter.
+     */
+    private drawTotals;
+}
+//# sourceMappingURL=grid-canvas.d.ts.map

package/dist/canvas/grid-canvas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"grid-canvas.d.ts","sourceRoot":"","sources":["../../src/canvas/grid-canvas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAmC,KAAK,SAAS,EAAmB,MAAM,eAAe,CAAC;AAI9G,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAGlD,OAAO,EAAe,QAAQ,EAAc,MAAM,eAAe,CAAC;AAClE,OAAO,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAa1F,4EAA4E;AAC5E,MAAM,WAAW,OAAO;IACtB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,sDAAsD;IACtD,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,WAAW,CAAC;IAClB,MAAM,EAAE,iBAAiB,CAAC;IAC1B,QAAQ,EAAE,WAAW,CAAC;IACtB,KAAK,EAAE,WAAW,CAAC;CACpB;AAED,MAAM,WAAW,aAAa;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AA6DD;;;;GAIG;AACH,qBAAa,UAAU;IAwCT,OAAO,CAAC,OAAO;IAvC3B,QAAQ,CAAC,QAAQ,WAAkB;IACnC,iEAAiE;IACjE,OAAO,CAAC,KAAK,CAAuB;IACpC,OAAO,CAAC,SAAS,CAAsB;IACvC,OAAO,CAAC,KAAK,CAAiB;IAC9B,OAAO,CAAC,MAAM,CAA8B;IAC5C,sFAAsF;IACtF,OAAO,CAAC,aAAa,CAAM;IAC3B,OAAO,CAAC,MAAM,CAAiC;IAC/C,wFAAwF;IACxF,OAAO,CAAC,UAAU,CAA0D;IAC5E,OAAO,CAAC,KAAK,CAAkG;IAC/G,iEAAiE;IACjE,OAAO,CAAC,WAAW,CAAgB;IACnC,OAAO,CAAC,KAAK,CAA0B;IACvC,OAAO,CAAC,QAAQ,CAA+B;IAC/C,OAAO,CAAC,OAAO,CAAyC;IACxD,OAAO,CAAC,KAAK,CAA0B;IACvC,OAAO,CAAC,QAAQ,CAA2B;IAC3C,OAAO,CAAC,UAAU,CAA2B;IAC7C,OAAO,CAAC,KAAK,CAAK;IAClB,OAAO,CAAC,KAAK,CAAK;IAClB,OAAO,CAAC,QAAQ,CAA6B;IAC7C,OAAO,CAAC,OAAO,CAAkC;IACjD,OAAO,CAAC,KAAK,CAA6B;IAC1C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA6B;IACtD,OAAO,CAAC,QAAQ,CAAkD;IAClE,OAAO,CAAC,KAAK,CAAyD;IACtE,OAAO,CAAC,SAAS,CAAiB;IAClC,OAAO,CAAC,WAAW,CAA4C;IAC/D,OAAO,CAAC,OAAO,CAAgE;IAC/E,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAyB;IAC1D,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,UAAU,CAAiB;IACnC,OAAO,CAAC,UAAU,CAAiB;IACnC,OAAO,CAAC,QAAQ,CAAiB;IACjC,OAAO,CAAC,SAAS,CAAgB;IACjC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAyB;IAExD,YAAoB,OAAO,GAAE,aAAkB,EAAI;IAEnD,uEAAuE;IACvE,WAAW,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,QAI3B;IAED,sFAAsF;IACtF,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,QAGhD;IAED,mGAAmG;IACnG,QAAQ,CAAC,KAAK,EAAE,SAAS,QAIxB;IAED,uGAAuG;IACvG,eAAe,CAAC,MAAM,EAAE,SAAS,WAAW,EAAE,GAAG,SAAS,EAAE,WAAW,EAAE,MAAM,GAAG,SAAS,QAK1F;IAED,wEAAwE;IACxE,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,QAKrC;IAED,yFAAyF;IACzF,aAAa,CAAC,EAAE,EAAE,OAAO,QAIxB;IAED,kEAAkE;IAClE,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,QAInC;IAED,gGAAgG;IAChG,OAAO,CAAC,aAAa;IAMrB,mFAAmF;IACnF,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,EAAE,YAAY,EAAE,MAAM,GAAG,SAAS,QAKvE;IAID,0FAA0F;IAC1F,MAAM,CAAC,QAAQ,EAAE,cAAc,EAAE,KAAK,EAAE,SAAS,GAAG,MAAM,IAAI,CAyD7D;IAED,sEAAsE;IACtE,YAAY,SAgBX;IAID,OAAO,CAAC,OAAO;IA+Bf,OAAO,CAAC,MAAM;IAMd,8EAA8E;IAC9E,QAAQ,SAgEP;IAED,mFAAmF;IACnF,OAAO,CAAC,OAAO;IAyCf,OAAO,CAAC,QAAQ;IAgBhB,OAAO,CAAC,cAAc;IAetB,4DAA4D;IAC5D,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,GAAG,SAAS,QAahD;IAED,2CAA2C;IAC3C,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,QAgBjC;IAED,4EAA4E;IAC5E,OAAO,CAAC,YAAY;IAcpB,UAAU,QAAO,OAAO,CAAiB;IAEzC,gBAAgB,aAAc,MAAM,IAAI,KAAG,CAAC,MAAM,IAAI,CAAC,CAKrD;IAEF,OAAO,CAAC,WAAW;IAOnB,6EAA6E;IAC7E,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,GAAG,MAAM,CAe1D;IAED,yFAAyF;IACzF,eAAe,aAAc,MAAM,IAAI,KAAG,CAAC,MAAM,IAAI,CAAC,CAKpD;IAIF,QAAQ,SAMP;IAED,iEAAiE;IACjE,IAAI,SASH;IAED,qEAAqE;IACrE,UAAU,IAAI,SAAS,MAAM,EAAE,CAE9B;IAED,OAAO,CAAC,YAAY;IAepB,mDAAmD;IACnD,OAAO,CAAC,IAAI;IAIZ,OAAO,CAAC,KAAK;IAiFb,OAAO,CAAC,OAAO;IAiBf,OAAO,CAAC,SAAS;IA0FjB,OAAO,CAAC,SAAS;IAyBjB,iGAAiG;IACjG,OAAO,CAAC,aAAa;IAqDrB,OAAO,CAAC,WAAW;IAoFnB,sGAAsG;IACtG,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAgBhE;IAED,8EAA8E;IAC9E,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAEnC;IAED;;;;OAIG;IACH,OAAO,CAAC,UAAU;IAkClB,OAAO,CAAC,UAAU;IAmDlB,sFAAsF;IACtF,OAAO,CAAC,WAAW;IASnB,oDAAoD;IACpD,OAAO,CAAC,QAAQ;IAIhB,iGAAiG;IACjG,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG;QAAE,MAAM,EAAE,UAAU,CAAC;QAAC,IAAI,EAAE,QAAQ,CAAA;KAAE,GAAG,IAAI,CASxF;IAED,gHAAgH;IAChH,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,CAMxD;IAED,kGAAkG;IAClG,OAAO,CAAC,SAAS;IA+BjB,gEAAgE;IAChE,OAAO,CAAC,SAAS;IAQjB;;;OAGG;IACH,OAAO,CAAC,UAAU;CA6DnB"}