@sheetxl/sdk 0.8.0-beta.12 → 0.8.0-beta.14

package/types/src/text/_LineBox.d.ts

@@ -0,0 +1,24 @@
+import { IFont } from '../font/IFont';
+/** A line of text at a size, in whole px. */
+export interface LineBox {
+    /** What a line advances by. */
+    readonly lineHeight: number;
+    /** The leading around the font's box: `lineHeight` less ascent and descent. */
+    readonly lineGap: number;
+    /** The baseline's offset from the top of the line: half the leading above, then the ascent. */
+    readonly baseline: number;
+}
+/**
+ * How tall a line of text is in a face at `px` pixels per em, in whole px: the layout's choice of
+ * leading. Without one a line is as tall as the font's own metrics ask.
+ */
+export type LineHeightRule = (table: IFont.AdvanceTable, px: number) => number;
+/**
+ * A line `lineHeight` tall around a font's box: the leading split above and below, the half above
+ * floored (as a browser lays out a CSS line box). A line shorter than the box leaves the baseline
+ * at the ascent. `LineBox::around` in `sheetxl-text` is the same rule.
+ */
+export declare function lineBoxAround(metrics: Pick<IFont.Metrics, 'ascent' | 'descent'>, lineHeight: number): LineBox;
+/** The line `rule` gives text in `table`'s face at `px`, or the font's own without one. */
+export declare function lineBox(table: IFont.AdvanceTable, px: number, rule?: LineHeightRule | null): LineBox;
+//# sourceMappingURL=_LineBox.d.ts.map

package/types/src/text/_TextUtils.d.ts

@@ -3,15 +3,17 @@ import { IFontCollection } from '../font';
 import { ITextFrame } from './ITextFrame';
 import { ITextBoxAlignment } from './TextBoxAlignment';
 import { IFontStyle } from '../font/IFontStyle';
+import { LineHeightRule } from './_LineBox';
 /**
  * This 'places' text which means that using all of the formatting rules it assign's locations and bounds to
  * all of the characters. It does not however actually render them. See @renderTextFrame for rendering.
  *
  * @param textFrame
  * @param dimensions
+ * @param lineHeight How tall each line is; the font's own line without one.
  * @param fonts Where fonts are measured from; the shared collection by default.
  */
-export declare function layoutTextFrame(textFrame: ITextFrame, defaultFont: IFontStyle, alignment: ITextBoxAlignment, dimensions?: Partial<Size> | null, fonts?: IFontCollection): ITextFrame;
+export declare function layoutTextFrame(textFrame: ITextFrame, defaultFont: IFontStyle, alignment: ITextBoxAlignment, dimensions?: Partial<Size> | null, lineHeight?: LineHeightRule | null, fonts?: IFontCollection): ITextFrame;
 /**
  * Checks whether a string is entirely uppercase, lowercase, or mixed case.
  *
@@ -84,7 +86,8 @@ export declare function convertCase(str: string, caseArray: readonly number[]):
  * Create a simple text frame.
  * TODO - Later we will make take frame take the style (and theme?) and have more operations on it.
  * TODO - abstract CellStyle
+ * @param lineHeight How tall each line is when laid out; the font's own line without one.
  * @internal
  */
-export declare function createTextFrameFromText(text: string, defaultFont: IFontStyle, alignment: ITextBoxAlignment, allowWrap: boolean, disableCustomFormatting?: boolean): ITextFrame;
+export declare function createTextFrameFromText(text: string, defaultFont: IFontStyle, alignment: ITextBoxAlignment, allowWrap: boolean, disableCustomFormatting?: boolean, lineHeight?: LineHeightRule | null): ITextFrame;
 //# sourceMappingURL=_TextUtils.d.ts.map

package/types/src/text/_TextWrapperFallback.d.ts

@@ -25,7 +25,8 @@ export declare class TextWrapperFallback {
     private _maxHeight;
     /** One character's advance in px, by character, for the current wrap. */
     private _advances;
-    private _metrics;
+    /** The line every wrapped line takes. */
+    private _line;
     /** The current line from its start to {@link _charactersRead}. */
     private _lineTally;
     /**

package/types/src/wasm/sdkWasm.d.ts

@@ -14,7 +14,7 @@ export type { SdkWasmExports } from './_sdkWasm';
  * @example
  * ```ts
  * const wasm = await SdkWasm.load();
- * wasm.line_pitch(12, 3); // 17
+ * wasm.char_count('abc'); // 3
  * ```
  */
 export declare const SdkWasm: {

package/types/src/workbook/Workbook.d.ts

@@ -330,16 +330,6 @@ export declare class Workbook implements IWorkbook {
     getCell(address?: ICell.Address): ICell;
     /** {@inheritDoc IWorkbook.getRanges} */
     getRanges(address: ICellRanges.Address, options?: ICellRange.GetRangeOptions): ICellRanges;
-    /**
-     * A calculation-graph answer: cell coords plus defined-name NODES, one `ICellRanges`.
-     *
-     * @remarks
-     * Backs `Calculation.ConstructorOptions.createGraphRanges` — the seam where the calculation
-     * layer's graph facts become ranges. Each node becomes a {@link NamedCellRange} anchored at the
-     * name's defining cell (DESIGN-NAMED-FORMULAS.md §4.1); a node whose anchor sheet cannot be
-     * resolved falls back to the selected sheet, which is the same self-consistent-but-arbitrary
-     * anchor its body was compiled against. Names lead, cells follow — the name is the heavier fact.
-     */
     protected _createGraphRanges(cells: readonly IRange.Coords[], names: readonly NamedNodeInfo[]): ICellRanges | null;
     /** {@inheritDoc IWorkbook.getAnomalies} */
     getAnomalies(options?: ICellRange.GetAnomaliesOptions): ICellRegions;