api documentation for pdfmake (v0.1.27)

Client/server side PDF printing in pure JavaScript

table of contents

  1. module pdfmake
    1. function pdfmake (fontDescriptors)
    2. function pdfmake.docMeasure (fontProvider, styleDictionary, defaultStyle, imageMeasure, tableLayouts, images)
    3. function pdfmake.documentContext (pageSize, pageMargins)
    4. function pdfmake.elementWriter (context, tracker)
    5. function pdfmake.fontProvider (fontDescriptors, pdfKitDoc)
    6. function pdfmake.imageMeasure (pdfKitDoc, imageDictionary)
    7. function pdfmake.layoutBuilder (pageSize, pageMargins, imageMeasure)
    8. function pdfmake.line (maxWidth)
    9. function pdfmake.pageElementWriter (context, tracker)
    10. function pdfmake.styleContextStack (styleDictionary, defaultStyle)
    11. function pdfmake.tableProcessor (tableNode)
    12. function pdfmake.textTools (fontProvider)
    13. function pdfmake.traversalTracker ()
    14. object pdfmake.columnCalculator
    15. object pdfmake.docMeasure.prototype
    16. object pdfmake.documentContext.prototype
    17. object pdfmake.elementWriter.prototype
    18. object pdfmake.fontProvider.prototype
    19. object pdfmake.helpers
    20. object pdfmake.imageMeasure.prototype
    21. object pdfmake.layoutBuilder.prototype
    22. object pdfmake.line.prototype
    23. object pdfmake.pageElementWriter.prototype
    24. object pdfmake.pdfMake
    25. object pdfmake.qrEnc
    26. object pdfmake.styleContextStack.prototype
    27. object pdfmake.tableProcessor.prototype
    28. object pdfmake.textDecorator
    29. object pdfmake.textTools.prototype
    30. object pdfmake.traversalTracker.prototype
  2. module pdfmake.columnCalculator
    1. function pdfmake.columnCalculator.buildColumnWidths (columns, availableWidth)
    2. function pdfmake.columnCalculator.isAutoColumn (column)
    3. function pdfmake.columnCalculator.isStarColumn (column)
    4. function pdfmake.columnCalculator.measureMinMax (columns)
  3. module pdfmake.docMeasure
    1. function pdfmake.docMeasure (fontProvider, styleDictionary, defaultStyle, imageMeasure, tableLayouts, images)
  4. module pdfmake.docMeasure.prototype
    1. function pdfmake.docMeasure.prototype.buildOrderedMarker (counter, styleStack, type, separator)
    2. function pdfmake.docMeasure.prototype.buildUnorderedMarker (styleStack, gapSize, type)
    3. function pdfmake.docMeasure.prototype.convertIfBase64Image (node)
    4. function pdfmake.docMeasure.prototype.gapSizeForList ()
    5. function pdfmake.docMeasure.prototype.measureCanvas (node)
    6. function pdfmake.docMeasure.prototype.measureColumns (node)
    7. function pdfmake.docMeasure.prototype.measureDocument (docStructure)
    8. function pdfmake.docMeasure.prototype.measureImage (node)
    9. function pdfmake.docMeasure.prototype.measureLeaf (node)
    10. function pdfmake.docMeasure.prototype.measureNode (node)
    11. function pdfmake.docMeasure.prototype.measureOrderedList (node)
    12. function pdfmake.docMeasure.prototype.measureQr (node)
    13. function pdfmake.docMeasure.prototype.measureTable (node)
    14. function pdfmake.docMeasure.prototype.measureUnorderedList (node)
    15. function pdfmake.docMeasure.prototype.measureVerticalContainer (node)
  5. module pdfmake.documentContext
    1. function pdfmake.documentContext (pageSize, pageMargins)
  6. module pdfmake.documentContext.prototype
    1. function pdfmake.documentContext.prototype.addMargin (left, right)
    2. function pdfmake.documentContext.prototype.addPage (pageSize)
    3. function pdfmake.documentContext.prototype.beginColumn (width, offset, endingCell)
    4. function pdfmake.documentContext.prototype.beginColumnGroup ()
    5. function pdfmake.documentContext.prototype.beginDetachedBlock ()
    6. function pdfmake.documentContext.prototype.calculateBottomMost (destContext)
    7. function pdfmake.documentContext.prototype.completeColumnGroup ()
    8. function pdfmake.documentContext.prototype.endDetachedBlock ()
    9. function pdfmake.documentContext.prototype.getCurrentPage ()
    10. function pdfmake.documentContext.prototype.getCurrentPosition ()
    11. function pdfmake.documentContext.prototype.initializePage ()
    12. function pdfmake.documentContext.prototype.markEnding (endingCell)
    13. function pdfmake.documentContext.prototype.moveDown (offset)
    14. function pdfmake.documentContext.prototype.moveTo (x, y)
    15. function pdfmake.documentContext.prototype.moveToNextPage (pageOrientation)
    16. function pdfmake.documentContext.prototype.pageSnapshot ()
    17. function pdfmake.documentContext.prototype.saveContextInEndingCell (endingCell)
  7. module pdfmake.elementWriter
    1. function pdfmake.elementWriter (context, tracker)
  8. module pdfmake.elementWriter.prototype
    1. function pdfmake.elementWriter.prototype.addFragment (block, useBlockXOffset, useBlockYOffset, dontUpdateContextPosition)
    2. function pdfmake.elementWriter.prototype.addImage (image, index)
    3. function pdfmake.elementWriter.prototype.addLine (line, dontUpdateContextPosition, index)
    4. function pdfmake.elementWriter.prototype.addQr (qr, index)
    5. function pdfmake.elementWriter.prototype.addVector (vector, ignoreContextX, ignoreContextY, index)
    6. function pdfmake.elementWriter.prototype.alignImage (image)
    7. function pdfmake.elementWriter.prototype.alignLine (line)
    8. function pdfmake.elementWriter.prototype.getCurrentPositionOnPage ()
    9. function pdfmake.elementWriter.prototype.popContext ()
    10. function pdfmake.elementWriter.prototype.pushContext (contextOrWidth, height)
  9. module pdfmake.fontProvider
    1. function pdfmake.fontProvider (fontDescriptors, pdfKitDoc)
  10. module pdfmake.fontProvider.prototype
    1. function pdfmake.fontProvider.prototype.provideFont (familyName, bold, italics)
  11. module pdfmake.helpers
    1. function pdfmake.helpers.fontStringify (key, val)
    2. function pdfmake.helpers.isFunction (functionToCheck)
    3. function pdfmake.helpers.offsetVector (vector, x, y)
    4. function pdfmake.helpers.pack ()
  12. module pdfmake.imageMeasure
    1. function pdfmake.imageMeasure (pdfKitDoc, imageDictionary)
  13. module pdfmake.imageMeasure.prototype
    1. function pdfmake.imageMeasure.prototype.measureImage (src)
  14. module pdfmake.layoutBuilder
    1. function pdfmake.layoutBuilder (pageSize, pageMargins, imageMeasure)
  15. module pdfmake.layoutBuilder.prototype
    1. function pdfmake.layoutBuilder.prototype.addBackground (background)
    2. function pdfmake.layoutBuilder.prototype.addDynamicRepeatable (nodeGetter, sizeFunction)
    3. function pdfmake.layoutBuilder.prototype.addHeadersAndFooters (header, footer)
    4. function pdfmake.layoutBuilder.prototype.addStaticRepeatable (headerOrFooter, sizeFunction)
    5. function pdfmake.layoutBuilder.prototype.addWatermark (watermark, fontProvider, defaultStyle)
    6. function pdfmake.layoutBuilder.prototype.buildNextLine (textNode)
    7. function pdfmake.layoutBuilder.prototype.layoutDocument (docStructure, fontProvider, styleDictionary, defaultStyle, background, header, footer, images, watermark, pageBreakBeforeFct )
    8. function pdfmake.layoutBuilder.prototype.processCanvas (node)
    9. function pdfmake.layoutBuilder.prototype.processColumns (columnNode)
    10. function pdfmake.layoutBuilder.prototype.processImage (node)
    11. function pdfmake.layoutBuilder.prototype.processLeaf (node)
    12. function pdfmake.layoutBuilder.prototype.processList (orderedList, node)
    13. function pdfmake.layoutBuilder.prototype.processNode (node)
    14. function pdfmake.layoutBuilder.prototype.processQr (node)
    15. function pdfmake.layoutBuilder.prototype.processRow (columns, widths, gaps, tableBody, tableRow)
    16. function pdfmake.layoutBuilder.prototype.processTable (tableNode)
    17. function pdfmake.layoutBuilder.prototype.processVerticalContainer (node)
    18. function pdfmake.layoutBuilder.prototype.registerTableLayouts (tableLayouts)
    19. function pdfmake.layoutBuilder.prototype.tryLayoutDocument (docStructure, fontProvider, styleDictionary, defaultStyle, background, header, footer, images, watermark, pageBreakBeforeFct )
  16. module pdfmake.line
    1. function pdfmake.line (maxWidth)
  17. module pdfmake.line.prototype
    1. function pdfmake.line.prototype.addInline (inline)
    2. function pdfmake.line.prototype.getAscenderHeight ()
    3. function pdfmake.line.prototype.getHeight ()
    4. function pdfmake.line.prototype.getWidth ()
    5. function pdfmake.line.prototype.hasEnoughSpaceForInline (inline)
  18. module pdfmake.pageElementWriter
    1. function pdfmake.pageElementWriter (context, tracker)
  19. module pdfmake.pageElementWriter.prototype
    1. function pdfmake.pageElementWriter.prototype.addFragment (fragment, useBlockXOffset, useBlockYOffset, dontUpdateContextPosition)
    2. function pdfmake.pageElementWriter.prototype.addImage (image, index)
    3. function pdfmake.pageElementWriter.prototype.addLine (line, dontUpdateContextPosition, index)
    4. function pdfmake.pageElementWriter.prototype.addQr (qr, index)
    5. function pdfmake.pageElementWriter.prototype.addVector (vector, ignoreContextX, ignoreContextY, index)
    6. function pdfmake.pageElementWriter.prototype.beginUnbreakableBlock (width, height)
    7. function pdfmake.pageElementWriter.prototype.commitUnbreakableBlock (forcedX, forcedY)
    8. function pdfmake.pageElementWriter.prototype.context ()
    9. function pdfmake.pageElementWriter.prototype.currentBlockToRepeatable ()
    10. function pdfmake.pageElementWriter.prototype.moveToNextPage (pageOrientation)
    11. function pdfmake.pageElementWriter.prototype.popFromRepeatables ()
    12. function pdfmake.pageElementWriter.prototype.pushToRepeatables (rep)
  20. module pdfmake.pdfMake
    1. function pdfmake.pdfMake.createPdf (docDefinition)
  21. module pdfmake.qrEnc
    1. function pdfmake.qrEnc.measure (node)
  22. module pdfmake.styleContextStack
    1. function pdfmake.styleContextStack (styleDictionary, defaultStyle)
  23. module pdfmake.styleContextStack.prototype
    1. function pdfmake.styleContextStack.prototype.auto (item, callback)
    2. function pdfmake.styleContextStack.prototype.autopush (item)
    3. function pdfmake.styleContextStack.prototype.clone ()
    4. function pdfmake.styleContextStack.prototype.getProperty (property)
    5. function pdfmake.styleContextStack.prototype.pop (howMany)
    6. function pdfmake.styleContextStack.prototype.push (styleNameOrOverride)
  24. module pdfmake.tableProcessor
    1. function pdfmake.tableProcessor (tableNode)
  25. module pdfmake.tableProcessor.prototype
    1. function pdfmake.tableProcessor.prototype.beginRow (rowIndex, writer)
    2. function pdfmake.tableProcessor.prototype.beginTable (writer)
    3. function pdfmake.tableProcessor.prototype.drawHorizontalLine (lineIndex, writer, overrideY)
    4. function pdfmake.tableProcessor.prototype.drawVerticalLine (x, y0, y1, vLineIndex, writer)
    5. function pdfmake.tableProcessor.prototype.endRow (rowIndex, writer, pageBreaks)
    6. function pdfmake.tableProcessor.prototype.endTable (writer)
    7. function pdfmake.tableProcessor.prototype.onRowBreak (rowIndex, writer)
  26. module pdfmake.textDecorator
    1. function pdfmake.textDecorator.drawBackground (line, x, y, pdfKitDoc)
    2. function pdfmake.textDecorator.drawDecorations (line, x, y, pdfKitDoc)
  27. module pdfmake.textTools
    1. function pdfmake.textTools (fontProvider)
  28. module pdfmake.textTools.prototype
    1. function pdfmake.textTools.prototype.buildInlines (textArray, styleContextStack)
    2. function pdfmake.textTools.prototype.sizeOfString (text, styleContextStack)
  29. module pdfmake.traversalTracker
    1. function pdfmake.traversalTracker ()
  30. module pdfmake.traversalTracker.prototype
    1. function pdfmake.traversalTracker.prototype.auto (event, cb, innerBlock)
    2. function pdfmake.traversalTracker.prototype.emit (event)
    3. function pdfmake.traversalTracker.prototype.startTracking (event, cb)
    4. function pdfmake.traversalTracker.prototype.stopTracking (event, cb)

module pdfmake

function pdfmake (fontDescriptors)

function pdfmake.docMeasure (fontProvider, styleDictionary, defaultStyle, imageMeasure, tableLayouts, images)

function pdfmake.documentContext (pageSize, pageMargins)

function pdfmake.elementWriter (context, tracker)

function pdfmake.fontProvider (fontDescriptors, pdfKitDoc)

function pdfmake.imageMeasure (pdfKitDoc, imageDictionary)

function pdfmake.layoutBuilder (pageSize, pageMargins, imageMeasure)

function pdfmake.line (maxWidth)

function pdfmake.pageElementWriter (context, tracker)

function pdfmake.styleContextStack (styleDictionary, defaultStyle)

function pdfmake.tableProcessor (tableNode)

function pdfmake.textTools (fontProvider)

function pdfmake.traversalTracker ()

module pdfmake.columnCalculator

function pdfmake.columnCalculator.buildColumnWidths (columns, availableWidth)

function pdfmake.columnCalculator.isAutoColumn (column)

function pdfmake.columnCalculator.isStarColumn (column)

function pdfmake.columnCalculator.measureMinMax (columns)

module pdfmake.docMeasure

function pdfmake.docMeasure (fontProvider, styleDictionary, defaultStyle, imageMeasure, tableLayouts, images)

module pdfmake.docMeasure.prototype

function pdfmake.docMeasure.prototype.buildOrderedMarker (counter, styleStack, type, separator)

function pdfmake.docMeasure.prototype.buildUnorderedMarker (styleStack, gapSize, type)

function pdfmake.docMeasure.prototype.convertIfBase64Image (node)

function pdfmake.docMeasure.prototype.gapSizeForList ()

function pdfmake.docMeasure.prototype.measureCanvas (node)

function pdfmake.docMeasure.prototype.measureColumns (node)

function pdfmake.docMeasure.prototype.measureDocument (docStructure)

function pdfmake.docMeasure.prototype.measureImage (node)

function pdfmake.docMeasure.prototype.measureLeaf (node)

function pdfmake.docMeasure.prototype.measureNode (node)

function pdfmake.docMeasure.prototype.measureOrderedList (node)

function pdfmake.docMeasure.prototype.measureQr (node)

function pdfmake.docMeasure.prototype.measureTable (node)

function pdfmake.docMeasure.prototype.measureUnorderedList (node)

function pdfmake.docMeasure.prototype.measureVerticalContainer (node)

module pdfmake.documentContext

function pdfmake.documentContext (pageSize, pageMargins)

module pdfmake.documentContext.prototype

function pdfmake.documentContext.prototype.addMargin (left, right)

function pdfmake.documentContext.prototype.addPage (pageSize)

function pdfmake.documentContext.prototype.beginColumn (width, offset, endingCell)

function pdfmake.documentContext.prototype.beginColumnGroup ()

function pdfmake.documentContext.prototype.beginDetachedBlock ()

function pdfmake.documentContext.prototype.calculateBottomMost (destContext)

function pdfmake.documentContext.prototype.completeColumnGroup ()

function pdfmake.documentContext.prototype.endDetachedBlock ()

function pdfmake.documentContext.prototype.getCurrentPage ()

function pdfmake.documentContext.prototype.getCurrentPosition ()

function pdfmake.documentContext.prototype.initializePage ()

function pdfmake.documentContext.prototype.markEnding (endingCell)

function pdfmake.documentContext.prototype.moveDown (offset)

function pdfmake.documentContext.prototype.moveTo (x, y)

function pdfmake.documentContext.prototype.moveToNextPage (pageOrientation)

function pdfmake.documentContext.prototype.pageSnapshot ()

function pdfmake.documentContext.prototype.saveContextInEndingCell (endingCell)

module pdfmake.elementWriter

function pdfmake.elementWriter (context, tracker)

module pdfmake.elementWriter.prototype

function pdfmake.elementWriter.prototype.addFragment (block, useBlockXOffset, useBlockYOffset, dontUpdateContextPosition)

function pdfmake.elementWriter.prototype.addImage (image, index)

function pdfmake.elementWriter.prototype.addLine (line, dontUpdateContextPosition, index)

function pdfmake.elementWriter.prototype.addQr (qr, index)

function pdfmake.elementWriter.prototype.addVector (vector, ignoreContextX, ignoreContextY, index)

function pdfmake.elementWriter.prototype.alignImage (image)

function pdfmake.elementWriter.prototype.alignLine (line)

function pdfmake.elementWriter.prototype.getCurrentPositionOnPage ()

function pdfmake.elementWriter.prototype.popContext ()

function pdfmake.elementWriter.prototype.pushContext (contextOrWidth, height)

module pdfmake.fontProvider

function pdfmake.fontProvider (fontDescriptors, pdfKitDoc)

module pdfmake.fontProvider.prototype

function pdfmake.fontProvider.prototype.provideFont (familyName, bold, italics)

module pdfmake.helpers

function pdfmake.helpers.fontStringify (key, val)

function pdfmake.helpers.isFunction (functionToCheck)

function pdfmake.helpers.offsetVector (vector, x, y)

function pdfmake.helpers.pack ()

module pdfmake.imageMeasure

function pdfmake.imageMeasure (pdfKitDoc, imageDictionary)

module pdfmake.imageMeasure.prototype

function pdfmake.imageMeasure.prototype.measureImage (src)

module pdfmake.layoutBuilder

function pdfmake.layoutBuilder (pageSize, pageMargins, imageMeasure)

module pdfmake.layoutBuilder.prototype

function pdfmake.layoutBuilder.prototype.addBackground (background)

function pdfmake.layoutBuilder.prototype.addDynamicRepeatable (nodeGetter, sizeFunction)

function pdfmake.layoutBuilder.prototype.addHeadersAndFooters (header, footer)

function pdfmake.layoutBuilder.prototype.addStaticRepeatable (headerOrFooter, sizeFunction)

function pdfmake.layoutBuilder.prototype.addWatermark (watermark, fontProvider, defaultStyle)

function pdfmake.layoutBuilder.prototype.buildNextLine (textNode)

function pdfmake.layoutBuilder.prototype.layoutDocument (docStructure, fontProvider, styleDictionary, defaultStyle, background, header, footer, images, watermark, pageBreakBeforeFct )

function pdfmake.layoutBuilder.prototype.processCanvas (node)

function pdfmake.layoutBuilder.prototype.processColumns (columnNode)

function pdfmake.layoutBuilder.prototype.processImage (node)

function pdfmake.layoutBuilder.prototype.processLeaf (node)

function pdfmake.layoutBuilder.prototype.processList (orderedList, node)

function pdfmake.layoutBuilder.prototype.processNode (node)

function pdfmake.layoutBuilder.prototype.processQr (node)

function pdfmake.layoutBuilder.prototype.processRow (columns, widths, gaps, tableBody, tableRow)

function pdfmake.layoutBuilder.prototype.processTable (tableNode)

function pdfmake.layoutBuilder.prototype.processVerticalContainer (node)

function pdfmake.layoutBuilder.prototype.registerTableLayouts (tableLayouts)

function pdfmake.layoutBuilder.prototype.tryLayoutDocument (docStructure, fontProvider, styleDictionary, defaultStyle, background, header, footer, images, watermark, pageBreakBeforeFct )

module pdfmake.line

function pdfmake.line (maxWidth)

module pdfmake.line.prototype

function pdfmake.line.prototype.addInline (inline)

function pdfmake.line.prototype.getAscenderHeight ()

function pdfmake.line.prototype.getHeight ()

function pdfmake.line.prototype.getWidth ()

function pdfmake.line.prototype.hasEnoughSpaceForInline (inline)

module pdfmake.pageElementWriter

function pdfmake.pageElementWriter (context, tracker)

module pdfmake.pageElementWriter.prototype

function pdfmake.pageElementWriter.prototype.addFragment (fragment, useBlockXOffset, useBlockYOffset, dontUpdateContextPosition)

function pdfmake.pageElementWriter.prototype.addImage (image, index)

function pdfmake.pageElementWriter.prototype.addLine (line, dontUpdateContextPosition, index)

function pdfmake.pageElementWriter.prototype.addQr (qr, index)

function pdfmake.pageElementWriter.prototype.addVector (vector, ignoreContextX, ignoreContextY, index)

function pdfmake.pageElementWriter.prototype.beginUnbreakableBlock (width, height)

function pdfmake.pageElementWriter.prototype.commitUnbreakableBlock (forcedX, forcedY)

function pdfmake.pageElementWriter.prototype.context ()

function pdfmake.pageElementWriter.prototype.currentBlockToRepeatable ()

function pdfmake.pageElementWriter.prototype.moveToNextPage (pageOrientation)

function pdfmake.pageElementWriter.prototype.popFromRepeatables ()

function pdfmake.pageElementWriter.prototype.pushToRepeatables (rep)

module pdfmake.pdfMake

function pdfmake.pdfMake.createPdf (docDefinition)

module pdfmake.qrEnc

function pdfmake.qrEnc.measure (node)

module pdfmake.styleContextStack

function pdfmake.styleContextStack (styleDictionary, defaultStyle)

module pdfmake.styleContextStack.prototype

function pdfmake.styleContextStack.prototype.auto (item, callback)

function pdfmake.styleContextStack.prototype.autopush (item)

function pdfmake.styleContextStack.prototype.clone ()

function pdfmake.styleContextStack.prototype.getProperty (property)

function pdfmake.styleContextStack.prototype.pop (howMany)

function pdfmake.styleContextStack.prototype.push (styleNameOrOverride)

module pdfmake.tableProcessor

function pdfmake.tableProcessor (tableNode)

module pdfmake.tableProcessor.prototype

function pdfmake.tableProcessor.prototype.beginRow (rowIndex, writer)

function pdfmake.tableProcessor.prototype.beginTable (writer)

function pdfmake.tableProcessor.prototype.drawHorizontalLine (lineIndex, writer, overrideY)

function pdfmake.tableProcessor.prototype.drawVerticalLine (x, y0, y1, vLineIndex, writer)

function pdfmake.tableProcessor.prototype.endRow (rowIndex, writer, pageBreaks)

function pdfmake.tableProcessor.prototype.endTable (writer)

function pdfmake.tableProcessor.prototype.onRowBreak (rowIndex, writer)

module pdfmake.textDecorator

function pdfmake.textDecorator.drawBackground (line, x, y, pdfKitDoc)

function pdfmake.textDecorator.drawDecorations (line, x, y, pdfKitDoc)

module pdfmake.textTools

function pdfmake.textTools (fontProvider)

module pdfmake.textTools.prototype

function pdfmake.textTools.prototype.buildInlines (textArray, styleContextStack)

function pdfmake.textTools.prototype.sizeOfString (text, styleContextStack)

module pdfmake.traversalTracker

function pdfmake.traversalTracker ()

module pdfmake.traversalTracker.prototype

function pdfmake.traversalTracker.prototype.auto (event, cb, innerBlock)

function pdfmake.traversalTracker.prototype.emit (event)

function pdfmake.traversalTracker.prototype.startTracking (event, cb)

function pdfmake.traversalTracker.prototype.stopTracking (event, cb)

[ this document was created with utility2 ]