Class PdfContext

Implements

Context

Index

Constructors

constructor

new PdfContext(options: ContextFactoryOptions): PdfContext
Parameters
- options: ContextFactoryOptions
Returns PdfContext
- Defined in index.ts:23

Methods

addPage

addPage(): void
Returns void
Implementation of Context.addPage
- Defined in index.ts:32

bezierCurveTo

bezierCurveTo(
    cp1x: number,
    cp1y: number,
    cp2x: number,
    cp2y: number,
    x: number,
    y: number,
): this
Parameters
- cp1x: number
- cp1y: number
- cp2x: number
- cp2y: number
- x: number
- y: number
Returns this
Implementation of Context.bezierCurveTo
- Defined in index.ts:140

dash

dash(length: number, options?: { space: number }): this
Parameters
- length: number
- Optionaloptions: { space: number }
Returns this
Implementation of Context.dash
- Defined in index.ts:120

end

end(): void
Returns void
Implementation of Context.end
- Defined in index.ts:45

fill

fill(rule?: "nonzero" | "evenodd"): this
Parameters
- Optionalrule: "nonzero" | "evenodd"
Returns this
Implementation of Context.fill
- Defined in index.ts:162

fillAndStroke

fillAndStroke(fillColor?: string, strokeColor?: string): this
Parameters
- OptionalfillColor: string
- OptionalstrokeColor: string
Returns this
Implementation of Context.fillAndStroke
- Defined in index.ts:172

fillColor

fillColor(color: string): this
Parameters
- color: string
Returns this
Implementation of Context.fillColor
- Defined in index.ts:105

font

font(family: string, size?: number): this
Parameters
- family: string
- Optionalsize: number
Returns this
Implementation of Context.font
- Defined in index.ts:65

getSize

getSize(): { height: number; width: number }
Returns { height: number; width: number }
Implementation of Context.getSize
- Defined in index.ts:398

image

image(
    source: string | Uint8Array<ArrayBufferLike>,
    x: number,
    y: number,
    options?: ContextImageOptions,
): this
Parameters
- source: string | Uint8Array<ArrayBufferLike>
- x: number
- y: number
- Optionaloptions: ContextImageOptions
Returns this
Implementation of Context.image
- Defined in index.ts:389

lineTo

lineTo(x: number, y: number): this
Parameters
- x: number
- y: number
Returns this
Implementation of Context.lineTo
- Defined in index.ts:135

lineWidth

lineWidth(width: number): this
Parameters
- width: number
Returns this
Implementation of Context.lineWidth
- Defined in index.ts:115

moveTo

moveTo(x: number, y: number): this
Parameters
- x: number
- y: number
Returns this
Implementation of Context.moveTo
- Defined in index.ts:130

opacity

opacity(opacity: number): this
Parameters
- opacity: number
Returns this
Implementation of Context.opacity
- Defined in index.ts:100

pipe

pipe(stream: VmprintOutputStream): void
Parameters
- stream: VmprintOutputStream
Returns void
Implementation of Context.pipe
- Defined in index.ts:36

rect

rect(x: number, y: number, w: number, h: number): this
Parameters
- x: number
- y: number
- w: number
- h: number
Returns this
Implementation of Context.rect
- Defined in index.ts:152

registerFont

registerFont(
    id: string,
    buffer: Uint8Array,
    options?: ContextFontRegistrationOptions,
): Promise<void>
Parameters
- id: string
- buffer: Uint8Array
- Optionaloptions: ContextFontRegistrationOptions
Returns Promise<void>
Implementation of Context.registerFont
- Defined in index.ts:51

restore

restore(): void
Returns void
Implementation of Context.restore
- Defined in index.ts:82

rotate

rotate(angle: number, originX?: number, originY?: number): this
Parameters
- angle: number
- OptionaloriginX: number
- OptionaloriginY: number
Returns this
Implementation of Context.rotate
- Defined in index.ts:91

roundedRect

roundedRect(x: number, y: number, w: number, h: number, r: number): this
Parameters
- x: number
- y: number
- w: number
- h: number
- r: number
Returns this
Implementation of Context.roundedRect
- Defined in index.ts:157

save

save(): void
Returns void
Implementation of Context.save
- Defined in index.ts:78

showShapedGlyphs

showShapedGlyphs(
    fontId: string,
    fontSize: number,
    color: string,
    x: number,
    y: number,
    ascent: number,
    glyphs: ContextShapedGlyph[],
): this
Emit pre-shaped glyphs directly to the PDF stream using their fontkit glyph IDs. This bypasses PDFKit's text()/encode() path, which would re-run shaping and lose the contextual glyph substitutions (init/medi/fina/liga) computed at layout time. Required for correct rendering of Arabic and other RTL/CTL scripts.
Parameters
- fontId: string
- fontSize: number
- color: string
- x: number
- y: number
- ascent: number
- glyphs: ContextShapedGlyph[]
Returns this
Implementation of Context.showShapedGlyphs
- Defined in index.ts:255

stroke

stroke(): this
Returns this
Implementation of Context.stroke
- Defined in index.ts:167

strokeColor

strokeColor(color: string): this
Parameters
- color: string
Returns this
Implementation of Context.strokeColor
- Defined in index.ts:110

text

text(str: string, x: number, y: number, options?: ContextTextOptions): this
Parameters
- str: string
- x: number
- y: number
- Optionaloptions: ContextTextOptions
Returns this
Implementation of Context.text
- Defined in index.ts:183

translate

translate(x: number, y: number): this
Parameters
- x: number
- y: number
Returns this
Implementation of Context.translate
- Defined in index.ts:86

undash

undash(): this
Returns this
Implementation of Context.undash
- Defined in index.ts:125

Class PdfContext

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns PdfContext

Methods

addPage

Returns void

bezierCurveTo

Parameters

Returns this

dash

Parameters

Returns this

end

Returns void

fill

Parameters

Returns this

fillAndStroke

Parameters

Returns this

fillColor

Parameters

Returns this

font

Parameters

Returns this

fontSize

Parameters

Returns this

getSize

Returns { height: number; width: number }

image

Parameters

Returns this

lineTo

Parameters

Returns this

lineWidth

Parameters

Returns this

moveTo

Parameters

Returns this

opacity

Parameters

Returns this

pipe

Parameters

Returns void

rect

Parameters

Returns this

registerFont

Parameters

Returns Promise<void>

restore

Returns void

rotate

Parameters

Returns this

roundedRect

Parameters

Returns this

save

Returns void

showShapedGlyphs

Parameters

Returns this

stroke

Returns this

strokeColor

Parameters

Returns this

text