Protected OptionalcachedCached byte representation of the object, if available
OptionalcompressedOptionalencryptableProtectedimmutableIndicates whether the object is immutable (cannot be modified)
ProtectedmodifiedIndicates whether the object has been modified. By default, assume it has been modified because it's a new object
OptionalorderOptionalpostOptional tokens to prepend or append during serialization
OptionalpreOptional tokens to prepend or append during serialization
The PDF resource name used in content streams (e.g., 'F1', 'F2').
This is the identifier used in PDF operators like /F1 12 Tf.
Static ReadonlyCOURIERStatic ReadonlyCOURIER_Static ReadonlyCOURIER_Static ReadonlyCOURIER_Static ReadonlyHELVETICAStatic ReadonlyHELVETICA_Static ReadonlyHELVETICA_Static ReadonlyHELVETICA_Static ReadonlyMAX_Static ReadonlySYMBOLStatic ReadonlyTIMES_Static ReadonlyTIMES_Static ReadonlyTIMES_Static ReadonlyTIMES_Static ReadonlyZAPF_Gets the font descriptor with metrics and properties. Available for embedded fonts, undefined for standard fonts or loaded fonts without descriptor.
Gets the encoding map from the font's Encoding dictionary's Differences array. Maps byte codes to Unicode characters for custom-encoded fonts.
Gets the first character code in the Widths array.
Sets the first character code in the Widths array.
Gets the original font file bytes. Available for embedded fonts, undefined for standard fonts or loaded fonts.
InternalLegacy property for backward compatibility with code that accesses fontRef. Returns this font's reference since PdfFont IS the indirect object.
Gets the font type (Subtype in PDF).
Sets the font type (Subtype in PDF).
Returns true if this object's serialized form ends with a self-delimiting
character (e.g., ), >, ], >>). Such objects do not require trailing
whitespace before the next token.
Whether this font uses Unicode (Type0/composite) encoding.
Gets the last character code in the Widths array.
Sets the last character code in the Widths array.
The type of this PDF object
Gets the reverse encoding map (Unicode character → byte code). Useful for encoding text back into the font's custom encoding.
Gets the character widths array.
Sets the character widths array.
Creates a deep clone of the object
Creates a deep clone of the object. Override this method in subclasses to ensure all properties are cloned correctly
Compares this object to another for equality based on their token representations
Optionalother: PdfObjectGets the character width scaled to the specified font size. Returns null if the character is not in the font's width table.
The character code to get the width for
The font size to scale to
The scaled character width or null if not found
Gets character widths for all characters in a string. Returns null for characters not in the font's width table.
The text to get character widths for
The font size to scale to
Array of character widths (null for missing characters)
Gets the raw character width (in 1000-unit em square) for a character code. Returns null if the character is not in the font's width table.
The character code to get the width for
The raw character width or null if not found
Checks if the font has width data for a character code.
The character code to check
True if width data is available, false otherwise
Indicates whether the object is immutable (cannot be modified)
Indicates whether the object has been modified. Override this method if the modified state is determined differently
Optionalref: PdfObjectReference<PdfIndirectObject<PdfObject>>Optionalcls: new (options: PdfIndirectObject) => TSets the immutable state of the object
Optionalimmutable: booleanSets the modified state of the object. Override this method if the modified state is determined differently
Serializes the document to a Base64-encoded string.
A promise that resolves to the PDF document as a Base64 string
Converts the object to a ByteArray, optionally padding to a specified length
OptionalpadTo: numberProtectedtokenizeTokenizes the object into an array of PdfTokens
Returns the resource name for string coercion. This enables using PdfFont objects in template literals like:
const da = `/${font} 12 Tf 0 g`
Converts the object to an array of PdfTokens, including any pre or post tokens
StaticcreateStaticfromStaticfromStaticfromCreates a PdfFont from a FontParser instance. Extracts all necessary information from the parser including font name, descriptor, and font data.
A FontParser instance (TtfParser, OtfParser, or WoffParser)
A PdfFont instance ready to be written to the PDF
StaticfromCreates 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.
One of the 14 standard PDF fonts
Optionalwidths: number[]Optional AFM widths array (1/1000 em units) for chars 32–126
A PdfFont instance ready to be written to the PDF
StaticfromCreates a TrueType font from font file data. Uses WinAnsiEncoding for standard 8-bit character support.
The TrueType font file bytes
The name to use for this font in the PDF
Font metrics and properties
A PdfFont instance ready to be written to the PDF
StaticfromCreates a Type0 (composite) font with Unicode support. Use this for fonts that need to display non-ASCII characters.
The TrueType font file bytes
The name to use for this font in the PDF
Unicode font descriptor with CID metrics
OptionalunicodeMappings: Map<number, number>Optional map of CID to Unicode code point for ToUnicode CMap
A PdfFont instance ready to be written to the PDF
StaticgetReturns the static PdfFont instance for a standard font name, or null if not found.
Represents an embedded font in a PDF document. Extends PdfIndirectObject with a PdfDictionary content for the font dict.