Class PdfDefaultResourcesDictionary

innerTokens

OptionalpostTokens

OptionalpreTokens

isTrailingDelimited

• get isTrailingDelimited(): boolean

  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.

  Returns boolean

objectType

• get objectType(): string

  The type of this PDF object

  Returns string

values

• get values(): { readonly [K in string]: T[K] }

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

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

clone

• clone(): this

  Creates a deep clone of the object

  Returns this

cloneImpl

• cloneImpl(): this

  Creates a deep clone of the object. Override this method in subclasses to ensure all properties are cloned correctly

  Returns this

copyFrom

• copyFrom(other: PdfDictionary<any>): void

  Parameters

  • other: PdfDictionary<any>

  Returns void

delete

• delete<
      K extends
          | "Font"
          | "ProcSet"
          | "ExtGState"
          | "ColorSpace"
          | "Pattern"
          | "Shading"
          | "XObject",
  >(
      key: K | PdfName<K>,
  ): void

  Type Parameters

  • K extends
        | "Font"
        | "ProcSet"
        | "ExtGState"
        | "ColorSpace"
        | "Pattern"
        | "Shading"
        | "XObject"

  Parameters

  • key: K | PdfName<K>

  Returns void

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]>

equals

• equals(other?: PdfObject): boolean

  Compares this object to another for equality based on their token representations

  Parameters

  • Optionalother: PdfObject

  Returns boolean

get

• get<
      K extends
          | "Font"
          | "ProcSet"
          | "ExtGState"
          | "ColorSpace"
          | "Pattern"
          | "Shading"
          | "XObject",
  >(
      key: K | PdfName<K>,
  ):
      | {
          ColorSpace?: PdfDictionary<PdfDictionaryEntries>;
          ExtGState?: PdfDictionary<PdfDictionaryEntries>;
          Font?: PdfDictionary<PdfDictionaryEntries>;
          Pattern?: PdfDictionary<PdfDictionaryEntries>;
          ProcSet?: PdfArray<PdfObject>;
          Shading?: PdfDictionary<PdfDictionaryEntries>;
          XObject?: PdfDictionary<PdfDictionaryEntries>;
      }[K]
      | undefined

  Type Parameters

  • K extends
        | "Font"
        | "ProcSet"
        | "ExtGState"
        | "ColorSpace"
        | "Pattern"
        | "Shading"
        | "XObject"

  Parameters

  • key: K | PdfName<K>

  Returns
      | {
          ColorSpace?: PdfDictionary<PdfDictionaryEntries>;
          ExtGState?: PdfDictionary<PdfDictionaryEntries>;
          Font?: PdfDictionary<PdfDictionaryEntries>;
          Pattern?: PdfDictionary<PdfDictionaryEntries>;
          ProcSet?: PdfArray<PdfObject>;
          Shading?: PdfDictionary<PdfDictionaryEntries>;
          XObject?: PdfDictionary<PdfDictionaryEntries>;
      }[K]
      | undefined

has

• has<
      K extends
          | "Font"
          | "ProcSet"
          | "ExtGState"
          | "ColorSpace"
          | "Pattern"
          | "Shading"
          | "XObject",
  >(
      key: K | PdfName<K>,
  ): boolean

  Type Parameters

  • K extends
        | "Font"
        | "ProcSet"
        | "ExtGState"
        | "ColorSpace"
        | "Pattern"
        | "Shading"
        | "XObject"

  Parameters

  • key: K | PdfName<K>

  Returns boolean

isImmutable

• isImmutable(): boolean

  Indicates whether the object is immutable (cannot be modified)

  Returns boolean

isModified

• isModified(): boolean

  Indicates whether the object has been modified. Override this method if the modified state is determined differently

  Returns boolean

set

• set<
      K extends
          | "Font"
          | "ProcSet"
          | "ExtGState"
          | "ColorSpace"
          | "Pattern"
          | "Shading"
          | "XObject",
  >(
      key: K | PdfName<K>,
      value: {
          ColorSpace?: PdfDictionary<PdfDictionaryEntries>;
          ExtGState?: PdfDictionary<PdfDictionaryEntries>;
          Font?: PdfDictionary<PdfDictionaryEntries>;
          Pattern?: PdfDictionary<PdfDictionaryEntries>;
          ProcSet?: PdfArray<PdfObject>;
          Shading?: PdfDictionary<PdfDictionaryEntries>;
          XObject?: PdfDictionary<PdfDictionaryEntries>;
      }[K],
  ): void

  Type Parameters

  • K extends
        | "Font"
        | "ProcSet"
        | "ExtGState"
        | "ColorSpace"
        | "Pattern"
        | "Shading"
        | "XObject"

  Parameters

  • key: K | PdfName<K>
  • value: {
        ColorSpace?: PdfDictionary<PdfDictionaryEntries>;
        ExtGState?: PdfDictionary<PdfDictionaryEntries>;
        Font?: PdfDictionary<PdfDictionaryEntries>;
        Pattern?: PdfDictionary<PdfDictionaryEntries>;
        ProcSet?: PdfArray<PdfObject>;
        Shading?: PdfDictionary<PdfDictionaryEntries>;
        XObject?: PdfDictionary<PdfDictionaryEntries>;
    }[K]

  Returns void

setImmutable

• setImmutable(immutable?: boolean): void

  Sets the immutable state of the object

  Parameters

  • Optionalimmutable: boolean

  Returns void

setModified

• setModified(modified?: boolean): void

  Sets the modified state of the object. Override this method if the modified state is determined differently

  Parameters

  • Optionalmodified: boolean

  Returns void

toBase64

• toBase64(): string

  Serializes the document to a Base64-encoded string.

  Returns string

  A promise that resolves to the PDF document as a Base64 string

toBytes

• toBytes(padTo?: number): ByteArray

  Converts the object to a ByteArray, optionally padding to a specified length

  Parameters

  • OptionalpadTo: number

  Returns ByteArray

toString

• toString(): string

  Converts the object to a string representation

  Returns string

toTokens

• toTokens(): PdfToken[]

  Converts the object to an array of PdfTokens, including any pre or post tokens

  Returns PdfToken[]