These docs describe changes that aren’t released yet. For the newest release, see the released docs.
Page
A page being drawn: its boxes and rotation, its Surface, then Page.finish. Freed
with its builder; using or Page.free drops it without writing it.
Methods
Section titled “Methods”[dispose]()
Section titled “[dispose]()”[dispose]():
void
Drops the page at the end of a using block (an alias of free()).
Returns
Section titled “Returns”void
artBox()
Section titled “artBox()”artBox(
rect):this
/ArtBox.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”this
bleedBox()
Section titled “bleedBox()”bleedBox(
rect):this
/BleedBox.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”this
cropBox()
Section titled “cropBox()”cropBox(
rect):this
/CropBox (the visible region), in the media box’s page space.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”this
finish()
Section titled “finish()”finish():
string
Writes the page into its builder and frees the page’s WASM side; the page takes no more
drawing afterwards (builder-finished).
Returns
Section titled “Returns”string
the page’s ID.
Throws
Section titled “Throws”LaminaPdfError invalid-geometry, builder-finished.
free()
Section titled “free()”free():
void
Drops the page without writing it and frees its WASM side; a second call does nothing, and
any other call afterwards throws disposed.
Returns
Section titled “Returns”void
rotate()
Section titled “rotate()”rotate(
degrees):this
/Rotate: 0, 90, 180 or 270 degrees.
Parameters
Section titled “Parameters”degrees
Section titled “degrees”0 | 90 | 180 | 270
Returns
Section titled “Returns”this
surface()
Section titled “surface()”surface():
Surface
What the page is drawn with (the same object on every call).
Returns
Section titled “Returns”trimBox()
Section titled “trimBox()”trimBox(
rect):this
/TrimBox.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”this
userUnit()
Section titled “userUnit()”userUnit(
unit):this
/UserUnit, for pages larger than 14,400 units.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”this