api documentation for pdfkit (v0.8.0)

A PDF generation library for Node.js

table of contents

  1. module pdfkit
    1. function pdfkit.ReadableState (options, stream)
    2. function pdfkit._fromList (n, state)
    3. function pdfkit.data (data)
    4. function pdfkit.font ()
    5. function pdfkit.image ()
    6. function pdfkit.line_wrapper (document, options)
    7. function pdfkit.object ()
    8. function pdfkit.page (document, options)
    9. function pdfkit.path ()
    10. function pdfkit.reference (document, id, data)
    11. function pdfkit.super_ ()
    12. object pdfkit.__super__
    13. object pdfkit.data.prototype
    14. object pdfkit.font.prototype
    15. object pdfkit.gradient
    16. object pdfkit.line_wrapper.prototype
    17. object pdfkit.page.prototype
    18. object pdfkit.reference.prototype
  2. module pdfkit.data
    1. function pdfkit.data (data)
  3. module pdfkit.data.prototype
    1. function pdfkit.data.prototype.byteAt (index)
    2. function pdfkit.data.prototype.read (bytes)
    3. function pdfkit.data.prototype.readBool ()
    4. function pdfkit.data.prototype.readByte ()
    5. function pdfkit.data.prototype.readInt ()
    6. function pdfkit.data.prototype.readInt16 ()
    7. function pdfkit.data.prototype.readInt32 ()
    8. function pdfkit.data.prototype.readLongLong ()
    9. function pdfkit.data.prototype.readShort ()
    10. function pdfkit.data.prototype.readString (length)
    11. function pdfkit.data.prototype.readUInt16 ()
    12. function pdfkit.data.prototype.readUInt32 ()
    13. function pdfkit.data.prototype.slice (start, end)
    14. function pdfkit.data.prototype.stringAt (pos, length)
    15. function pdfkit.data.prototype.write (bytes)
    16. function pdfkit.data.prototype.writeBool (val)
    17. function pdfkit.data.prototype.writeByte (byte)
    18. function pdfkit.data.prototype.writeInt (val)
    19. function pdfkit.data.prototype.writeInt16 (val)
    20. function pdfkit.data.prototype.writeInt32 (val)
    21. function pdfkit.data.prototype.writeLongLong (val)
    22. function pdfkit.data.prototype.writeShort (val)
    23. function pdfkit.data.prototype.writeString (val)
    24. function pdfkit.data.prototype.writeUInt16 (val)
    25. function pdfkit.data.prototype.writeUInt32 (val)
  4. module pdfkit.font
    1. function pdfkit.font ()
    2. function pdfkit.font.open (document, src, family, id)
  5. module pdfkit.font.prototype
    1. function pdfkit.font.prototype.embed ()
    2. function pdfkit.font.prototype.encode (text)
    3. function pdfkit.font.prototype.finalize ()
    4. function pdfkit.font.prototype.lineHeight (size, includeGap)
    5. function pdfkit.font.prototype.ref ()
    6. function pdfkit.font.prototype.widthOfString (text)
  6. module pdfkit.gradient
    1. function pdfkit.gradient.PDFGradient (doc)
    2. function pdfkit.gradient.PDFLinearGradient (doc, x1, y1, x2, y2)
    3. function pdfkit.gradient.PDFRadialGradient (doc, x1, y1, r1, x2, y2, r2)
  7. module pdfkit.image
    1. function pdfkit.image ()
    2. function pdfkit.image.open (src, label)
  8. module pdfkit.line_wrapper
    1. boolean pdfkit.line_wrapper.usingDomains
    2. function pdfkit.line_wrapper (document, options)
    3. function pdfkit.line_wrapper.EventEmitter ()
    4. function pdfkit.line_wrapper.init ()
    5. function pdfkit.line_wrapper.listenerCount (emitter, type)
    6. number pdfkit.line_wrapper.defaultMaxListeners
    7. object pdfkit.line_wrapper.__super__
  9. module pdfkit.line_wrapper.prototype
    1. function pdfkit.line_wrapper.prototype.constructor (document, options)
    2. function pdfkit.line_wrapper.prototype.eachWord (text, fn)
    3. function pdfkit.line_wrapper.prototype.nextSection (options)
    4. function pdfkit.line_wrapper.prototype.wordWidth (word)
    5. function pdfkit.line_wrapper.prototype.wrap (text, options)
  10. module pdfkit.object
    1. function pdfkit.object ()
    2. function pdfkit.object.convert (object)
  11. module pdfkit.page
    1. function pdfkit.page (document, options)
  12. module pdfkit.page.prototype
    1. function pdfkit.page.prototype.end ()
    2. function pdfkit.page.prototype.maxY ()
    3. function pdfkit.page.prototype.write (chunk)
  13. module pdfkit.path
    1. function pdfkit.path ()
    2. function pdfkit.path.apply (doc, path)
  14. module pdfkit.reference
    1. function pdfkit.reference (document, id, data)
    2. function pdfkit.reference.WritableState (options, stream)
    3. function pdfkit.reference.super_ ()
    4. object pdfkit.reference.__super__
  15. module pdfkit.reference.prototype
    1. function pdfkit.reference.prototype._write (chunk, encoding, callback)
    2. function pdfkit.reference.prototype.constructor (document, id, data)
    3. function pdfkit.reference.prototype.end (chunk)
    4. function pdfkit.reference.prototype.finalize ()
    5. function pdfkit.reference.prototype.initDeflate ()
    6. function pdfkit.reference.prototype.toString ()

module pdfkit

function pdfkit.ReadableState (options, stream)

function pdfkit._fromList (n, state)

function pdfkit.data (data)

function pdfkit.font ()

function pdfkit.image ()

function pdfkit.line_wrapper (document, options)

function pdfkit.object ()

function pdfkit.page (document, options)

function pdfkit.path ()

function pdfkit.reference (document, id, data)

function pdfkit.super_ ()

module pdfkit.data

function pdfkit.data (data)

module pdfkit.data.prototype

function pdfkit.data.prototype.byteAt (index)

function pdfkit.data.prototype.read (bytes)

function pdfkit.data.prototype.readBool ()

function pdfkit.data.prototype.readByte ()

function pdfkit.data.prototype.readInt ()

function pdfkit.data.prototype.readInt16 ()

function pdfkit.data.prototype.readInt32 ()

function pdfkit.data.prototype.readLongLong ()

function pdfkit.data.prototype.readShort ()

function pdfkit.data.prototype.readString (length)

function pdfkit.data.prototype.readUInt16 ()

function pdfkit.data.prototype.readUInt32 ()

function pdfkit.data.prototype.slice (start, end)

function pdfkit.data.prototype.stringAt (pos, length)

function pdfkit.data.prototype.write (bytes)

function pdfkit.data.prototype.writeBool (val)

function pdfkit.data.prototype.writeByte (byte)

function pdfkit.data.prototype.writeInt (val)

function pdfkit.data.prototype.writeInt16 (val)

function pdfkit.data.prototype.writeInt32 (val)

function pdfkit.data.prototype.writeLongLong (val)

function pdfkit.data.prototype.writeShort (val)

function pdfkit.data.prototype.writeString (val)

function pdfkit.data.prototype.writeUInt16 (val)

function pdfkit.data.prototype.writeUInt32 (val)

module pdfkit.font

function pdfkit.font ()

function pdfkit.font.open (document, src, family, id)

module pdfkit.font.prototype

function pdfkit.font.prototype.embed ()

function pdfkit.font.prototype.encode (text)

function pdfkit.font.prototype.finalize ()

function pdfkit.font.prototype.lineHeight (size, includeGap)

function pdfkit.font.prototype.ref ()

function pdfkit.font.prototype.widthOfString (text)

module pdfkit.gradient

function pdfkit.gradient.PDFGradient (doc)

function pdfkit.gradient.PDFLinearGradient (doc, x1, y1, x2, y2)

function pdfkit.gradient.PDFRadialGradient (doc, x1, y1, r1, x2, y2, r2)

module pdfkit.image

function pdfkit.image ()

function pdfkit.image.open (src, label)

module pdfkit.line_wrapper

function pdfkit.line_wrapper (document, options)

function pdfkit.line_wrapper.EventEmitter ()

function pdfkit.line_wrapper.init ()

function pdfkit.line_wrapper.listenerCount (emitter, type)

module pdfkit.line_wrapper.prototype

function pdfkit.line_wrapper.prototype.constructor (document, options)

function pdfkit.line_wrapper.prototype.eachWord (text, fn)

function pdfkit.line_wrapper.prototype.nextSection (options)

function pdfkit.line_wrapper.prototype.wordWidth (word)

function pdfkit.line_wrapper.prototype.wrap (text, options)

module pdfkit.object

function pdfkit.object ()

function pdfkit.object.convert (object)

module pdfkit.page

function pdfkit.page (document, options)

module pdfkit.page.prototype

function pdfkit.page.prototype.end ()

function pdfkit.page.prototype.maxY ()

function pdfkit.page.prototype.write (chunk)

module pdfkit.path

function pdfkit.path ()

function pdfkit.path.apply (doc, path)

module pdfkit.reference

function pdfkit.reference (document, id, data)

function pdfkit.reference.WritableState (options, stream)

function pdfkit.reference.super_ ()

module pdfkit.reference.prototype

function pdfkit.reference.prototype._write (chunk, encoding, callback)

function pdfkit.reference.prototype.constructor (document, id, data)

function pdfkit.reference.prototype.end (chunk)

function pdfkit.reference.prototype.finalize ()

function pdfkit.reference.prototype.initDeflate ()

function pdfkit.reference.prototype.toString ()

[ this document was created with utility2 ]