PDFPageWriter

Defined in: writer.ts:11

Constructor writer.ts:29

new PDFPageWriter(pdf, page): PDFPageWriter

Parameters

Parameter	Type
pdf	PDFEngine
page	PDFPageObject

Returns

PDFPageWriter

Properties

Property	Modifier	Type
contentStream writer.ts:14	public	PDFIndirectStreamObject
margin writer.ts:27	public	object
bottom writer.ts:27	public	number
left writer.ts:27	public	number
right writer.ts:27	public	number
top writer.ts:27	public	number
pdf writer.ts:12	public	PDFEngine

Methods

applyColorOpacity() writer.ts:54

applyColorOpacity(color, type): void

Parameters

Parameter	Type
color	Color
type	"fill" | "stroke"

Returns

void

drawImage() writer.ts:360

drawImage(imageKey, x, y, width, height): this

Parameters

Parameter	Type
imageKey	string
x	number
y	number
width	number
height	number

Returns

this

drawLine() writer.ts:308

drawLine(x1, y1, x2, y2, strokeWidth?, strokeColor?, dashPattern?, dashPhase?): this

Parameters

Parameter	Type	Default value
x1	number	undefined
y1	number	undefined
x2	number	undefined
y2	number	undefined
strokeWidth	number	1
strokeColor	string | Color	"0 G"
dashPattern?	number[]	undefined
dashPhase?	number	0

Returns

this

drawRect() writer.ts:273

drawRect(x, y, width, height, strokeWidth?, strokeColor?, fillColor?): this

Parameters

Parameter	Type	Default value
x	number	undefined
y	number	undefined
width	number	undefined
height	number	undefined
strokeWidth	number	1
strokeColor	string | Color	"0 G"
fillColor?	string | Color	undefined

Returns

this

drawText() writer.ts:104

drawText(text, options): this

Parameters

Parameter	Type
text	string
options	object
charSpacing?	number
color?	string | Color
lineHeight?	number
maxWidth?	number
x	number
y	number

Returns

this

drawTextLine() writer.ts:255

drawTextLine(text, x, y, color?, charSpacing?): this

Parameters

Parameter	Type
text	string
x	number
y	number
color?	string | Color
charSpacing?	number

Returns

this

getPageHeight() writer.ts:18

getPageHeight(): number

Returns the page height in user units (from MediaBox).

Returns

number

getTextWidth() writer.ts:238

getTextWidth(text, charSpacing?): number

Parameters

Parameter	Type	Default value
text	string	undefined
charSpacing	number	0

Returns

number

registerXObject() writer.ts:342

registerXObject(xObject): string

Parameters

Parameter	Type
xObject	any

Returns

string

setFont() writer.ts:70

setFont(font, size): this

Parameters

Parameter	Type
font	string | PDFType0FontObject
size	number

Returns

this

writeCommands() writer.ts:374

writeCommands(cmds): this

Parameters

Parameter	Type
cmds	string[]

Returns

this