sempdf — TypeScript PDF generation and editing

sempdf / PdfStructureContainer

Defined in: src/document.ts:885

Constructors

Constructor

new PdfStructureContainer(
   page, 
   embeddedFonts, 
   node, 
   fontFamilies?, 
   textDefaults?): PdfStructureContainer;

Defined in: src/document.ts:895

Creates a structure container bound to a page, embedded fonts, and parent structure node.

Parameters

Parameter	Type	Description
`page`	`InternalPageModel`	The internal page model to write into.
`embeddedFonts`	`ReadonlyMap`<`string`, `ParsedTrueTypeFont`>	The embedded font registry used for text layout.
`node`	`InternalStructureNode`	The parent structure node for tagged content.
`fontFamilies`	`ReadonlyMap`<`string`, `FontFamilyFaces`>	Font families registered with the document.
`textDefaults?`	`TextDefaults`	Document-wide text defaults.

Returns

PdfStructureContainer

Methods

bmp()

bmp(data, options): this;

Defined in: src/document.ts:1042

Adds a tagged BMP image to this structure container.

Parameters

Parameter	Type	Description
`data`	`BinaryData`	The binary image or font data.
`options`	`BmpImageOptions`	Options that control the operation.

Returns

this

circle()

circle(
   cx, 
   cy, 
   radius, 
   style?): this;

Defined in: src/document.ts:1189

Draws a circle. See PdfPage.circle.

Parameters

Parameter	Type
`cx`	`number`
`cy`	`number`
`radius`	`number`
`style?`	`ShapeStyle`

Returns

this

container()

Creates a nested tagged structure container.

Param

The structure tag to create.

Param

Either structure options or a build callback.

Param

An optional build callback when options are provided separately.

Call Signature

container(tag, build?): PdfStructureContainer;

Defined in: src/document.ts:1217

Creates a nested tagged structure container.

Parameters

Parameter	Type	Description
`tag`	`PdfContainerTag`	The structure tag to create.
`build?`	(`container`) => `void`	An optional callback that receives the created container.

Returns

PdfStructureContainer

The created structure container.

Call Signature

container(
   tag, 
   options?, 
   build?): PdfStructureContainer;

Defined in: src/document.ts:1230

Creates a nested tagged structure container.

Parameters

Parameter	Type	Description
`tag`	`PdfContainerTag`	The structure tag to create.
`options?`	`PdfStructureOptions`	Options that control the operation.
`build?`	(`container`) => `void`	An optional callback that receives the created container.

Returns

PdfStructureContainer

The created structure container.

ellipse()

ellipse(
   cx, 
   cy, 
   rx, 
   ry, 
   style?): this;

Defined in: src/document.ts:1196

Draws an ellipse. See PdfPage.ellipse.

Parameters

Parameter	Type
`cx`	`number`
`cy`	`number`
`rx`	`number`
`ry`	`number`
`style?`	`ShapeStyle`

Returns

this

flow()

flow(options?): PdfFlow;

Defined in: src/document.ts:1344

Creates a flow helper that writes into this structure container.

Parameters

Parameter	Type	Description
`options`	`FlowOptions`	Options that control the operation.

Returns

PdfFlow

The created flow helper.

gif()

gif(data, options): this;

Defined in: src/document.ts:1097

Adds a tagged GIF image to this structure container.

Parameters

Parameter	Type	Description
`data`	`BinaryData`	The binary image or font data.
`options`	`GifImageOptions`	Options that control the operation.

Returns

this

image()

image(data, options): this;

Defined in: src/document.ts:1164

Adds a raster image (auto-detecting the format) tagged under this container.

Parameters

Parameter	Type	Description
`data`	`BinaryData`	The image bytes.
`options`	`JpegImageOptions`	Placement and tagging options.

Returns

this

jbig2()

jbig2(data, options): this;

Defined in: src/document.ts:1053

Adds a tagged JBIG2 image to this structure container.

Parameters

Parameter	Type	Description
`data`	`BinaryData`	The binary image or font data.
`options`	`Jbig2ImageOptions`	Options that control the operation.

Returns

this

jp2()

jp2(data, options): this;

Defined in: src/document.ts:1075

Adds a tagged JPEG 2000 image to this structure container.

Parameters

Parameter	Type	Description
`data`	`BinaryData`	The binary image or font data.
`options`	`Jp2ImageOptions`	Options that control the operation.

Returns

this

jpeg()

jpeg(data, options): this;

Defined in: src/document.ts:1020

Adds a tagged JPEG image to this structure container.

Parameters

Parameter	Type	Description
`data`	`BinaryData`	The binary image or font data.
`options`	`JpegImageOptions`	Options that control the operation.

Returns

this

line()

line(
   x1, 
   y1, 
   x2, 
   y2, 
   style?): this;

Defined in: src/document.ts:1179

Draws a straight line between two points. See PdfPage.line.

Parameters

Parameter	Type
`x1`	`number`
`y1`	`number`
`x2`	`number`
`y2`	`number`
`style?`	`ShapeStyle`

Returns

this

link()

link(url, options): this;

Defined in: src/document.ts:1120

Adds a tagged URI link annotation to this structure container.

Parameters

Parameter	Type	Description
`url`	`string`	The URI target.
`options`	`UriLinkOptions`	Options that control the operation.

Returns

this

linkToPage()

linkToPage(target, options): this;

Defined in: src/document.ts:1133

Adds a tagged internal page-link annotation nested under this container, so the Link structure element becomes a child of this node (e.g. a TOCI) rather than a page-level root.

Parameters

Parameter	Type	Description
`target`	`PdfPage`	The page to navigate to.
`options`	`PageLinkOptions`	Link rectangle and tagging options.

Returns

this

list()

list(items, options): this;

Defined in: src/document.ts:945

Adds a tagged list to this structure container.

Parameters

Parameter	Type	Description
`items`	readonly `ListItem`[]	The list items to add.
`options`	`ListOptions`	Options that control the operation.

Returns

this

path()

path(commands, style): this;

Defined in: src/document.ts:1203

Adds vector path commands. Mirrors PdfPage.path.

Parameters

Parameter	Type
`commands`	`PathCommand`[]
`style`	`PathStyle`

Returns

this

png()

png(data, options): this;

Defined in: src/document.ts:1031

Adds a tagged PNG image to this structure container.

Parameters

Parameter	Type	Description
`data`	`BinaryData`	The binary image or font data.
`options`	`PngImageOptions`	Options that control the operation.

Returns

this

rect()

rect(
   x, 
   y, 
   width, 
   height, 
   style?): this;

Defined in: src/document.ts:1172

Draws a rectangle. See PdfPage.rect.

Parameters

Parameter	Type
`x`	`number`
`y`	`number`
`width`	`number`
`height`	`number`
`style?`	`ShapeStyle`

Returns

this

structure()

Creates a nested tagged structure container.

Param

The replacement structure role.

Param

Either structure options or a build callback.

Param

An optional build callback when options are provided separately.

Call Signature

structure(role, build?): PdfStructureContainer;

Defined in: src/document.ts:1281

Creates a nested tagged structure container.

Parameters

Parameter	Type	Description
`role`	\| `string` & `object` \| `PdfStandardStructureTag`	The replacement structure role.
`build?`	(`container`) => `void`	An optional callback that receives the created container.

Returns

PdfStructureContainer

The created structure container.

Call Signature

structure(
   role, 
   options?, 
   build?): PdfStructureContainer;

Defined in: src/document.ts:1294

Creates a nested tagged structure container.

Parameters

Parameter	Type	Description
`role`	\| `string` & `object` \| `PdfStandardStructureTag`	The replacement structure role.
`options?`	`PdfStructureOptions`	Options that control the operation.
`build?`	(`container`) => `void`	An optional callback that receives the created container.