123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8">
- <title>jsPDF - Documentation</title>
- <script src="scripts/prettify/prettify.js"></script>
- <script src="scripts/prettify/lang-css.js"></script>
- <!--[if lt IE 9]>
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
- <![endif]-->
- <link type="text/css" rel="stylesheet" href="styles/prettify.css">
- <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
- </head>
- <body>
- <input type="checkbox" id="nav-trigger" class="nav-trigger" />
- <label for="nav-trigger" class="navicon-button x">
- <div class="navicon"></div>
- </label>
- <label for="nav-trigger" class="overlay"></label>
- <nav>
- <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="jsPDF.html">jsPDF</a></li></ul><h3>Global</h3><ul><li><a href="global.html#addFont">addFont</a></li><li><a href="global.html#addHTML">addHTML</a></li><li><a href="global.html#addMetadata">addMetadata</a></li><li><a href="global.html#addPage">addPage</a></li><li><a href="global.html#autoPrint">autoPrint</a></li><li><a href="global.html#CapJoinStyles">CapJoinStyles</a></li><li><a href="global.html#circle">circle</a></li><li><a href="global.html#ellipse">ellipse</a></li><li><a href="global.html#getFontList">getFontList</a></li><li><a href="global.html#lines">lines</a></li><li><a href="global.html#lstext">lstext</a></li><li><a href="global.html#output">output</a></li><li><a href="global.html#rect">rect</a></li><li><a href="global.html#roundedRect">roundedRect</a></li><li><a href="global.html#save">save</a></li><li><a href="global.html#setDisplayMode">setDisplayMode</a></li><li><a href="global.html#setDrawColor">setDrawColor</a></li><li><a href="global.html#setFillColor">setFillColor</a></li><li><a href="global.html#setFont">setFont</a></li><li><a href="global.html#setFontSize">setFontSize</a></li><li><a href="global.html#setFontStyle">setFontStyle</a></li><li><a href="global.html#setLineCap">setLineCap</a></li><li><a href="global.html#setLineJoin">setLineJoin</a></li><li><a href="global.html#setLineWidth">setLineWidth</a></li><li><a href="global.html#setPage">setPage</a></li><li><a href="global.html#setProperties">setProperties</a></li><li><a href="global.html#setTextColor">setTextColor</a></li><li><a href="global.html#text">text</a></li><li><a href="global.html#triangle">triangle</a></li></ul>
- </nav>
- <div id="main">
-
- <h1 class="page-title">jsPDF</h1>
-
-
- <section>
- <header>
-
- <h2>
- jsPDF
- </h2>
-
-
- </header>
- <article>
- <div class="container-overview">
-
-
-
- <h4 class="name" id="jsPDF"><span class="type-signature"></span>new jsPDF<span class="signature">(orientation, unit, format)</span><span class="type-signature"> → {<a href="jsPDF.html">jsPDF</a>}</span></h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line47">line 47</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
- <div class="description">
- <p>Creates new jsPDF document object instance.</p>
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>orientation</code></td>
-
- <td class="type">
-
- </td>
-
-
- <td class="description last"><p>One of "portrait" or "landscape" (or shortcuts "p" (Default), "l")</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>unit</code></td>
-
- <td class="type">
-
- </td>
-
-
- <td class="description last"><p>Measurement unit to be used when coordinates are specified.
- One of "pt" (points), "mm" (Default), "cm", "in"</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>format</code></td>
-
- <td class="type">
-
- </td>
-
-
- <td class="description last"><p>One of 'pageFormats' as shown below, default: a4</p></td>
- </tr>
-
- </tbody>
- </table>
- <h5>Returns:</h5>
-
- <dl class="param-type">
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
- </dd>
- </dl>
-
-
- </div>
-
-
-
-
-
-
- <h3 class="subsection-title">Members</h3>
-
-
- <h4 class="name" id=".API"><span class="type-signature">(static) </span>API<span class="type-signature"></span></h4>
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line2217">line 2217</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
- <div class="description">
- <p>jsPDF.API is a STATIC property of jsPDF class.
- jsPDF.API is an object you can add methods and properties to.
- The methods / properties you add will show up in new jsPDF objects.</p>
- <p>One property is prepopulated. It is the 'events' Object. Plugin authors can add topics,
- callbacks to this object. These will be reassigned to all new instances of jsPDF.
- Examples:
- jsPDF.API.events['initialized'] = function(){ 'this' is API object }
- jsPDF.API.events['addFont'] = function(added_font_object){ 'this' is API object }</p>
- </div>
- <h5>Example</h5>
-
- <pre class="prettyprint"><code>jsPDF.API.mymethod = function(){
- // 'this' will be ref to internal API object. see jsPDF source
- // , so you can refer to built-in methods like so:
- // this.line(....)
- // this.text(....)
- }
- var pdfdoc = new jsPDF()
- pdfdoc.mymethod() // <- !!!!!!</code></pre>
-
-
-
-
-
- </article>
- </section>
- </div>
- <br class="clear">
- <footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.2</a> on Sun Oct 09 2016 11:08:27 GMT+0100 (BST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
- </footer>
- <script>prettyPrint();</script>
- <script src="scripts/linenumber.js"></script>
- </body>
- </html>
|