Skip to content

PDFPageWriter ​

Defined in: writer.ts:11

Constructor writer.ts:29 ​

new PDFPageWriter(pdf, page): PDFPageWriter

Parameters ​

ParameterType
pdfPDFEngine
pagePDFPageObject

Returns ​

PDFPageWriter

Properties ​

PropertyModifierType
contentStream
writer.ts:14
publicPDFIndirectStreamObject
publicobject
bottom
writer.ts:27
publicnumber
left
writer.ts:27
publicnumber
right
writer.ts:27
publicnumber
top
writer.ts:27
publicnumber
pdf
writer.ts:12
publicPDFEngine

Methods ​

applyColorOpacity() writer.ts:54 ​

applyColorOpacity(color, type): void

Parameters ​

ParameterType
colorColor
type"fill" | "stroke"

Returns ​

void

drawImage() writer.ts:360 ​

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

Parameters ​

ParameterType
imageKeystring
xnumber
ynumber
widthnumber
heightnumber

Returns ​

this

drawLine() writer.ts:308 ​

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

Parameters ​

ParameterTypeDefault value
x1numberundefined
y1numberundefined
x2numberundefined
y2numberundefined
strokeWidthnumber1
strokeColorstring | Color"0 G"
dashPattern?number[]undefined
dashPhase?number0

Returns ​

this

drawRect() writer.ts:273 ​

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

Parameters ​

ParameterTypeDefault value
xnumberundefined
ynumberundefined
widthnumberundefined
heightnumberundefined
strokeWidthnumber1
strokeColorstring | Color"0 G"
fillColor?string | Colorundefined

Returns ​

this

drawText() writer.ts:104 ​

drawText(text, options): this

Parameters ​

ParameterType
textstring
object
charSpacing?number
color?string | Color
lineHeight?number
maxWidth?number
xnumber
ynumber

Returns ​

this

drawTextLine() writer.ts:255 ​

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

Parameters ​

ParameterType
textstring
xnumber
ynumber
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 ​

ParameterTypeDefault value
textstringundefined
charSpacingnumber0

Returns ​

number

registerXObject() writer.ts:342 ​

registerXObject(xObject): string

Parameters ​

ParameterType
xObjectany

Returns ​

string

setFont() writer.ts:70 ​

setFont(font, size): this

Parameters ​

ParameterType
fontstring | PDFType0FontObject
sizenumber

Returns ​

this

writeCommands() writer.ts:374 ​

writeCommands(cmds): this

Parameters ​

ParameterType
cmdsstring[]

Returns ​

this

Released under the MIT License.