Repository files navigation

Generate PDF files in client-side JavaScript.

This is a fork ofMrRios' jsPDF modified to work withsvg2pdf.js, which converts SVG elements to PDF. Since version 2.0.0 this fork is fully compatible to the original version and comes with a large amount of additional features, making this fork also great for standalone usage.

Major changes and new features are:

• A global transformation matrix converts between the usual coordinate system (y axis down) and the PDF coordinate system (y axis up) instead of converting every single coordinate.
• PDF FormObjects
• Shading and tiling patterns
• Basic graphics state support
• Full line style support
• ...

With version 2.x.x, this fork is now completely compatible with MrRio's version of jsPDF, which means that all third-party plugins will now also work with this fork! In order to make this possible, we introduced an API-switch between two API modes:

• In "compat" API mode, jsPDF has the same API as MrRio's version, which means full compatibility with plugins. However, some advanced features like transformation matrices and patterns won't work. This is the default mode.
• In "advanced" API mode, jsPDF has the API you're used from the yWorks-fork 1.x.x versions. This means the availability of all advanced features like patterns, FormObjects and transformation matrices.

You can switch between the two modes by calling

doc.advancedAPI(doc=>{// your code})// ordoc.compatAPI(doc=>{// your code})

JsPDF will automatically switch back to the original API mode after the callback has run.

In addition to this API switch, here is a list of other API-breaking changes:

• Some fonts, that don't belong to the 12 standard PDF fonts, had a fallback previously. E.g. "arial" was mapped to "helvetica". Now, these fallbacks don't exist anymore and you have to provide all non-standard fonts yourself.
• The API of the angle/transform parametertext(...) method was clarified. See the API-doc for details.
• Thestyle,patternKey andpatternData of the path drawing methods are now deprecated and were replaced by a new set of path painting methods. Passingundefined as style argument will thus no longer result in a "n" path operator!
• There are four new path construction methods:moveTo,lineTo,curveTo andclose.
• There are eight new path painting operators, replacing thestyle,patternKey andpatternData arguments:stroke,fill,fillEvenOdd,fillStroke,fillStrokeEvenOdd,clip,clipEvenOdd anddiscardPath. The filling operators accept an optional pattern object.

vardoc=newjsPDF();doc.text(20,20,'Hello world.');doc.save('Test.pdf');

There's a live editor example at the top-levelindex.html.

Full API-docs are available throughdocs/index.html.

jsPDF has built in support for some basic fonts like Helvetica and Times. If you want to add custom fonts you will haveto pack them into a separate JavaScript file using thefontconverter/fontconverter.html. Load this file after jsPDF.

Currently only fonts which are encoded in the TrueType format (*.ttf) are supported.

Note that thejspdf-makeFonts tool is deprecated.

Build the library with

npm installnpm run build

This will fetch all dependencies and then compile thedist files. To see the examples locally you can start a web server withnpm start and go tolocalhost:8000.

(MIT License)

Copyright

• (c) 2010-2016 James Hall,https://github.com/MrRio/jsPDF
• (c) 2015-2018 yWorks GmbH,http://www.yworks.com/

Permission is hereby granted, free of charge, to any person obtaininga copy of this software and associated documentation files (the"Software"), to deal in the Software without restriction, includingwithout limitation the rights to use, copy, modify, merge, publish,distribute, sublicense, and/or sell copies of the Software, and topermit persons to whom the Software is furnished to do so, subject tothe following conditions:

The above copyright notice and this permission notice shall beincluded in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE ANDNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BELIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTIONOF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTIONWITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.