Class PdfFontManager

Manages font embedding in PDF documents. Provides methods to embed TrueType and other font formats.

Index

Constructors

Methods

embedFromFile embedStandardFont embedTrueTypeFont embedTrueTypeFontUnicode findFontByName getAllFonts getFont loadExistingFonts write

Constructors

constructor

new PdfFontManager(document: PdfDocument): PdfFontManager
Parameters
- document: PdfDocument
Returns PdfFontManager
- Defined in packages/pdf-lite/src/fonts/font-manager.ts:20

Methods

embedFromFile

embedFromFile(
    fontData: ByteArray,
    options?: {
        fontName?: string;
        unicode?: boolean;
        unicodeMappings?: Map<number, number>;
    },
): Promise<PdfFont>
Embeds a font from file data with automatic parsing and configuration. This is the recommended high-level API for embedding fonts.
Parameters
- fontData: ByteArray
  The font file bytes (TTF, OTF, or WOFF format)
- Optionaloptions: { fontName?: string; unicode?: boolean; unicodeMappings?: Map<number, number> }
  Optional configuration
  - OptionalfontName?: string
    Custom font name (defaults to PostScript name from font)
  - Optionalunicode?: boolean
    Use Unicode/Type0 encoding for non-ASCII characters
  - OptionalunicodeMappings?: Map<number, number>
    Custom CID to Unicode mappings for Type0 fonts
Returns Promise<PdfFont>
A PdfFont object representing the embedded font
Example
```
// Simple embedding with auto-generated name
const font = await document.fonts.embedFromFile(fontData)
field.font = font

// With custom name and Unicode support
const font = await document.fonts.embedFromFile(fontData, {
    fontName: 'MyCustomFont',
    unicode: true
})
```
- Defined in packages/pdf-lite/src/fonts/font-manager.ts:103

embedStandardFont

embedStandardFont(
    fontName:
        | "Helvetica"
        | "Helvetica-Bold"
        | "Helvetica-Oblique"
        | "Helvetica-BoldOblique"
        | "Times-Roman"
        | "Times-Bold"
        | "Times-Italic"
        | "Times-BoldItalic"
        | "Courier"
        | "Courier-Bold"
        | "Courier-Oblique"
        | "Courier-BoldOblique"
        | "Symbol"
        | "ZapfDingbats",
): Promise<PdfFont>
Embeds a standard PDF font (Type1). These fonts don't require font data as they're built into PDF viewers.
Parameters
- fontName:
      | "Helvetica"
      | "Helvetica-Bold"
      | "Helvetica-Oblique"
      | "Helvetica-BoldOblique"
      | "Times-Roman"
      | "Times-Bold"
      | "Times-Italic"
      | "Times-BoldItalic"
      | "Courier"
      | "Courier-Bold"
      | "Courier-Oblique"
      | "Courier-BoldOblique"
      | "Symbol"
      | "ZapfDingbats"
  One of the 14 standard PDF fonts
Returns Promise<PdfFont>
A PdfFont object representing the embedded font
- Defined in packages/pdf-lite/src/fonts/font-manager.ts:55

embedTrueTypeFont

embedTrueTypeFont(
    fontData: ByteArray,
    fontName: string,
    descriptor: FontDescriptor,
): Promise<PdfFont>
Embeds a TrueType font into the PDF document.
Parameters
- fontData: ByteArray
  The font file bytes
- fontName: string
  The name to use for this font in the PDF
- descriptor: FontDescriptor
  Font metrics and properties
Returns Promise<PdfFont>
A PdfFont object representing the embedded font
- Defined in packages/pdf-lite/src/fonts/font-manager.ts:36

embedTrueTypeFontUnicode

embedTrueTypeFontUnicode(
    fontData: ByteArray,
    fontName: string,
    descriptor: UnicodeFontDescriptor,
    unicodeMappings?: Map<number, number>,
): Promise<PdfFont>
Embeds a TrueType font with Unicode/Type0 support. Use this for fonts that need to display non-ASCII characters.
Parameters
- fontData: ByteArray
  The font file bytes
- fontName: string
  The name to use for this font in the PDF
- descriptor: UnicodeFontDescriptor
  Unicode font descriptor with CID metrics
- OptionalunicodeMappings: Map<number, number>
  Map of CID to Unicode code point for ToUnicode CMap
Returns Promise<PdfFont>
A PdfFont object representing the embedded font
- Defined in packages/pdf-lite/src/fonts/font-manager.ts:202

findFontByName

findFontByName(fontName: string): Promise<PdfFont | undefined>
Parameters
- fontName: string
Returns Promise<PdfFont | undefined>
- Defined in packages/pdf-lite/src/fonts/font-manager.ts:24

getAllFonts

getAllFonts(): Promise<Map<string, PdfFont>>
Gets all embedded fonts. Searches the PDF structure to find all fonts.

Returns Promise<Map<string, PdfFont>>
- Defined in packages/pdf-lite/src/fonts/font-manager.ts:188

getFont

getFont(fontName: string): Promise<PdfFont | undefined>
Gets the font reference by font name or resource name.
Parameters
- fontName: string
Returns Promise<PdfFont | undefined>
- Defined in packages/pdf-lite/src/fonts/font-manager.ts:146

loadExistingFonts

loadExistingFonts(): Promise<Map<string, PdfFont>>
Loads existing fonts from the PDF document. Traverses the page tree and extracts font information from page resources.

Returns Promise<Map<string, PdfFont>>
Map of font names to their PdfFont objects
- Defined in packages/pdf-lite/src/fonts/font-manager.ts:226

write

write(font: PdfFont): Promise<PdfFont>
Internal
Writes a font to the PDF document. Assigns resource name, creates container object, commits all objects, and registers it in page resources.
Parameters
- font: PdfFont
  The PdfFont instance to write
Returns Promise<PdfFont>
The font with its resourceName and container set
- Defined in packages/pdf-lite/src/fonts/font-manager.ts:160

Class PdfFontManager

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns PdfFontManager

Methods

embedFromFile

Parameters

`Optional`fontName?: string

`Optional`unicode?: boolean

`Optional`unicodeMappings?: Map<number, number>

Returns Promise<PdfFont>

Example

embedStandardFont

Parameters

Returns Promise<PdfFont>

embedTrueTypeFont

Parameters

Returns Promise<PdfFont>

embedTrueTypeFontUnicode

Parameters

Returns Promise<PdfFont>

findFontByName

Parameters

Returns Promise<PdfFont | undefined>

getAllFonts

Returns Promise<Map<string, PdfFont>>

getFont

Parameters

Returns Promise<PdfFont | undefined>

loadExistingFonts

Returns Promise<Map<string, PdfFont>>

write

Parameters

Returns Promise<PdfFont>

Settings

On This Page

Class PdfFontManager

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns PdfFontManager

Methods

embedFromFile

Parameters

OptionalfontName?: string

Optionalunicode?: boolean

OptionalunicodeMappings?: Map<number, number>

Returns Promise<PdfFont>

Example

embedStandardFont

Parameters

Returns Promise<PdfFont>

embedTrueTypeFont

Parameters

Returns Promise<PdfFont>

embedTrueTypeFontUnicode

Parameters

Returns Promise<PdfFont>

findFontByName

Parameters

Returns Promise<PdfFont | undefined>

getAllFonts

Returns Promise<Map<string, PdfFont>>

getFont

Parameters

Returns Promise<PdfFont | undefined>

loadExistingFonts

Returns Promise<Map<string, PdfFont>>

write

Parameters

Returns Promise<PdfFont>

Settings

On This Page

`Optional`fontName?: string

`Optional`unicode?: boolean

`Optional`unicodeMappings?: Map<number, number>