Class: PdfStructureContainer

A builder for grouping tagged PDF content under a shared structure element. It can add text, blocks, lists, tables, images, and nested sections to the same semantic container.

Constructors

Constructor

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

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;

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;

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;

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;

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;

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;

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;

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;

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;

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;

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;

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;

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;

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

---

list()

list(items, options): this;

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;

Adds vector path commands. Mirrors PdfPage.path.

Parameters

Parameter	Type
commands	PathCommand[]
style	PathStyle

Returns

this

---

png()

png(data, options): this;

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;

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;

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;

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.

Returns

PdfStructureContainer

The created structure container.

---

svg()

svg(data, options): this;

Adds a tagged SVG graphic to this structure container.

Parameters

Parameter	Type	Description
data	string | BinaryData	The SVG text data.
options	SvgImageOptions	Options that control the operation.

Returns

this

---

table()

table(rows, options): this;

Adds a tagged table to this structure container.

Parameters

Parameter	Type	Description
rows	readonly TableRow[]	The table rows to add.
options	TableOptions	Options that control the operation.

Returns

this

---

text()

text(text, options): this;

Adds tagged text to this structure container.

Parameters

Parameter	Type	Description
text	string	The text to add.
options	TextOptions	Options that control the operation.

Returns

this

---

textBlock()

textBlock(text, options): this;

Adds a tagged multiline text block to this structure container.

Parameters

Parameter	Type	Description
text	string	The text to add.
options	TextBlockOptions	Options that control the operation.

Returns

this

---

tiff()

tiff(data, options): this;

Adds a tagged TIFF image to this structure container.

Parameters

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

Returns

this

---

webp()

webp(data, options): this;

Adds a tagged WebP image to this structure container.

Parameters

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

Returns

this