Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Document

class

Document

desc

Document represents a PdfMemDocument, construct from an existing pdf document. Document is the core class for reading and manipulating PDF files and writing them back to disk. Document was designed to allow easy access to the object structure of a PDF file. Document should be used whenever you want to change the object structure of a PDF file.

Hierarchy

  • EventEmitter
    • Document

Index

Constructors

constructor

  • new Document(file: string, update?: boolean, pwd?: undefined | string): Document
  • File is loaded asynchronously, extends eventEmitter, will publish a 'ready'event when document has been loaded

    constructor

    Parameters

    • file: string
    • Default value update: boolean = false
    • Optional pwd: undefined | string

    Returns Document

    void

Properties

Private _encrypt

_encrypt: any

Private _instance

_instance: any

Private _loaded

_loaded: boolean = false

Private _password

_password: string | undefined = undefined

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

encrypt

loaded

  • get loaded(): boolean

password

  • get password(): string
  • set password(value: string): void

Methods

addListener

  • addListener(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

createEncrypt

createFont

deletePage

  • deletePage(pageIndex: number): void

emit

  • emit(event: string | symbol, ...args: any[]): boolean
  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>
  • Returns Array<string | symbol>

getCatalog

  • getCatalog(): Obj

getMaxListeners

  • getMaxListeners(): number
  • Returns number

getObjects

  • getObjects(): Array<Obj>

getPage

  • getPage(pageN: number): Page

getPageCount

  • getPageCount(): number

getTrailer

  • getTrailer(): Obj

getVersion

  • getVersion(): number

isAllowed

isLinearized

  • isLinearized(): boolean

listenerCount

  • listenerCount(type: string | symbol): number
  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]
  • Parameters

    • event: string | symbol

    Returns Function[]

Private load

  • load(file: string, update?: boolean, pwd?: undefined | string): void
  • load pdf file, emits 'ready' || 'error' events

    Parameters

    • file: string

      file path

    • Default value update: boolean = false

      load document for incremental updates

    • Optional pwd: undefined | string

    Returns void

mergeDocument

  • mergeDocument(doc: string, password?: undefined | string): void
  • description

    Append doc to the end of the loaded doc

    Parameters

    • doc: string

      pdf file path

    • Optional password: undefined | string

    Returns void

on

  • on(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

once

  • once(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependListener

  • prependListener(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

removeAllListeners

  • removeAllListeners(event?: string | symbol): this
  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this
  • Parameters

    • n: number

    Returns this

write

  • write(cb: function, file?: undefined | string): void
  • Persist changes and write to disk or if no arguments provided returns Buffer

    Parameters

    • cb: function

      Callbck Function

        • (e: Error, v: Buffer | void): void
        • Parameters

          • e: Error
          • v: Buffer | void

          Returns void

    • Optional file: undefined | string

    Returns void

writeUpdate

  • writeUpdate(device: string | Signer): void

Static gc

  • gc(file: string, pwd: string, output: string, cb: function): void
  • Parameters

    • file: string
    • pwd: string
    • output: string
    • cb: function
        • (e: Error, d: string | Buffer): void
        • Parameters

          • e: Error
          • d: string | Buffer

          Returns void

    Returns void

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc