@laminapdf/sdk 0.2.0-alpha.2 → 0.2.0-alpha.4

package/docs/api/interfaces/PageTextOptions.md

@@ -0,0 +1,21 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / PageTextOptions
+
+# Interface: PageTextOptions
+
+Options for [PageRef.text](../classes/PageRef.md#text).
+
+## Properties
+
+### skipInvisible?
+
+> `readonly` `optional` **skipInvisible?**: `boolean`
+
+Leave out text drawn invisibly (rendering modes 3 and 7: OCR layers, hidden text).

package/docs/api/interfaces/PathBuilder.md

@@ -0,0 +1,195 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / PathBuilder
+
+# Interface: PathBuilder
+
+Builds a path in page space; every method returns the builder, so calls chain.
+
+## Methods
+
+### circle()
+
+> **circle**(`center`, `radius`): `PathBuilder`
+
+A circle around `center`.
+
+#### Parameters
+
+##### center
+
+[`Point`](../type-aliases/Point.md)
+
+##### radius
+
+`number`
+
+#### Returns
+
+`PathBuilder`
+
+***
+
+### close()
+
+> **close**(): `PathBuilder`
+
+Closes the subpath.
+
+#### Returns
+
+`PathBuilder`
+
+***
+
+### cubicTo()
+
+> **cubicTo**(`x1`, `y1`, `x2`, `y2`, `x`, `y`): `PathBuilder`
+
+A cubic Bézier curve through two control points to (x, y).
+
+#### Parameters
+
+##### x1
+
+`number`
+
+##### y1
+
+`number`
+
+##### x2
+
+`number`
+
+##### y2
+
+`number`
+
+##### x
+
+`number`
+
+##### y
+
+`number`
+
+#### Returns
+
+`PathBuilder`
+
+***
+
+### ellipse()
+
+> **ellipse**(`rect`): `PathBuilder`
+
+The ellipse inscribed in a rectangle.
+
+#### Parameters
+
+##### rect
+
+[`Rect`](../type-aliases/Rect.md)
+
+#### Returns
+
+`PathBuilder`
+
+***
+
+### lineTo()
+
+> **lineTo**(`x`, `y`): `PathBuilder`
+
+A straight line to (x, y).
+
+#### Parameters
+
+##### x
+
+`number`
+
+##### y
+
+`number`
+
+#### Returns
+
+`PathBuilder`
+
+***
+
+### moveTo()
+
+> **moveTo**(`x`, `y`): `PathBuilder`
+
+Starts a subpath at (x, y).
+
+#### Parameters
+
+##### x
+
+`number`
+
+##### y
+
+`number`
+
+#### Returns
+
+`PathBuilder`
+
+***
+
+### quadTo()
+
+> **quadTo**(`x1`, `y1`, `x`, `y`): `PathBuilder`
+
+A quadratic Bézier curve through one control point to (x, y).
+
+#### Parameters
+
+##### x1
+
+`number`
+
+##### y1
+
+`number`
+
+##### x
+
+`number`
+
+##### y
+
+`number`
+
+#### Returns
+
+`PathBuilder`
+
+***
+
+### rect()
+
+> **rect**(`rect`): `PathBuilder`
+
+A rectangle: left, top, width, height.
+
+#### Parameters
+
+##### rect
+
+[`Rect`](../type-aliases/Rect.md)
+
+#### Returns
+
+`PathBuilder`

package/docs/api/interfaces/QuadPoint.md

@@ -0,0 +1,25 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / QuadPoint
+
+# Interface: QuadPoint
+
+A point in page space (ADR 0027: top-left of the displayed CropBox, y down, points).
+
+## Properties
+
+### x
+
+> `readonly` **x**: `number`
+
+***
+
+### y
+
+> `readonly` **y**: `number`

package/docs/api/interfaces/RangeOptions.md

@@ -0,0 +1,54 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / RangeOptions
+
+# Interface: RangeOptions
+
+How a range document fetches.
+
+## Properties
+
+### blockSize?
+
+> `readonly` `optional` **blockSize?**: `number`
+
+Fetches are widened to whole blocks of this many bytes (default: the source's, else 4096).
+
+***
+
+### budget?
+
+> `readonly` `optional` **budget?**: `number`
+
+The most bytes the document may hold (default: no limit); more is `source-budget-exceeded`.
+
+***
+
+### maxRounds?
+
+> `readonly` `optional` **maxRounds?**: `number`
+
+Rounds of fetches per call before giving up with the last `data-pending` (default 1024).
+
+***
+
+### readahead?
+
+> `readonly` `optional` **readahead?**: `number`
+
+Extra bytes fetched after each range (default 0).
+
+***
+
+### signal?
+
+> `readonly` `optional` **signal?**: `AbortSignal`
+
+Aborts the open's fetches: it rejects with the signal's reason. Later calls take their own
+signal ([Document.ensure](../classes/Document.md#ensure)).

package/docs/api/interfaces/RangeSource.md

@@ -0,0 +1,59 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / RangeSource
+
+# Interface: RangeSource
+
+Random access to a file whose bytes are fetched on demand (a remote file, a `Blob`, a file
+handle). `@laminapdf/viewer`'s document worker reads a `Blob` through it too.
+
+## Properties
+
+### blockSize?
+
+> `readonly` `optional` **blockSize?**: `number`
+
+The block size this source prefers fetches aligned to (HTTP: fewer, larger requests).
+
+***
+
+### size
+
+> `readonly` **size**: `number`
+
+The file's size in bytes.
+
+## Methods
+
+### read()
+
+> **read**(`offset`, `length`, `options?`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
+
+The `length` bytes at `offset` (exactly that many: the file is at least `offset + length`
+long). Rejects when `signal` aborts.
+
+#### Parameters
+
+##### offset
+
+`number`
+
+##### length
+
+`number`
+
+##### options?
+
+###### signal?
+
+`AbortSignal`
+
+#### Returns
+
+`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>

package/docs/api/interfaces/StrokeStyle.md

@@ -0,0 +1,61 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / StrokeStyle
+
+# Interface: StrokeStyle
+
+How strokes are drawn.
+
+## Properties
+
+### cap?
+
+> `readonly` `optional` **cap?**: `"butt"` \| `"round"` \| `"square"`
+
+Line ends (default `butt`).
+
+***
+
+### dash?
+
+> `readonly` `optional` **dash?**: readonly `number`[]
+
+Dash pattern in points (default: solid).
+
+***
+
+### dashPhase?
+
+> `readonly` `optional` **dashPhase?**: `number`
+
+Where the dash pattern starts (default 0).
+
+***
+
+### join?
+
+> `readonly` `optional` **join?**: `"round"` \| `"miter"` \| `"bevel"`
+
+Corners (default `miter`).
+
+***
+
+### miterLimit?
+
+> `readonly` `optional` **miterLimit?**: `number`
+
+Miter limit (default 10).
+
+***
+
+### width?
+
+> `readonly` `optional` **width?**: `number`
+
+Line width in points (default 1).

package/docs/api/interfaces/TagSpec.md

@@ -0,0 +1,69 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / TagSpec
+
+# Interface: TagSpec
+
+A structure element with attributes; `type` may be a custom name when `role` is given.
+
+## Properties
+
+### actualText?
+
+> `readonly` `optional` **actualText?**: `string`
+
+`/ActualText`: the exact text the content stands for.
+
+***
+
+### alt?
+
+> `readonly` `optional` **alt?**: `string`
+
+`/Alt`: alternate text (a `Figure` needs it).
+
+***
+
+### expansion?
+
+> `readonly` `optional` **expansion?**: `string`
+
+`/E`: the expansion of an abbreviation.
+
+***
+
+### lang?
+
+> `readonly` `optional` **lang?**: `string`
+
+`/Lang`: the element's language (BCP 47).
+
+***
+
+### role?
+
+> `readonly` `optional` **role?**: `"Document"` \| `"Part"` \| `"Sect"` \| `"H1"` \| `"H2"` \| `"H3"` \| `"H4"` \| `"H5"` \| `"H6"` \| `"P"` \| `"L"` \| `"LI"` \| `"Lbl"` \| `"LBody"` \| `"Table"` \| `"TR"` \| `"TH"` \| `"TD"` \| `"Figure"` \| `"Caption"` \| `"Link"` \| `"Span"` \| `"Quote"` \| `"Note"` \| `"Code"` \| `"THead"` \| `"TBody"` \| `"TFoot"` \| `"TOC"` \| `"TOCI"` \| `"Reference"` \| `"BlockQuote"`
+
+The standard type a custom `type` stands for.
+
+***
+
+### scope?
+
+> `readonly` `optional` **scope?**: `"row"` \| `"column"` \| `"both"`
+
+`/Scope` of a `TH`.
+
+***
+
+### type
+
+> `readonly` **type**: `"Document"` \| `"Part"` \| `"Sect"` \| `"H1"` \| `"H2"` \| `"H3"` \| `"H4"` \| `"H5"` \| `"H6"` \| `"P"` \| `"L"` \| `"LI"` \| `"Lbl"` \| `"LBody"` \| `"Table"` \| `"TR"` \| `"TH"` \| `"TD"` \| `"Figure"` \| `"Caption"` \| `"Link"` \| `"Span"` \| `"Quote"` \| `"Note"` \| `"Code"` \| `"THead"` \| `"TBody"` \| `"TFoot"` \| `"TOC"` \| `"TOCI"` \| `"Reference"` \| `"BlockQuote"` \| `string` & `object`
+
+A standard type, or a custom name written with a `RoleMap` entry to `role`.

package/docs/api/interfaces/TextBoxOptions.md

@@ -0,0 +1,93 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / TextBoxOptions
+
+# Interface: TextBoxOptions
+
+Options of [Surface.textBox](../classes/Surface.md#textbox).
+
+## Properties
+
+### align?
+
+> `readonly` `optional` **align?**: `AlignInit`
+
+Line alignment (default `start`).
+
+***
+
+### box
+
+> `readonly` **box**: [`Rect`](../type-aliases/Rect.md)
+
+The box the lines are broken into.
+
+***
+
+### direction?
+
+> `readonly` `optional` **direction?**: `DirectionInit`
+
+Paragraph direction.
+
+***
+
+### features?
+
+> `readonly` `optional` **features?**: readonly `string`[]
+
+OpenType features.
+
+***
+
+### font
+
+> `readonly` **font**: [`Font`](../classes/Font.md)
+
+The font (needs the text module).
+
+***
+
+### language?
+
+> `readonly` `optional` **language?**: `string`
+
+Language (BCP 47).
+
+***
+
+### lineHeight?
+
+> `readonly` `optional` **lineHeight?**: `number`
+
+Line height as a factor of the size (default 1.2).
+
+***
+
+### overflow?
+
+> `readonly` `optional` **overflow?**: `OverflowInit`
+
+What happens to text that doesn't fit (default `clip`; `error` throws `text-overflow`).
+
+***
+
+### size
+
+> `readonly` **size**: `number`
+
+Size in points.
+
+***
+
+### tag?
+
+> `readonly` `optional` **tag?**: [`Tag`](../type-aliases/Tag.md)
+
+The structure element the box is (as drawing it inside [Surface.tag](../classes/Surface.md#tag)).

package/docs/api/interfaces/TextGlyph.md

@@ -0,0 +1,29 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / TextGlyph
+
+# Interface: TextGlyph
+
+One glyph of a run.
+
+## Properties
+
+### quad
+
+> `readonly` **quad**: [`GlyphQuad`](../type-aliases/GlyphQuad.md)
+
+Its quad in page space.
+
+***
+
+### text
+
+> `readonly` **text**: `string`
+
+The glyph's text (document text; U+FFFD when its Unicode is unknown).

package/docs/api/interfaces/TextOptions.md

@@ -0,0 +1,101 @@
+---
+version: "0.2.0-alpha.4"
+---
+
+[**@laminapdf/sdk**](../README.md)
+
+***
+
+[@laminapdf/sdk](../README.md) / TextOptions
+
+# Interface: TextOptions
+
+Options of [Surface.text](../classes/Surface.md#text).
+
+## Properties
+
+### at
+
+> `readonly` **at**: [`Point`](../type-aliases/Point.md)
+
+Where the first line starts: `x`, and `y` is the baseline (ADR 0027 §5).
+
+***
+
+### direction?
+
+> `readonly` `optional` **direction?**: `DirectionInit`
+
+Paragraph direction (default: from the first strong character).
+
+***
+
+### features?
+
+> `readonly` `optional` **features?**: readonly `string`[]
+
+OpenType features (`liga=0`, `smcp`).
+
+***
+
+### fill?
+
+> `readonly` `optional` **fill?**: [`Color`](../type-aliases/Color.md)
+
+Fill colour.
+
+***
+
+### font
+
+> `readonly` **font**: [`Font`](../classes/Font.md)
+
+The font (needs the text module).
+
+***
+
+### language?
+
+> `readonly` `optional` **language?**: `string`
+
+Language (BCP 47).
+
+***
+
+### link?
+
+> `readonly` `optional` **link?**: `object`
+
+A link over the run.
+
+#### contents?
+
+> `readonly` `optional` **contents?**: `string`
+
+#### target
+
+> `readonly` **target**: `LinkTargetInit`
+
+***
+
+### renderMode?
+
+> `readonly` `optional` **renderMode?**: `RenderModeInit`
+
+Rendering mode (`invisible` for an OCR layer).
+
+***
+
+### size
+
+> `readonly` **size**: `number`
+
+Size in points.
+
+***
+
+### tag?
+
+> `readonly` `optional` **tag?**: [`Tag`](../type-aliases/Tag.md)
+
+The structure element the run is (as drawing it inside [Surface.tag](../classes/Surface.md#tag)).