Class PdfFont

Represents an embedded font in a PDF document. Extends PdfDictionary to provide both font metadata and PDF dictionary structure.

Hierarchy (View Summary)

PdfDictionary<
    {
        BaseFont: PdfName;
        DescendantFonts?: PdfArray<PdfObjectReference>;
        Encoding?: PdfName;
        FirstChar?: PdfNumber;
        FontDescriptor?: PdfObjectReference;
        LastChar?: PdfNumber;
        Subtype: PdfName<"Type1" | "TrueType" | "Type0">;
        ToUnicode?: PdfObjectReference;
        Type: PdfName<"Font">;
        Widths?: PdfArray<PdfNumber>;
    },
>
- PdfFont

Constructors

constructor

new PdfFont(
    options: {
        container?: PdfIndirectObject<PdfObject>;
        descriptor?: FontDescriptor | UnicodeFontDescriptor;
        dict?: PdfDictionary<PdfDictionaryEntries>;
        encoding?: string;
        fontData?: ByteArray;
        fontName?: string;
        manager?: PdfFontManager;
        resourceName?: string;
    },
): PdfFont
Parameters
- options: {
      container?: PdfIndirectObject<PdfObject>;
      descriptor?: FontDescriptor | UnicodeFontDescriptor;
      dict?: PdfDictionary<PdfDictionaryEntries>;
      encoding?: string;
      fontData?: ByteArray;
      fontName?: string;
      manager?: PdfFontManager;
      resourceName?: string;
  }
Returns PdfFont
Overrides PdfDictionary.constructor
- Defined in packages/pdf-lite/src/fonts/pdf-font.ts:74

Properties

`Protected`auxiliaryObjects

auxiliaryObjects: PdfIndirectObject<PdfObject>[] = []

Auxiliary objects that must be committed along with the font dict. Includes FontDescriptor, FontFile2, CIDFont, ToUnicode, etc.

`Optional`container

container?: PdfIndirectObject<PdfObject>

Reference to the container indirect object that wraps this font dict. Set by FontManager.write() when the font is committed to the PDF.

innerTokens

innerTokens: PdfToken[] = []

`Protected`modified

modified: boolean = true

Indicates whether the object has been modified. By default, assume it has been modified because it's a new object

`Optional`postTokens

postTokens?: PdfToken[]

Optional tokens to prepend or append during serialization

`Optional`preTokens

preTokens?: PdfToken[]

Optional tokens to prepend or append during serialization

resourceName

resourceName: string

The PDF resource name used in content streams (e.g., 'F1', 'F2'). This is the identifier used in PDF operators like /F1 12 Tf.

Accessors

descriptor

get descriptor(): FontDescriptor | UnicodeFontDescriptor | undefined
Gets the font descriptor with metrics and properties. Available for embedded fonts, undefined for standard fonts or loaded fonts without descriptor.

Returns FontDescriptor | UnicodeFontDescriptor | undefined
- Defined in packages/pdf-lite/src/fonts/pdf-font.ts:130

encoding

get encoding(): string | undefined
Returns string | undefined
- Defined in packages/pdf-lite/src/fonts/pdf-font.ts:113
set encoding(enc: string | undefined): void
Parameters
- enc: string | undefined
Returns void
- Defined in packages/pdf-lite/src/fonts/pdf-font.ts:118

firstChar

get firstChar(): number | undefined
Gets the first character code in the Widths array.

Returns number | undefined
- Defined in packages/pdf-lite/src/fonts/pdf-font.ts:181
set firstChar(value: number | undefined): void
Sets the first character code in the Widths array.
Parameters
- value: number | undefined
Returns void
- Defined in packages/pdf-lite/src/fonts/pdf-font.ts:189

fontData

get fontData(): ByteArray | undefined
Gets the original font file bytes. Available for embedded fonts, undefined for standard fonts or loaded fonts.

Returns ByteArray | undefined
- Defined in packages/pdf-lite/src/fonts/pdf-font.ts:138

fontName

get fontName(): string | undefined
Returns string | undefined
- Defined in packages/pdf-lite/src/fonts/pdf-font.ts:97
set fontName(name: string | undefined): void
Parameters
- name: string | undefined
Returns void
- Defined in packages/pdf-lite/src/fonts/pdf-font.ts:105

fontRef

get fontRef(): PdfObjectReference
Internal
Legacy property for backward compatibility with code that accesses fontRef. Returns the container object if available.

Returns PdfObjectReference
- Defined in packages/pdf-lite/src/fonts/pdf-font.ts:267

fontType

get fontType(): "Type1" | "TrueType" | "Type0" | "MMType1" | "Type3" | undefined
Gets the font type (Subtype in PDF).

Returns "Type1" | "TrueType" | "Type0" | "MMType1" | "Type3" | undefined
- Defined in packages/pdf-lite/src/fonts/pdf-font.ts:145
set fontType(
type: "Type1" | "TrueType" | "Type0" | "MMType1" | "Type3" | undefined,
): void
Sets the font type (Subtype in PDF).
Parameters
- type: "Type1" | "TrueType" | "Type0" | "MMType1" | "Type3" | undefined
Returns void
- Defined in packages/pdf-lite/src/fonts/pdf-font.ts:165

lastChar

get lastChar(): number | undefined
Gets the last character code in the Widths array.

Returns number | undefined
- Defined in packages/pdf-lite/src/fonts/pdf-font.ts:200
set lastChar(value: number | undefined): void
Sets the last character code in the Widths array.
Parameters
- value: number | undefined
Returns void
- Defined in packages/pdf-lite/src/fonts/pdf-font.ts:208

objectType

get objectType(): string
The type of this PDF object

Returns string
Inherited from PdfDictionary.objectType
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:17

values

get values(): { readonly [K in string]: T[K] }
Returns { readonly [K in string]: T[K] }
Inherited from PdfDictionary.values
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:94

widths

get widths(): number[] | undefined
Gets the character widths array.

Returns number[] | undefined
- Defined in packages/pdf-lite/src/fonts/pdf-font.ts:219
set widths(values: number[] | undefined): void
Sets the character widths array.
Parameters
- values: number[] | undefined
Returns void
- Defined in packages/pdf-lite/src/fonts/pdf-font.ts:228

Methods

as

as<T extends PdfObject>(ctor: new (...args: any[]) => T): T
Attempts to cast the object to a specific PdfObject subclass
Type Parameters
- T extends PdfObject
Parameters
- ctor: new (...args: any[]) => T
Returns T
Inherited from PdfDictionary.as
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:65

clone

clone(): this
Creates a deep clone of the object

Returns this
Inherited from PdfDictionary.clone
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:169

copyFrom

copyFrom(other: PdfDictionary<any>): void
Parameters
- other: PdfDictionary<any>
Returns void
Inherited from PdfDictionary.copyFrom
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:162

delete

delete<
    K extends
        | "Type"
        | "Subtype"
        | "BaseFont"
        | "FontDescriptor"
        | "Encoding"
        | "FirstChar"
        | "LastChar"
        | "Widths"
        | "DescendantFonts"
        | "ToUnicode",
>(
    key: K | PdfName<K>,
): void
Type Parameters
- K extends
      | "Type"
      | "Subtype"
      | "BaseFont"
      | "FontDescriptor"
      | "Encoding"
      | "FirstChar"
      | "LastChar"
      | "Widths"
      | "DescendantFonts"
      | "ToUnicode"
Parameters
- key: K | PdfName<K>
Returns void
Inherited from PdfDictionary.delete
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:63

entries

entries(): IterableIterator<[string, PdfObject | undefined]>
Returns an iterator for the dictionary entries. Each entry is a tuple of [key string, value].

Returns IterableIterator<[string, PdfObject | undefined]>
Inherited from PdfDictionary.entries
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:111

equals

equals(other?: PdfObject): boolean
Compares this object to another for equality based on their token representations
Parameters
- Optionalother: PdfObject
Returns boolean
Inherited from PdfDictionary.equals
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:79

get

get<
    K extends
        | "Type"
        | "Subtype"
        | "BaseFont"
        | "FontDescriptor"
        | "Encoding"
        | "FirstChar"
        | "LastChar"
        | "Widths"
        | "DescendantFonts"
        | "ToUnicode",
>(
    key: K | PdfName<K>,
):
    | {
        BaseFont: PdfName;
        DescendantFonts?: PdfArray<PdfObjectReference>;
        Encoding?: PdfName<string>;
        FirstChar?: PdfNumber;
        FontDescriptor?: PdfObjectReference;
        LastChar?: PdfNumber;
        Subtype: PdfName<"Type1" | "TrueType" | "Type0">;
        ToUnicode?: PdfObjectReference;
        Type: PdfName<"Font">;
        Widths?: PdfArray<PdfNumber>;
    }[K]
    | undefined
Type Parameters
- K extends
      | "Type"
      | "Subtype"
      | "BaseFont"
      | "FontDescriptor"
      | "Encoding"
      | "FirstChar"
      | "LastChar"
      | "Widths"
      | "DescendantFonts"
      | "ToUnicode"
Parameters
- key: K | PdfName<K>
Returns
    | {
        BaseFont: PdfName;
        DescendantFonts?: PdfArray<PdfObjectReference>;
        Encoding?: PdfName<string>;
        FirstChar?: PdfNumber;
        FontDescriptor?: PdfObjectReference;
        LastChar?: PdfNumber;
        Subtype: PdfName<"Type1" | "TrueType" | "Type0">;
        ToUnicode?: PdfObjectReference;
        Type: PdfName<"Font">;
        Widths?: PdfArray<PdfNumber>;
    }[K]
    | undefined
Inherited from PdfDictionary.get
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:29

getObjectsToCommit

getObjectsToCommit(): PdfIndirectObject<PdfObject>[]
Returns all objects that need to be committed to the PDF. Includes auxiliary objects (descriptors, streams) and the container.

Returns PdfIndirectObject<PdfObject>[]
- Defined in packages/pdf-lite/src/fonts/pdf-font.ts:254

has

has<
    K extends
        | "Type"
        | "Subtype"
        | "BaseFont"
        | "FontDescriptor"
        | "Encoding"
        | "FirstChar"
        | "LastChar"
        | "Widths"
        | "DescendantFonts"
        | "ToUnicode",
>(
    key: K | PdfName<K>,
): boolean
Type Parameters
- K extends
      | "Type"
      | "Subtype"
      | "BaseFont"
      | "FontDescriptor"
      | "Encoding"
      | "FirstChar"
      | "LastChar"
      | "Widths"
      | "DescendantFonts"
      | "ToUnicode"
Parameters
- key: K | PdfName<K>
Returns boolean
Inherited from PdfDictionary.has
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:81

isModified

isModified(): boolean
Indicates whether the object has been modified. Override this method if the modified state is determined differently

Returns boolean
Inherited from PdfDictionary.isModified
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:177

set

set<
    K extends
        | "Type"
        | "Subtype"
        | "BaseFont"
        | "FontDescriptor"
        | "Encoding"
        | "FirstChar"
        | "LastChar"
        | "Widths"
        | "DescendantFonts"
        | "ToUnicode",
>(
    key: K | PdfName<K>,
    value: {
        BaseFont: PdfName;
        DescendantFonts?: PdfArray<PdfObjectReference>;
        Encoding?: PdfName<string>;
        FirstChar?: PdfNumber;
        FontDescriptor?: PdfObjectReference;
        LastChar?: PdfNumber;
        Subtype: PdfName<"Type1" | "TrueType" | "Type0">;
        ToUnicode?: PdfObjectReference;
        Type: PdfName<"Font">;
        Widths?: PdfArray<PdfNumber>;
    }[K],
): void
Type Parameters
- K extends
      | "Type"
      | "Subtype"
      | "BaseFont"
      | "FontDescriptor"
      | "Encoding"
      | "FirstChar"
      | "LastChar"
      | "Widths"
      | "DescendantFonts"
      | "ToUnicode"
Parameters
- key: K | PdfName<K>
- value: {
      BaseFont: PdfName;
      DescendantFonts?: PdfArray<PdfObjectReference>;
      Encoding?: PdfName<string>;
      FirstChar?: PdfNumber;
      FontDescriptor?: PdfObjectReference;
      LastChar?: PdfNumber;
      Subtype: PdfName<"Type1" | "TrueType" | "Type0">;
      ToUnicode?: PdfObjectReference;
      Type: PdfName<"Font">;
      Widths?: PdfArray<PdfNumber>;
  }[K]
Returns void
Inherited from PdfDictionary.set
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:43

setModified

setModified(modified?: boolean): void
Sets the modified state of the object. Override this method if the modified state is determined differently
Parameters
- modified: boolean = true
Returns void
Inherited from PdfDictionary.setModified
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:27

toBytes

toBytes(padTo?: number): ByteArray
Converts the object to a ByteArray, optionally padding to a specified length
Parameters
- OptionalpadTo: number
Returns ByteArray
Inherited from PdfDictionary.toBytes
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:41

`Protected`tokenize

tokenize(): PdfToken[]
Tokenizes the object into an array of PdfTokens

Returns PdfToken[]
Inherited from PdfDictionary.tokenize
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:119

toString

toString(): string
Returns the resource name for string coercion. This enables using PdfFont objects in template literals like:
```
const da = `/${font} 12 Tf 0 g`
```
Returns string
Overrides PdfDictionary.toString
- Defined in packages/pdf-lite/src/fonts/pdf-font.ts:246

toTokens

toTokens(): PdfToken[]
Converts the object to an array of PdfTokens, including any pre or post tokens

Returns PdfToken[]
Inherited from PdfDictionary.toTokens
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:32

`Static`fromBytes

fromBytes(data: ByteArray): PdfFont
Creates a PdfFont from font file bytes. Automatically detects the font format (TTF, OTF, WOFF) and parses it.
Parameters
- data: ByteArray
  The font file bytes
Returns PdfFont
A PdfFont instance ready to be written to the PDF
- Defined in packages/pdf-lite/src/fonts/pdf-font.ts:281

`Static`fromParser

fromParser(parser: FontParser): PdfFont
Creates a PdfFont from a FontParser instance. Extracts all necessary information from the parser including font name, descriptor, and font data.
Parameters
- parser: FontParser
  A FontParser instance (TtfParser, OtfParser, or WoffParser)
Returns PdfFont
A PdfFont instance ready to be written to the PDF
- Defined in packages/pdf-lite/src/fonts/pdf-font.ts:294

`Static`fromStandardFont

fromStandardFont(
    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",
): PdfFont
Creates a standard PDF Type1 font (one of the 14 built-in fonts). 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 PdfFont
A PdfFont instance ready to be written to the PDF
- Defined in packages/pdf-lite/src/fonts/pdf-font.ts:314

`Static`fromTrueTypeData

fromTrueTypeData(
    fontData: ByteArray,
    fontName: string,
    descriptor: FontDescriptor,
): PdfFont
Creates a TrueType font from font file data. Uses WinAnsiEncoding for standard 8-bit character support.
Parameters
- fontData: ByteArray
  The TrueType font file bytes
- fontName: string
  The name to use for this font in the PDF
- descriptor: FontDescriptor
  Font metrics and properties
Returns PdfFont
A PdfFont instance ready to be written to the PDF
- Defined in packages/pdf-lite/src/fonts/pdf-font.ts:350

`Static`fromType0Data

fromType0Data(
    fontData: ByteArray,
    fontName: string,
    descriptor: UnicodeFontDescriptor,
    unicodeMappings?: Map<number, number>,
): PdfFont
Creates a Type0 (composite) font with Unicode support. Use this for fonts that need to display non-ASCII characters.
Parameters
- fontData: ByteArray
  The TrueType 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>
  Optional map of CID to Unicode code point for ToUnicode CMap
Returns PdfFont
A PdfFont instance ready to be written to the PDF
- Defined in packages/pdf-lite/src/fonts/pdf-font.ts:450

Class PdfFont

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PdfFont

Properties

ProtectedauxiliaryObjects

Optionalcontainer

innerTokens

Protectedmodified

OptionalpostTokens

OptionalpreTokens

resourceName

Accessors

descriptor

Returns FontDescriptor | UnicodeFontDescriptor | undefined

encoding

Returns string | undefined

Parameters

Returns void

firstChar

Returns number | undefined

Parameters

Returns void

fontData

Returns ByteArray | undefined

fontName

Returns string | undefined

Parameters

Returns void

fontRef

Returns PdfObjectReference

fontType

Returns "Type1" | "TrueType" | "Type0" | "MMType1" | "Type3" | undefined

Parameters

Returns void

lastChar

Returns number | undefined

Parameters

Returns void

objectType

Returns string

values

Returns { readonly [K in string]: T[K] }

widths

Returns number[] | undefined

Parameters

Returns void

Methods

as

Type Parameters

Parameters

Returns T

clone

Returns this

copyFrom

Parameters

Returns void

delete

Type Parameters

Parameters

Returns void

entries

Returns IterableIterator<[string, PdfObject | undefined]>

equals

Parameters

Returns boolean

get

Type Parameters

Parameters

getObjectsToCommit

Returns PdfIndirectObject<PdfObject>[]

has

Type Parameters

`Protected`auxiliaryObjects

`Optional`container

`Protected`modified

`Optional`postTokens

`Optional`preTokens

`Protected`tokenize

`Static`fromBytes

`Static`fromParser

`Static`fromStandardFont

`Static`fromTrueTypeData

`Static`fromType0Data