Surface

What a page is drawn with. Methods that set state return the surface, so calls chain; invalid geometry is reported by Page.finish (invalid-geometry).

Methods

artifact()

artifact(kind, draw): this

Draws what draw draws as an artifact: decoration, running heads and footers, backgrounds; content outside the structure tree.

Parameters

kind

"layout" | "page" | "pagination" | "background"

draw

(s) => void

Returns

this

---

blendMode()

blendMode(mode): this

The blend mode.

Parameters

mode

BlendMode

Returns

this

---

fillColor()

fillColor(color): this

The colour fills (and text) use.

Parameters

color

Color

Returns

this

---

image()

image(image, rect, alt?): this

Draws image scaled into rect; with alt, as a Figure structure element with that alternate text.

Parameters

image

Image

rect

Rect

alt?

string

Returns

this

---

link()

link(rect, target, contents?): this

A link annotation over rect, with contents as its alternate text.

Parameters

rect

Rect

target

LinkTargetInit

contents?

string

Returns

this

---

opacity()

opacity(fill, stroke): this

Fill and stroke opacity, 0 to 1.

Parameters

fill

number

stroke

number

Returns

this

---

path()

path(build): PendingPath

A path, built by build, to paint.

Parameters

build

(p) => void

Returns

PendingPath

Example

surface.path((p) => p.moveTo(56, 590).lineTo(539, 590)).stroke({ width: 0.5 });

---

restore()

restore(): this

Restores the graphics state (Q).

Returns

this

---

save()

save(): this

Saves the graphics state (q).

Returns

this

---

strokeColor()

strokeColor(color): this

The colour strokes use.

Parameters

color

Color

Returns

this

---

tag()

tag(tag, draw): this

Draws what draw draws inside the structure element tag: its text, paths and images become the element’s content, elements opened inside it its children, links its Link children, in reading order. Elements and artifacts draw leaves open end with it, also when it throws. A page using an element makes the document tagged.

Parameters

tag

Tag

draw

(s) => void

Returns

this

Example

s.tag("Sect", (s) => {
  s.text("Results", { font, size: 18, at: [56, 96], tag: "H1" });
  s.tag({ type: "P", lang: "en-GB" }, (s) => s.textBox(summary, { font, size: 11, box }));
});

Throws

LaminaError invalid-argument for an unknown type without a role.

---

text()

text(text, options): TextRunJs

Draws text: shaped, bidi-resolved, one line per line break (needs the text module).

Parameters

text

string

options

TextOptions

Returns

TextRunJs

what the run measures.

Throws

LaminaError text-module-not-loaded, missing-glyph, font-not-shapable, …

---

textBox()

textBox(text, options): TextLayoutJs

Lays text out in options.box, breaking lines at Unicode line-break opportunities.

Parameters

text

string

options

TextBoxOptions

Returns

TextLayoutJs

the lines drawn and where the overflow starts (UTF-16 offsets).

Throws

LaminaError as Surface.text; text-overflow with overflow: "error".

---

transform()

transform(matrix): this

Applies matrix (page space) to what is drawn next. See Matrix.

Parameters

matrix

Transform

Returns

this