api documentation for pdfkit (v0.8.0)

A PDF generation library for Node.js

table of contents

  1. module pdfkit
    1. function pdfkit (options1)
    2. function pdfkit.ReadableState (options, stream)
    3. function pdfkit._fromList (n, state)
    4. function pdfkit.afm (contents)
    5. function pdfkit.data (data)
    6. function pdfkit.embedded (document, font, id)
    7. function pdfkit.font ()
    8. function pdfkit.image ()
    9. function pdfkit.jpeg (data, label)
    10. function pdfkit.line_wrapper (document, options)
    11. function pdfkit.object ()
    12. function pdfkit.page (document, options)
    13. function pdfkit.path ()
    14. function pdfkit.png (data, label)
    15. function pdfkit.reference (document, id, data)
    16. function pdfkit.standard (document, name1, id)
    17. function pdfkit.super_ ()
    18. object pdfkit.__super__
    19. object pdfkit.afm.prototype
    20. object pdfkit.annotations
    21. object pdfkit.color
    22. object pdfkit.data.prototype
    23. object pdfkit.embedded.prototype
    24. object pdfkit.font.prototype
    25. object pdfkit.fonts
    26. object pdfkit.gradient
    27. object pdfkit.images
    28. object pdfkit.jpeg.prototype
    29. object pdfkit.line_wrapper.prototype
    30. object pdfkit.page.prototype
    31. object pdfkit.png.prototype
    32. object pdfkit.reference.prototype
    33. object pdfkit.standard.prototype
    34. object pdfkit.text
    35. object pdfkit.vector
  2. module pdfkit.afm
    1. function pdfkit.afm (contents)
    2. function pdfkit.afm.open (filename)
  3. module pdfkit.afm.prototype
    1. function pdfkit.afm.prototype.advancesForGlyphs (glyphs)
    2. function pdfkit.afm.prototype.characterToGlyph (character)
    3. function pdfkit.afm.prototype.encodeText (text)
    4. function pdfkit.afm.prototype.getKernPair (left, right)
    5. function pdfkit.afm.prototype.glyphsForString (string)
    6. function pdfkit.afm.prototype.parse ()
    7. function pdfkit.afm.prototype.widthOfGlyph (glyph)
  4. module pdfkit.annotations
    1. function pdfkit.annotations._convertRect (x1, y1, w, h)
    2. function pdfkit.annotations._markup (x, y, w, h, options)
    3. function pdfkit.annotations.annotate (x, y, w, h, options)
    4. function pdfkit.annotations.ellipseAnnotation (x, y, w, h, options)
    5. function pdfkit.annotations.highlight (x, y, w, h, options)
    6. function pdfkit.annotations.lineAnnotation (x1, y1, x2, y2, options)
    7. function pdfkit.annotations.link (x, y, w, h, url, options)
    8. function pdfkit.annotations.note (x, y, w, h, contents, options)
    9. function pdfkit.annotations.rectAnnotation (x, y, w, h, options)
    10. function pdfkit.annotations.strike (x, y, w, h, options)
    11. function pdfkit.annotations.textAnnotation (x, y, w, h, text, options)
    12. function pdfkit.annotations.underline (x, y, w, h, options)
  5. module pdfkit.color
    1. function pdfkit.color._doOpacity (fillOpacity, strokeOpacity)
    2. function pdfkit.color._normalizeColor (color)
    3. function pdfkit.color._setColor (color, stroke)
    4. function pdfkit.color._setColorSpace (space, stroke)
    5. function pdfkit.color.fillColor (color, opacity)
    6. function pdfkit.color.fillOpacity (opacity)
    7. function pdfkit.color.initColor ()
    8. function pdfkit.color.linearGradient (x1, y1, x2, y2)
    9. function pdfkit.color.opacity (opacity)
    10. function pdfkit.color.radialGradient (x1, y1, r1, x2, y2, r2)
    11. function pdfkit.color.strokeColor (color, opacity)
    12. function pdfkit.color.strokeOpacity (opacity)
  6. module pdfkit.data
    1. function pdfkit.data (data)
  7. 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)
  8. module pdfkit.embedded
    1. function pdfkit.embedded (document, font, id)
    2. function pdfkit.embedded.open (document, src, family, id)
    3. object pdfkit.embedded.__super__
  9. module pdfkit.embedded.prototype
    1. function pdfkit.embedded.prototype.constructor (document, font, id)
    2. function pdfkit.embedded.prototype.embed ()
    3. function pdfkit.embedded.prototype.encode (text, features)
    4. function pdfkit.embedded.prototype.toUnicodeCmap ()
    5. function pdfkit.embedded.prototype.widthOfString (string, size, features)
  10. module pdfkit.font
    1. function pdfkit.font ()
    2. function pdfkit.font.open (document, src, family, id)
  11. 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)
  12. module pdfkit.fonts
    1. function pdfkit.fonts.currentLineHeight (includeGap)
    2. function pdfkit.fonts.font (src, family, size)
    3. function pdfkit.fonts.fontSize (_fontSize)
    4. function pdfkit.fonts.initFonts ()
    5. function pdfkit.fonts.registerFont (name, src, family)
  13. 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)
  14. module pdfkit.image
    1. function pdfkit.image ()
    2. function pdfkit.image.open (src, label)
  15. module pdfkit.images
    1. function pdfkit.images.image (src, x, y, options)
    2. function pdfkit.images.initImages ()
  16. module pdfkit.jpeg
    1. function pdfkit.jpeg (data, label)
  17. module pdfkit.jpeg.prototype
    1. function pdfkit.jpeg.prototype.embed (document)
  18. 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__
  19. 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)
  20. module pdfkit.object
    1. function pdfkit.object ()
    2. function pdfkit.object.convert (object)
  21. module pdfkit.page
    1. function pdfkit.page (document, options)
  22. module pdfkit.page.prototype
    1. function pdfkit.page.prototype.end ()
    2. function pdfkit.page.prototype.maxY ()
    3. function pdfkit.page.prototype.write (chunk)
  23. module pdfkit.path
    1. function pdfkit.path ()
    2. function pdfkit.path.apply (doc, path)
  24. module pdfkit.png
    1. function pdfkit.png (data, label)
  25. module pdfkit.png.prototype
    1. function pdfkit.png.prototype.embed (document)
    2. function pdfkit.png.prototype.finalize ()
    3. function pdfkit.png.prototype.loadIndexedAlphaChannel (fn)
    4. function pdfkit.png.prototype.splitAlphaChannel ()
  26. 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__
  27. 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 ()
  28. module pdfkit.standard
    1. function pdfkit.standard (document, name1, id)
    2. function pdfkit.standard.isStandardFont (name)
    3. function pdfkit.standard.open (document, src, family, id)
    4. object pdfkit.standard.__super__
  29. module pdfkit.standard.prototype
    1. function pdfkit.standard.prototype.constructor (document, name1, id)
    2. function pdfkit.standard.prototype.embed ()
    3. function pdfkit.standard.prototype.encode (text)
    4. function pdfkit.standard.prototype.widthOfString (string, size)
  30. module pdfkit.text
    1. function pdfkit.text (text, x, y, options)
    2. function pdfkit.text._fragment (text, x, y, options)
    3. function pdfkit.text._initOptions (x, y, options)
    4. function pdfkit.text._line (text, options, wrapper)
    5. function pdfkit.text._text (text, x, y, options, lineCallback)
    6. function pdfkit.text.heightOfString (text, options)
    7. function pdfkit.text.initText ()
    8. function pdfkit.text.lineGap (_lineGap)
    9. function pdfkit.text.list (list, x, y, options, wrapper)
    10. function pdfkit.text.moveDown (lines)
    11. function pdfkit.text.moveUp (lines)
    12. function pdfkit.text.widthOfString (string, options)
  31. module pdfkit.vector
    1. function pdfkit.vector._windingRule (rule)
    2. function pdfkit.vector.bezierCurveTo (cp1x, cp1y, cp2x, cp2y, x, y)
    3. function pdfkit.vector.circle (x, y, radius)
    4. function pdfkit.vector.clip (rule)
    5. function pdfkit.vector.closePath ()
    6. function pdfkit.vector.dash (length, options)
    7. function pdfkit.vector.ellipse (x, y, r1, r2)
    8. function pdfkit.vector.fill (color, rule)
    9. function pdfkit.vector.fillAndStroke (fillColor, strokeColor, rule)
    10. function pdfkit.vector.initVector ()
    11. function pdfkit.vector.lineCap (c)
    12. function pdfkit.vector.lineJoin (j)
    13. function pdfkit.vector.lineTo (x, y)
    14. function pdfkit.vector.lineWidth (w)
    15. function pdfkit.vector.miterLimit (m)
    16. function pdfkit.vector.moveTo (x, y)
    17. function pdfkit.vector.path (path)
    18. function pdfkit.vector.polygon ()
    19. function pdfkit.vector.quadraticCurveTo (cpx, cpy, x, y)
    20. function pdfkit.vector.rect (x, y, w, h)
    21. function pdfkit.vector.restore ()
    22. function pdfkit.vector.rotate (angle, options)
    23. function pdfkit.vector.roundedRect (x, y, w, h, r)
    24. function pdfkit.vector.save ()
    25. function pdfkit.vector.scale (xFactor, yFactor, options)
    26. function pdfkit.vector.stroke (color)
    27. function pdfkit.vector.transform (m11, m12, m21, m22, dx, dy)
    28. function pdfkit.vector.translate (x, y)
    29. function pdfkit.vector.undash ()
    30. object pdfkit.vector._CAP_STYLES
    31. object pdfkit.vector._JOIN_STYLES

module pdfkit

function pdfkit (options1)

function pdfkit.ReadableState (options, stream)

function pdfkit._fromList (n, state)

function pdfkit.afm (contents)

function pdfkit.data (data)

function pdfkit.embedded (document, font, id)

function pdfkit.font ()

function pdfkit.image ()

function pdfkit.jpeg (data, label)

function pdfkit.line_wrapper (document, options)

function pdfkit.object ()

function pdfkit.page (document, options)

function pdfkit.path ()

function pdfkit.png (data, label)

function pdfkit.reference (document, id, data)

function pdfkit.standard (document, name1, id)

function pdfkit.super_ ()

module pdfkit.afm

function pdfkit.afm (contents)

function pdfkit.afm.open (filename)

module pdfkit.afm.prototype

function pdfkit.afm.prototype.advancesForGlyphs (glyphs)

function pdfkit.afm.prototype.characterToGlyph (character)

function pdfkit.afm.prototype.encodeText (text)

function pdfkit.afm.prototype.getKernPair (left, right)

function pdfkit.afm.prototype.glyphsForString (string)

function pdfkit.afm.prototype.parse ()

function pdfkit.afm.prototype.widthOfGlyph (glyph)

module pdfkit.annotations

function pdfkit.annotations._convertRect (x1, y1, w, h)

function pdfkit.annotations._markup (x, y, w, h, options)

function pdfkit.annotations.annotate (x, y, w, h, options)

function pdfkit.annotations.ellipseAnnotation (x, y, w, h, options)

function pdfkit.annotations.highlight (x, y, w, h, options)

function pdfkit.annotations.lineAnnotation (x1, y1, x2, y2, options)

function pdfkit.annotations.link (x, y, w, h, url, options)

function pdfkit.annotations.note (x, y, w, h, contents, options)

function pdfkit.annotations.rectAnnotation (x, y, w, h, options)

function pdfkit.annotations.strike (x, y, w, h, options)

function pdfkit.annotations.textAnnotation (x, y, w, h, text, options)

function pdfkit.annotations.underline (x, y, w, h, options)

module pdfkit.color

function pdfkit.color._doOpacity (fillOpacity, strokeOpacity)

function pdfkit.color._normalizeColor (color)

function pdfkit.color._setColor (color, stroke)

function pdfkit.color._setColorSpace (space, stroke)

function pdfkit.color.fillColor (color, opacity)

function pdfkit.color.fillOpacity (opacity)

function pdfkit.color.initColor ()

function pdfkit.color.linearGradient (x1, y1, x2, y2)

function pdfkit.color.opacity (opacity)

function pdfkit.color.radialGradient (x1, y1, r1, x2, y2, r2)

function pdfkit.color.strokeColor (color, opacity)

function pdfkit.color.strokeOpacity (opacity)

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.embedded

function pdfkit.embedded (document, font, id)

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

module pdfkit.embedded.prototype

function pdfkit.embedded.prototype.constructor (document, font, id)

function pdfkit.embedded.prototype.embed ()

function pdfkit.embedded.prototype.encode (text, features)

function pdfkit.embedded.prototype.toUnicodeCmap ()

function pdfkit.embedded.prototype.widthOfString (string, size, features)

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.fonts

function pdfkit.fonts.currentLineHeight (includeGap)

function pdfkit.fonts.font (src, family, size)

function pdfkit.fonts.fontSize (_fontSize)

function pdfkit.fonts.initFonts ()

function pdfkit.fonts.registerFont (name, src, family)

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.images

function pdfkit.images.image (src, x, y, options)

function pdfkit.images.initImages ()

module pdfkit.jpeg

function pdfkit.jpeg (data, label)

module pdfkit.jpeg.prototype

function pdfkit.jpeg.prototype.embed (document)

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.png

function pdfkit.png (data, label)

module pdfkit.png.prototype

function pdfkit.png.prototype.embed (document)

function pdfkit.png.prototype.finalize ()

function pdfkit.png.prototype.loadIndexedAlphaChannel (fn)

function pdfkit.png.prototype.splitAlphaChannel ()

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 ()

module pdfkit.standard

function pdfkit.standard (document, name1, id)

function pdfkit.standard.isStandardFont (name)

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

module pdfkit.standard.prototype

function pdfkit.standard.prototype.constructor (document, name1, id)

function pdfkit.standard.prototype.embed ()

function pdfkit.standard.prototype.encode (text)

function pdfkit.standard.prototype.widthOfString (string, size)

module pdfkit.text

function pdfkit.text (text, x, y, options)

function pdfkit.text._fragment (text, x, y, options)

function pdfkit.text._initOptions (x, y, options)

function pdfkit.text._line (text, options, wrapper)

function pdfkit.text._text (text, x, y, options, lineCallback)

function pdfkit.text.heightOfString (text, options)

function pdfkit.text.initText ()

function pdfkit.text.lineGap (_lineGap)

function pdfkit.text.list (list, x, y, options, wrapper)

function pdfkit.text.moveDown (lines)

function pdfkit.text.moveUp (lines)

function pdfkit.text.widthOfString (string, options)

module pdfkit.vector

function pdfkit.vector._windingRule (rule)

function pdfkit.vector.bezierCurveTo (cp1x, cp1y, cp2x, cp2y, x, y)

function pdfkit.vector.circle (x, y, radius)

function pdfkit.vector.clip (rule)

function pdfkit.vector.closePath ()

function pdfkit.vector.dash (length, options)

function pdfkit.vector.ellipse (x, y, r1, r2)

function pdfkit.vector.fill (color, rule)

function pdfkit.vector.fillAndStroke (fillColor, strokeColor, rule)

function pdfkit.vector.initVector ()

function pdfkit.vector.lineCap (c)

function pdfkit.vector.lineJoin (j)

function pdfkit.vector.lineTo (x, y)

function pdfkit.vector.lineWidth (w)

function pdfkit.vector.miterLimit (m)

function pdfkit.vector.moveTo (x, y)

function pdfkit.vector.path (path)

function pdfkit.vector.polygon ()

function pdfkit.vector.quadraticCurveTo (cpx, cpy, x, y)

function pdfkit.vector.rect (x, y, w, h)

function pdfkit.vector.restore ()

function pdfkit.vector.rotate (angle, options)

function pdfkit.vector.roundedRect (x, y, w, h, r)

function pdfkit.vector.save ()

function pdfkit.vector.scale (xFactor, yFactor, options)

function pdfkit.vector.stroke (color)

function pdfkit.vector.transform (m11, m12, m21, m22, dx, dy)

function pdfkit.vector.translate (x, y)

function pdfkit.vector.undash ()

[ this document was created with utility2 ]