| 9 |
lars |
1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
|
2 |
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
|
3 |
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
|
4 |
<head>
|
|
|
5 |
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
|
|
6 |
<meta name="generator" content="JsDoc Toolkit" />
|
|
|
7 |
|
|
|
8 |
<title>JsDoc Reference - jsPDF</title>
|
|
|
9 |
|
|
|
10 |
<style type="text/css">
|
|
|
11 |
/* default.css */
|
|
|
12 |
body
|
|
|
13 |
{
|
|
|
14 |
font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
|
|
|
15 |
width: 800px;
|
|
|
16 |
}
|
|
|
17 |
|
|
|
18 |
.header
|
|
|
19 |
{
|
|
|
20 |
clear: both;
|
|
|
21 |
background-color: #ccc;
|
|
|
22 |
padding: 8px;
|
|
|
23 |
}
|
|
|
24 |
|
|
|
25 |
h1
|
|
|
26 |
{
|
|
|
27 |
font-size: 150%;
|
|
|
28 |
font-weight: bold;
|
|
|
29 |
padding: 0;
|
|
|
30 |
margin: 1em 0 0 .3em;
|
|
|
31 |
}
|
|
|
32 |
|
|
|
33 |
hr
|
|
|
34 |
{
|
|
|
35 |
border: none 0;
|
|
|
36 |
border-top: 1px solid #7F8FB1;
|
|
|
37 |
height: 1px;
|
|
|
38 |
}
|
|
|
39 |
|
|
|
40 |
pre.code
|
|
|
41 |
{
|
|
|
42 |
display: block;
|
|
|
43 |
padding: 8px;
|
|
|
44 |
border: 1px dashed #ccc;
|
|
|
45 |
}
|
|
|
46 |
|
|
|
47 |
#index
|
|
|
48 |
{
|
|
|
49 |
margin-top: 24px;
|
|
|
50 |
float: left;
|
|
|
51 |
width: 160px;
|
|
|
52 |
position: absolute;
|
|
|
53 |
left: 8px;
|
|
|
54 |
background-color: #F3F3F3;
|
|
|
55 |
padding: 8px;
|
|
|
56 |
}
|
|
|
57 |
|
|
|
58 |
#content
|
|
|
59 |
{
|
|
|
60 |
margin-left: 190px;
|
|
|
61 |
width: 600px;
|
|
|
62 |
}
|
|
|
63 |
|
|
|
64 |
.classList
|
|
|
65 |
{
|
|
|
66 |
list-style-type: none;
|
|
|
67 |
padding: 0;
|
|
|
68 |
margin: 0 0 0 8px;
|
|
|
69 |
font-family: arial, sans-serif;
|
|
|
70 |
font-size: 1em;
|
|
|
71 |
overflow: auto;
|
|
|
72 |
}
|
|
|
73 |
|
|
|
74 |
.classList li
|
|
|
75 |
{
|
|
|
76 |
padding: 0;
|
|
|
77 |
margin: 0 0 8px 0;
|
|
|
78 |
}
|
|
|
79 |
|
|
|
80 |
.summaryTable { width: 100%; }
|
|
|
81 |
|
|
|
82 |
h1.classTitle
|
|
|
83 |
{
|
|
|
84 |
font-size:170%;
|
|
|
85 |
line-height:130%;
|
|
|
86 |
}
|
|
|
87 |
|
|
|
88 |
h2 { font-size: 110%; }
|
|
|
89 |
caption, div.sectionTitle
|
|
|
90 |
{
|
|
|
91 |
background-color: #7F8FB1;
|
|
|
92 |
color: #fff;
|
|
|
93 |
font-size:130%;
|
|
|
94 |
text-align: left;
|
|
|
95 |
padding: 2px 6px 2px 6px;
|
|
|
96 |
border: 1px #7F8FB1 solid;
|
|
|
97 |
}
|
|
|
98 |
|
|
|
99 |
div.sectionTitle { margin-bottom: 8px; }
|
|
|
100 |
.summaryTable thead { display: none; }
|
|
|
101 |
|
|
|
102 |
.summaryTable td
|
|
|
103 |
{
|
|
|
104 |
vertical-align: top;
|
|
|
105 |
padding: 4px;
|
|
|
106 |
border-bottom: 1px #7F8FB1 solid;
|
|
|
107 |
border-right: 1px #7F8FB1 solid;
|
|
|
108 |
}
|
|
|
109 |
|
|
|
110 |
/*col#summaryAttributes {}*/
|
|
|
111 |
.summaryTable td.attributes
|
|
|
112 |
{
|
|
|
113 |
border-left: 1px #7F8FB1 solid;
|
|
|
114 |
width: 140px;
|
|
|
115 |
text-align: right;
|
|
|
116 |
}
|
|
|
117 |
|
|
|
118 |
td.attributes, .fixedFont
|
|
|
119 |
{
|
|
|
120 |
line-height: 15px;
|
|
|
121 |
color: #002EBE;
|
|
|
122 |
font-family: "Courier New",Courier,monospace;
|
|
|
123 |
font-size: 13px;
|
|
|
124 |
}
|
|
|
125 |
|
|
|
126 |
.summaryTable td.nameDescription
|
|
|
127 |
{
|
|
|
128 |
text-align: left;
|
|
|
129 |
font-size: 13px;
|
|
|
130 |
line-height: 15px;
|
|
|
131 |
}
|
|
|
132 |
|
|
|
133 |
.summaryTable td.nameDescription, .description
|
|
|
134 |
{
|
|
|
135 |
line-height: 15px;
|
|
|
136 |
padding: 4px;
|
|
|
137 |
padding-left: 4px;
|
|
|
138 |
}
|
|
|
139 |
|
|
|
140 |
.summaryTable { margin-bottom: 8px; }
|
|
|
141 |
|
|
|
142 |
ul.inheritsList
|
|
|
143 |
{
|
|
|
144 |
list-style: square;
|
|
|
145 |
margin-left: 20px;
|
|
|
146 |
padding-left: 0;
|
|
|
147 |
}
|
|
|
148 |
|
|
|
149 |
.detailList {
|
|
|
150 |
margin-left: 20px;
|
|
|
151 |
line-height: 15px;
|
|
|
152 |
}
|
|
|
153 |
.detailList dt { margin-left: 20px; }
|
|
|
154 |
|
|
|
155 |
.detailList .heading
|
|
|
156 |
{
|
|
|
157 |
font-weight: bold;
|
|
|
158 |
padding-bottom: 6px;
|
|
|
159 |
margin-left: 0;
|
|
|
160 |
}
|
|
|
161 |
|
|
|
162 |
.light, td.attributes, .light a:link, .light a:visited
|
|
|
163 |
{
|
|
|
164 |
color: #777;
|
|
|
165 |
font-style: italic;
|
|
|
166 |
}
|
|
|
167 |
|
|
|
168 |
.fineprint
|
|
|
169 |
{
|
|
|
170 |
text-align: right;
|
|
|
171 |
font-size: 10px;
|
|
|
172 |
}
|
|
|
173 |
</style>
|
|
|
174 |
</head>
|
|
|
175 |
|
|
|
176 |
<body>
|
|
|
177 |
<!-- ============================== header ================================= -->
|
|
|
178 |
<!-- begin static/header.html -->
|
|
|
179 |
<div id="header">
|
|
|
180 |
</div>
|
|
|
181 |
<!-- end static/header.html -->
|
|
|
182 |
|
|
|
183 |
<!-- ============================== classes index ============================ -->
|
|
|
184 |
<div id="index">
|
|
|
185 |
<!-- begin publish.classesIndex -->
|
|
|
186 |
<div align="center"><a href="../index.html">Class Index</a>
|
|
|
187 |
| <a href="../files.html">File Index</a></div>
|
|
|
188 |
<hr />
|
|
|
189 |
<h2>Classes</h2>
|
|
|
190 |
<ul class="classList">
|
|
|
191 |
|
|
|
192 |
<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
|
|
|
193 |
|
|
|
194 |
<li><a href="../symbols/FontObject.html">FontObject</a></li>
|
|
|
195 |
|
|
|
196 |
<li><a href="../symbols/jsPDF.html">jsPDF</a></li>
|
|
|
197 |
|
|
|
198 |
<li><a href="../symbols/PubSub.html">PubSub</a></li>
|
|
|
199 |
|
|
|
200 |
</ul>
|
|
|
201 |
<hr />
|
|
|
202 |
<!-- end publish.classesIndex -->
|
|
|
203 |
</div>
|
|
|
204 |
|
|
|
205 |
<div id="content">
|
|
|
206 |
<!-- ============================== class title ============================ -->
|
|
|
207 |
<h1 class="classTitle">
|
|
|
208 |
|
|
|
209 |
Class jsPDF
|
|
|
210 |
</h1>
|
|
|
211 |
|
|
|
212 |
<!-- ============================== class summary ========================== -->
|
|
|
213 |
<p class="description">
|
|
|
214 |
|
|
|
215 |
|
|
|
216 |
|
|
|
217 |
|
|
|
218 |
|
|
|
219 |
|
|
|
220 |
<br /><i>Defined in: </i> <a href="../symbols/src/c__work_jsPDF_jspdf.js.html">jspdf.js</a>.
|
|
|
221 |
|
|
|
222 |
</p>
|
|
|
223 |
|
|
|
224 |
<!-- ============================== constructor summary ==================== -->
|
|
|
225 |
|
|
|
226 |
<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class jsPDF.">
|
|
|
227 |
<caption>Class Summary</caption>
|
|
|
228 |
<thead>
|
|
|
229 |
<tr>
|
|
|
230 |
<th scope="col">Constructor Attributes</th>
|
|
|
231 |
<th scope="col">Constructor Name and Description</th>
|
|
|
232 |
</tr>
|
|
|
233 |
</thead>
|
|
|
234 |
<tbody>
|
|
|
235 |
<tr>
|
|
|
236 |
<td class="attributes"> </td>
|
|
|
237 |
<td class="nameDescription" >
|
|
|
238 |
<div class="fixedFont">
|
|
|
239 |
<b><a href="../symbols/jsPDF.html#constructor">jsPDF</a></b>(orientation, unit, format)
|
|
|
240 |
</div>
|
|
|
241 |
<div class="description">Creates new jsPDF document object instance</div>
|
|
|
242 |
</td>
|
|
|
243 |
</tr>
|
|
|
244 |
</tbody>
|
|
|
245 |
</table>
|
|
|
246 |
|
|
|
247 |
|
|
|
248 |
<!-- ============================== properties summary ===================== -->
|
|
|
249 |
|
|
|
250 |
|
|
|
251 |
|
|
|
252 |
<table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class jsPDF.">
|
|
|
253 |
<caption>Field Summary</caption>
|
|
|
254 |
<thead>
|
|
|
255 |
<tr>
|
|
|
256 |
<th scope="col">Field Attributes</th>
|
|
|
257 |
<th scope="col">Field Name and Description</th>
|
|
|
258 |
</tr>
|
|
|
259 |
</thead>
|
|
|
260 |
<tbody>
|
|
|
261 |
|
|
|
262 |
<tr>
|
|
|
263 |
<td class="attributes"> </td>
|
|
|
264 |
<td class="nameDescription">
|
|
|
265 |
<div class="fixedFont">
|
|
|
266 |
jsPDF.<b><a href="../symbols/jsPDF.html#.API">API</a></b>
|
|
|
267 |
</div>
|
|
|
268 |
<div class="description">jsPDF.API is a STATIC property of jsPDF class.</div>
|
|
|
269 |
</td>
|
|
|
270 |
</tr>
|
|
|
271 |
|
|
|
272 |
<tr>
|
|
|
273 |
<td class="attributes"> </td>
|
|
|
274 |
<td class="nameDescription">
|
|
|
275 |
<div class="fixedFont">
|
|
|
276 |
<b><a href="../symbols/jsPDF.html#CapJoinStyles">CapJoinStyles</a></b>
|
|
|
277 |
</div>
|
|
|
278 |
<div class="description">Is an Object providing a mapping from human-readable to
|
|
|
279 |
integer flag values designating the varieties of line cap
|
|
|
280 |
and join styles.</div>
|
|
|
281 |
</td>
|
|
|
282 |
</tr>
|
|
|
283 |
|
|
|
284 |
</tbody>
|
|
|
285 |
</table>
|
|
|
286 |
|
|
|
287 |
|
|
|
288 |
|
|
|
289 |
|
|
|
290 |
|
|
|
291 |
<!-- ============================== methods summary ======================== -->
|
|
|
292 |
|
|
|
293 |
|
|
|
294 |
|
|
|
295 |
<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class jsPDF.">
|
|
|
296 |
<caption>Method Summary</caption>
|
|
|
297 |
<thead>
|
|
|
298 |
<tr>
|
|
|
299 |
<th scope="col">Method Attributes</th>
|
|
|
300 |
<th scope="col">Method Name and Description</th>
|
|
|
301 |
</tr>
|
|
|
302 |
</thead>
|
|
|
303 |
<tbody>
|
|
|
304 |
|
|
|
305 |
<tr>
|
|
|
306 |
<td class="attributes"> </td>
|
|
|
307 |
<td class="nameDescription">
|
|
|
308 |
<div class="fixedFont"><b><a href="../symbols/jsPDF.html#addPage">addPage</a></b>()
|
|
|
309 |
</div>
|
|
|
310 |
<div class="description">Adds (and transfers the focus to) new page to the PDF document.</div>
|
|
|
311 |
</td>
|
|
|
312 |
</tr>
|
|
|
313 |
|
|
|
314 |
<tr>
|
|
|
315 |
<td class="attributes"> </td>
|
|
|
316 |
<td class="nameDescription">
|
|
|
317 |
<div class="fixedFont"><b><a href="../symbols/jsPDF.html#circle">circle</a></b>(x, y, r, style)
|
|
|
318 |
</div>
|
|
|
319 |
<div class="description">Adds an circle to PDF</div>
|
|
|
320 |
</td>
|
|
|
321 |
</tr>
|
|
|
322 |
|
|
|
323 |
<tr>
|
|
|
324 |
<td class="attributes"> </td>
|
|
|
325 |
<td class="nameDescription">
|
|
|
326 |
<div class="fixedFont"><b><a href="../symbols/jsPDF.html#ellipse">ellipse</a></b>(x, y, rx, rx, style)
|
|
|
327 |
</div>
|
|
|
328 |
<div class="description">Adds an ellipse to PDF</div>
|
|
|
329 |
</td>
|
|
|
330 |
</tr>
|
|
|
331 |
|
|
|
332 |
<tr>
|
|
|
333 |
<td class="attributes"> </td>
|
|
|
334 |
<td class="nameDescription">
|
|
|
335 |
<div class="fixedFont"><b><a href="../symbols/jsPDF.html#getFontList">getFontList</a></b>()
|
|
|
336 |
</div>
|
|
|
337 |
<div class="description">Returns an object - a tree of fontName to fontStyle relationships available to
|
|
|
338 |
active PDF document.</div>
|
|
|
339 |
</td>
|
|
|
340 |
</tr>
|
|
|
341 |
|
|
|
342 |
<tr>
|
|
|
343 |
<td class="attributes"> </td>
|
|
|
344 |
<td class="nameDescription">
|
|
|
345 |
<div class="fixedFont"><b><a href="../symbols/jsPDF.html#lines">lines</a></b>(lines, x, y, scale)
|
|
|
346 |
</div>
|
|
|
347 |
<div class="description">Adds series of curves (straight lines or cubic bezier curves) to canvas, starting at `x`, `y` coordinates.</div>
|
|
|
348 |
</td>
|
|
|
349 |
</tr>
|
|
|
350 |
|
|
|
351 |
<tr>
|
|
|
352 |
<td class="attributes"> </td>
|
|
|
353 |
<td class="nameDescription">
|
|
|
354 |
<div class="fixedFont"><b><a href="../symbols/jsPDF.html#output">output</a></b>(type, options)
|
|
|
355 |
</div>
|
|
|
356 |
<div class="description">Generates the PDF document.</div>
|
|
|
357 |
</td>
|
|
|
358 |
</tr>
|
|
|
359 |
|
|
|
360 |
<tr>
|
|
|
361 |
<td class="attributes"> </td>
|
|
|
362 |
<td class="nameDescription">
|
|
|
363 |
<div class="fixedFont"><b><a href="../symbols/jsPDF.html#rect">rect</a></b>(x, y, w, h, style)
|
|
|
364 |
</div>
|
|
|
365 |
<div class="description">Adds a rectangle to PDF</div>
|
|
|
366 |
</td>
|
|
|
367 |
</tr>
|
|
|
368 |
|
|
|
369 |
<tr>
|
|
|
370 |
<td class="attributes"> </td>
|
|
|
371 |
<td class="nameDescription">
|
|
|
372 |
<div class="fixedFont"><b><a href="../symbols/jsPDF.html#setDrawColor">setDrawColor</a></b>(ch1, ch2, ch3, ch4)
|
|
|
373 |
</div>
|
|
|
374 |
<div class="description">Sets the stroke color for upcoming elements.</div>
|
|
|
375 |
</td>
|
|
|
376 |
</tr>
|
|
|
377 |
|
|
|
378 |
<tr>
|
|
|
379 |
<td class="attributes"> </td>
|
|
|
380 |
<td class="nameDescription">
|
|
|
381 |
<div class="fixedFont"><b><a href="../symbols/jsPDF.html#setFillColor">setFillColor</a></b>(ch1, ch2, ch3, ch4)
|
|
|
382 |
</div>
|
|
|
383 |
<div class="description">Sets the fill color for upcoming elements.</div>
|
|
|
384 |
</td>
|
|
|
385 |
</tr>
|
|
|
386 |
|
|
|
387 |
<tr>
|
|
|
388 |
<td class="attributes"> </td>
|
|
|
389 |
<td class="nameDescription">
|
|
|
390 |
<div class="fixedFont"><b><a href="../symbols/jsPDF.html#setFont">setFont</a></b>(fontName, fontStyle)
|
|
|
391 |
</div>
|
|
|
392 |
<div class="description">Sets text font face, variant for upcoming text elements.</div>
|
|
|
393 |
</td>
|
|
|
394 |
</tr>
|
|
|
395 |
|
|
|
396 |
<tr>
|
|
|
397 |
<td class="attributes"> </td>
|
|
|
398 |
<td class="nameDescription">
|
|
|
399 |
<div class="fixedFont"><b><a href="../symbols/jsPDF.html#setFontSize">setFontSize</a></b>(size)
|
|
|
400 |
</div>
|
|
|
401 |
<div class="description">Sets font size for upcoming text elements.</div>
|
|
|
402 |
</td>
|
|
|
403 |
</tr>
|
|
|
404 |
|
|
|
405 |
<tr>
|
|
|
406 |
<td class="attributes"> </td>
|
|
|
407 |
<td class="nameDescription">
|
|
|
408 |
<div class="fixedFont"><b><a href="../symbols/jsPDF.html#setFontStyle">setFontStyle</a></b>(style)
|
|
|
409 |
</div>
|
|
|
410 |
<div class="description">Switches font style or variant for upcoming text elements,
|
|
|
411 |
while keeping the font face or family same.</div>
|
|
|
412 |
</td>
|
|
|
413 |
</tr>
|
|
|
414 |
|
|
|
415 |
<tr>
|
|
|
416 |
<td class="attributes"> </td>
|
|
|
417 |
<td class="nameDescription">
|
|
|
418 |
<div class="fixedFont"><b><a href="../symbols/jsPDF.html#setLineCap">setLineCap</a></b>(style)
|
|
|
419 |
</div>
|
|
|
420 |
<div class="description">Sets the line cap styles
|
|
|
421 |
See {jsPDF.CapJoinStyles} for variants</div>
|
|
|
422 |
</td>
|
|
|
423 |
</tr>
|
|
|
424 |
|
|
|
425 |
<tr>
|
|
|
426 |
<td class="attributes"> </td>
|
|
|
427 |
<td class="nameDescription">
|
|
|
428 |
<div class="fixedFont"><b><a href="../symbols/jsPDF.html#setLineJoin">setLineJoin</a></b>(style)
|
|
|
429 |
</div>
|
|
|
430 |
<div class="description">Sets the line join styles
|
|
|
431 |
See {jsPDF.CapJoinStyles} for variants</div>
|
|
|
432 |
</td>
|
|
|
433 |
</tr>
|
|
|
434 |
|
|
|
435 |
<tr>
|
|
|
436 |
<td class="attributes"> </td>
|
|
|
437 |
<td class="nameDescription">
|
|
|
438 |
<div class="fixedFont"><b><a href="../symbols/jsPDF.html#setLineWidth">setLineWidth</a></b>(width)
|
|
|
439 |
</div>
|
|
|
440 |
<div class="description">Sets line width for upcoming lines.</div>
|
|
|
441 |
</td>
|
|
|
442 |
</tr>
|
|
|
443 |
|
|
|
444 |
<tr>
|
|
|
445 |
<td class="attributes"> </td>
|
|
|
446 |
<td class="nameDescription">
|
|
|
447 |
<div class="fixedFont"><b><a href="../symbols/jsPDF.html#setProperties">setProperties</a></b>(A)
|
|
|
448 |
</div>
|
|
|
449 |
<div class="description">Adds a properties to the PDF document</div>
|
|
|
450 |
</td>
|
|
|
451 |
</tr>
|
|
|
452 |
|
|
|
453 |
<tr>
|
|
|
454 |
<td class="attributes"> </td>
|
|
|
455 |
<td class="nameDescription">
|
|
|
456 |
<div class="fixedFont"><b><a href="../symbols/jsPDF.html#setTextColor">setTextColor</a></b>(r, g, b)
|
|
|
457 |
</div>
|
|
|
458 |
<div class="description">Sets the text color for upcoming elements.</div>
|
|
|
459 |
</td>
|
|
|
460 |
</tr>
|
|
|
461 |
|
|
|
462 |
<tr>
|
|
|
463 |
<td class="attributes"> </td>
|
|
|
464 |
<td class="nameDescription">
|
|
|
465 |
<div class="fixedFont"><b><a href="../symbols/jsPDF.html#text">text</a></b>(text, x, y, flags)
|
|
|
466 |
</div>
|
|
|
467 |
<div class="description">Adds text to page.</div>
|
|
|
468 |
</td>
|
|
|
469 |
</tr>
|
|
|
470 |
|
|
|
471 |
<tr>
|
|
|
472 |
<td class="attributes"> </td>
|
|
|
473 |
<td class="nameDescription">
|
|
|
474 |
<div class="fixedFont"><b><a href="../symbols/jsPDF.html#triangle">triangle</a></b>(x1, y1, x2, y2, x3, y3, style)
|
|
|
475 |
</div>
|
|
|
476 |
<div class="description">Adds a triangle to PDF</div>
|
|
|
477 |
</td>
|
|
|
478 |
</tr>
|
|
|
479 |
|
|
|
480 |
</tbody>
|
|
|
481 |
</table>
|
|
|
482 |
|
|
|
483 |
|
|
|
484 |
|
|
|
485 |
|
|
|
486 |
<!-- ============================== events summary ======================== -->
|
|
|
487 |
|
|
|
488 |
|
|
|
489 |
<!-- ============================== constructor details ==================== -->
|
|
|
490 |
|
|
|
491 |
<div class="details"><a name="constructor"> </a>
|
|
|
492 |
<div class="sectionTitle">
|
|
|
493 |
Class Detail
|
|
|
494 |
</div>
|
|
|
495 |
|
|
|
496 |
<div class="fixedFont">
|
|
|
497 |
<b>jsPDF</b>(orientation, unit, format)
|
|
|
498 |
</div>
|
|
|
499 |
|
|
|
500 |
<div class="description">
|
|
|
501 |
Creates new jsPDF document object instance
|
|
|
502 |
|
|
|
503 |
</div>
|
|
|
504 |
|
|
|
505 |
|
|
|
506 |
|
|
|
507 |
|
|
|
508 |
|
|
|
509 |
<dl class="detailList">
|
|
|
510 |
<dt class="heading">Parameters:</dt>
|
|
|
511 |
|
|
|
512 |
<dt>
|
|
|
513 |
<b>orientation</b>
|
|
|
514 |
|
|
|
515 |
</dt>
|
|
|
516 |
<dd>One of "portrait" or "landscape" (or shortcuts "p" (Default), "l")</dd>
|
|
|
517 |
|
|
|
518 |
<dt>
|
|
|
519 |
<b>unit</b>
|
|
|
520 |
|
|
|
521 |
</dt>
|
|
|
522 |
<dd>Measurement unit to be used when coordinates are specified. One of "pt" (points), "mm" (Default), "cm", "in"</dd>
|
|
|
523 |
|
|
|
524 |
<dt>
|
|
|
525 |
<b>format</b>
|
|
|
526 |
|
|
|
527 |
</dt>
|
|
|
528 |
<dd>One of 'a3', 'a4' (Default),'a5' ,'letter' ,'legal'</dd>
|
|
|
529 |
|
|
|
530 |
</dl>
|
|
|
531 |
|
|
|
532 |
|
|
|
533 |
|
|
|
534 |
|
|
|
535 |
|
|
|
536 |
<dl class="detailList">
|
|
|
537 |
<dt class="heading">Returns:</dt>
|
|
|
538 |
|
|
|
539 |
<dd><span class="light fixedFont">{<a href="../symbols/jsPDF.html">jsPDF</a>}</span> </dd>
|
|
|
540 |
|
|
|
541 |
</dl>
|
|
|
542 |
|
|
|
543 |
|
|
|
544 |
|
|
|
545 |
|
|
|
546 |
</div>
|
|
|
547 |
|
|
|
548 |
|
|
|
549 |
<!-- ============================== field details ========================== -->
|
|
|
550 |
|
|
|
551 |
<div class="sectionTitle">
|
|
|
552 |
Field Detail
|
|
|
553 |
</div>
|
|
|
554 |
|
|
|
555 |
<a name=".API"> </a>
|
|
|
556 |
<div class="fixedFont">
|
|
|
557 |
|
|
|
558 |
|
|
|
559 |
<span class="light">jsPDF.</span><b>API</b>
|
|
|
560 |
|
|
|
561 |
</div>
|
|
|
562 |
<div class="description">
|
|
|
563 |
jsPDF.API is a STATIC property of jsPDF class.
|
|
|
564 |
jsPDF.API is an object you can add methods and properties to.
|
|
|
565 |
The methods / properties you add will show up in new jsPDF objects.
|
|
|
566 |
|
|
|
567 |
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.
|
|
|
568 |
Examples:
|
|
|
569 |
jsPDF.API.events['initialized'] = function(){ 'this' is API object }
|
|
|
570 |
jsPDF.API.events['addFont'] = function(added_font_object){ 'this' is API object }
|
|
|
571 |
|
|
|
572 |
|
|
|
573 |
</div>
|
|
|
574 |
|
|
|
575 |
|
|
|
576 |
|
|
|
577 |
<pre class="code"> jsPDF.API.mymethod = function(){
|
|
|
578 |
// 'this' will be ref to internal API object. see jsPDF source
|
|
|
579 |
// , so you can refer to built-in methods like so:
|
|
|
580 |
// this.line(....)
|
|
|
581 |
// this.text(....)
|
|
|
582 |
}
|
|
|
583 |
var pdfdoc = new jsPDF()
|
|
|
584 |
pdfdoc.mymethod() // <- !!!!!!</pre>
|
|
|
585 |
|
|
|
586 |
|
|
|
587 |
|
|
|
588 |
|
|
|
589 |
|
|
|
590 |
|
|
|
591 |
|
|
|
592 |
|
|
|
593 |
<hr />
|
|
|
594 |
|
|
|
595 |
<a name="CapJoinStyles"> </a>
|
|
|
596 |
<div class="fixedFont">
|
|
|
597 |
|
|
|
598 |
<span class="light">{Object}</span>
|
|
|
599 |
<b>CapJoinStyles</b>
|
|
|
600 |
|
|
|
601 |
</div>
|
|
|
602 |
<div class="description">
|
|
|
603 |
Is an Object providing a mapping from human-readable to
|
|
|
604 |
integer flag values designating the varieties of line cap
|
|
|
605 |
and join styles.
|
|
|
606 |
|
|
|
607 |
|
|
|
608 |
</div>
|
|
|
609 |
|
|
|
610 |
|
|
|
611 |
|
|
|
612 |
|
|
|
613 |
|
|
|
614 |
|
|
|
615 |
|
|
|
616 |
|
|
|
617 |
|
|
|
618 |
|
|
|
619 |
|
|
|
620 |
|
|
|
621 |
<!-- ============================== method details ========================= -->
|
|
|
622 |
|
|
|
623 |
<div class="sectionTitle">
|
|
|
624 |
Method Detail
|
|
|
625 |
</div>
|
|
|
626 |
|
|
|
627 |
<a name="addPage"> </a>
|
|
|
628 |
<div class="fixedFont">
|
|
|
629 |
|
|
|
630 |
<span class="light">{<a href="../symbols/jsPDF.html">jsPDF</a>}</span>
|
|
|
631 |
<b>addPage</b>()
|
|
|
632 |
|
|
|
633 |
</div>
|
|
|
634 |
<div class="description">
|
|
|
635 |
Adds (and transfers the focus to) new page to the PDF document.
|
|
|
636 |
|
|
|
637 |
|
|
|
638 |
</div>
|
|
|
639 |
|
|
|
640 |
|
|
|
641 |
|
|
|
642 |
|
|
|
643 |
|
|
|
644 |
|
|
|
645 |
|
|
|
646 |
|
|
|
647 |
<dl class="detailList">
|
|
|
648 |
<dt class="heading">Returns:</dt>
|
|
|
649 |
|
|
|
650 |
<dd><span class="light fixedFont">{<a href="../symbols/jsPDF.html">jsPDF</a>}</span> </dd>
|
|
|
651 |
|
|
|
652 |
</dl>
|
|
|
653 |
|
|
|
654 |
|
|
|
655 |
|
|
|
656 |
|
|
|
657 |
<hr />
|
|
|
658 |
|
|
|
659 |
<a name="circle"> </a>
|
|
|
660 |
<div class="fixedFont">
|
|
|
661 |
|
|
|
662 |
<span class="light">{<a href="../symbols/jsPDF.html">jsPDF</a>}</span>
|
|
|
663 |
<b>circle</b>(x, y, r, style)
|
|
|
664 |
|
|
|
665 |
</div>
|
|
|
666 |
<div class="description">
|
|
|
667 |
Adds an circle to PDF
|
|
|
668 |
|
|
|
669 |
|
|
|
670 |
</div>
|
|
|
671 |
|
|
|
672 |
|
|
|
673 |
|
|
|
674 |
|
|
|
675 |
<dl class="detailList">
|
|
|
676 |
<dt class="heading">Parameters:</dt>
|
|
|
677 |
|
|
|
678 |
<dt>
|
|
|
679 |
<span class="light fixedFont">{Number}</span> <b>x</b>
|
|
|
680 |
|
|
|
681 |
</dt>
|
|
|
682 |
<dd>Coordinate (in units declared at inception of PDF document) against left edge of the page</dd>
|
|
|
683 |
|
|
|
684 |
<dt>
|
|
|
685 |
<span class="light fixedFont">{Number}</span> <b>y</b>
|
|
|
686 |
|
|
|
687 |
</dt>
|
|
|
688 |
<dd>Coordinate (in units declared at inception of PDF document) against upper edge of the page</dd>
|
|
|
689 |
|
|
|
690 |
<dt>
|
|
|
691 |
<span class="light fixedFont">{Number}</span> <b>r</b>
|
|
|
692 |
|
|
|
693 |
</dt>
|
|
|
694 |
<dd>Radius (in units declared at inception of PDF document)</dd>
|
|
|
695 |
|
|
|
696 |
<dt>
|
|
|
697 |
<span class="light fixedFont">{String}</span> <b>style</b>
|
|
|
698 |
|
|
|
699 |
</dt>
|
|
|
700 |
<dd>(Defaults to active fill/stroke style) A string signalling if stroke, fill or both are to be applied.</dd>
|
|
|
701 |
|
|
|
702 |
</dl>
|
|
|
703 |
|
|
|
704 |
|
|
|
705 |
|
|
|
706 |
|
|
|
707 |
|
|
|
708 |
<dl class="detailList">
|
|
|
709 |
<dt class="heading">Returns:</dt>
|
|
|
710 |
|
|
|
711 |
<dd><span class="light fixedFont">{<a href="../symbols/jsPDF.html">jsPDF</a>}</span> </dd>
|
|
|
712 |
|
|
|
713 |
</dl>
|
|
|
714 |
|
|
|
715 |
|
|
|
716 |
|
|
|
717 |
|
|
|
718 |
<hr />
|
|
|
719 |
|
|
|
720 |
<a name="ellipse"> </a>
|
|
|
721 |
<div class="fixedFont">
|
|
|
722 |
|
|
|
723 |
<span class="light">{<a href="../symbols/jsPDF.html">jsPDF</a>}</span>
|
|
|
724 |
<b>ellipse</b>(x, y, rx, rx, style)
|
|
|
725 |
|
|
|
726 |
</div>
|
|
|
727 |
<div class="description">
|
|
|
728 |
Adds an ellipse to PDF
|
|
|
729 |
|
|
|
730 |
|
|
|
731 |
</div>
|
|
|
732 |
|
|
|
733 |
|
|
|
734 |
|
|
|
735 |
|
|
|
736 |
<dl class="detailList">
|
|
|
737 |
<dt class="heading">Parameters:</dt>
|
|
|
738 |
|
|
|
739 |
<dt>
|
|
|
740 |
<span class="light fixedFont">{Number}</span> <b>x</b>
|
|
|
741 |
|
|
|
742 |
</dt>
|
|
|
743 |
<dd>Coordinate (in units declared at inception of PDF document) against left edge of the page</dd>
|
|
|
744 |
|
|
|
745 |
<dt>
|
|
|
746 |
<span class="light fixedFont">{Number}</span> <b>y</b>
|
|
|
747 |
|
|
|
748 |
</dt>
|
|
|
749 |
<dd>Coordinate (in units declared at inception of PDF document) against upper edge of the page</dd>
|
|
|
750 |
|
|
|
751 |
<dt>
|
|
|
752 |
<span class="light fixedFont">{Number}</span> <b>rx</b>
|
|
|
753 |
|
|
|
754 |
</dt>
|
|
|
755 |
<dd>Radius along x axis (in units declared at inception of PDF document)</dd>
|
|
|
756 |
|
|
|
757 |
<dt>
|
|
|
758 |
<span class="light fixedFont">{Number}</span> <b>rx</b>
|
|
|
759 |
|
|
|
760 |
</dt>
|
|
|
761 |
<dd>Radius along y axis (in units declared at inception of PDF document)</dd>
|
|
|
762 |
|
|
|
763 |
<dt>
|
|
|
764 |
<span class="light fixedFont">{String}</span> <b>style</b>
|
|
|
765 |
|
|
|
766 |
</dt>
|
|
|
767 |
<dd>(Defaults to active fill/stroke style) A string signalling if stroke, fill or both are to be applied.</dd>
|
|
|
768 |
|
|
|
769 |
</dl>
|
|
|
770 |
|
|
|
771 |
|
|
|
772 |
|
|
|
773 |
|
|
|
774 |
|
|
|
775 |
<dl class="detailList">
|
|
|
776 |
<dt class="heading">Returns:</dt>
|
|
|
777 |
|
|
|
778 |
<dd><span class="light fixedFont">{<a href="../symbols/jsPDF.html">jsPDF</a>}</span> </dd>
|
|
|
779 |
|
|
|
780 |
</dl>
|
|
|
781 |
|
|
|
782 |
|
|
|
783 |
|
|
|
784 |
|
|
|
785 |
<hr />
|
|
|
786 |
|
|
|
787 |
<a name="getFontList"> </a>
|
|
|
788 |
<div class="fixedFont">
|
|
|
789 |
|
|
|
790 |
<span class="light">{Object}</span>
|
|
|
791 |
<b>getFontList</b>()
|
|
|
792 |
|
|
|
793 |
</div>
|
|
|
794 |
<div class="description">
|
|
|
795 |
Returns an object - a tree of fontName to fontStyle relationships available to
|
|
|
796 |
active PDF document.
|
|
|
797 |
|
|
|
798 |
|
|
|
799 |
</div>
|
|
|
800 |
|
|
|
801 |
|
|
|
802 |
|
|
|
803 |
|
|
|
804 |
|
|
|
805 |
|
|
|
806 |
|
|
|
807 |
|
|
|
808 |
<dl class="detailList">
|
|
|
809 |
<dt class="heading">Returns:</dt>
|
|
|
810 |
|
|
|
811 |
<dd><span class="light fixedFont">{Object}</span> Like {'times':['normal', 'italic', ... ], 'arial':['normal', 'bold', ... ], ... }</dd>
|
|
|
812 |
|
|
|
813 |
</dl>
|
|
|
814 |
|
|
|
815 |
|
|
|
816 |
|
|
|
817 |
|
|
|
818 |
<hr />
|
|
|
819 |
|
|
|
820 |
<a name="lines"> </a>
|
|
|
821 |
<div class="fixedFont">
|
|
|
822 |
|
|
|
823 |
<span class="light">{<a href="../symbols/jsPDF.html">jsPDF</a>}</span>
|
|
|
824 |
<b>lines</b>(lines, x, y, scale)
|
|
|
825 |
|
|
|
826 |
</div>
|
|
|
827 |
<div class="description">
|
|
|
828 |
Adds series of curves (straight lines or cubic bezier curves) to canvas, starting at `x`, `y` coordinates.
|
|
|
829 |
All data points in `lines` are relative to last line origin.
|
|
|
830 |
`x`, `y` become x1,y1 for first line / curve in the set.
|
|
|
831 |
For lines you only need to specify [x2, y2] - (ending point) vector against x1, y1 starting point.
|
|
|
832 |
For bezier curves you need to specify [x2,y2,x3,y3,x4,y4] - vectors to control points 1, 2, ending point. All vectors are against the start of the curve - x1,y1.
|
|
|
833 |
|
|
|
834 |
|
|
|
835 |
</div>
|
|
|
836 |
|
|
|
837 |
|
|
|
838 |
|
|
|
839 |
<pre class="code">.lines([[2,2],[-2,2],[1,1,2,2,3,3],[2,1]], 212,110, 10) // line, line, bezier curve, line</pre>
|
|
|
840 |
|
|
|
841 |
|
|
|
842 |
|
|
|
843 |
|
|
|
844 |
<dl class="detailList">
|
|
|
845 |
<dt class="heading">Parameters:</dt>
|
|
|
846 |
|
|
|
847 |
<dt>
|
|
|
848 |
<span class="light fixedFont">{Array}</span> <b>lines</b>
|
|
|
849 |
|
|
|
850 |
</dt>
|
|
|
851 |
<dd>Array of *vector* shifts as pairs (lines) or sextets (cubic bezier curves).</dd>
|
|
|
852 |
|
|
|
853 |
<dt>
|
|
|
854 |
<span class="light fixedFont">{Number}</span> <b>x</b>
|
|
|
855 |
|
|
|
856 |
</dt>
|
|
|
857 |
<dd>Coordinate (in units declared at inception of PDF document) against left edge of the page</dd>
|
|
|
858 |
|
|
|
859 |
<dt>
|
|
|
860 |
<span class="light fixedFont">{Number}</span> <b>y</b>
|
|
|
861 |
|
|
|
862 |
</dt>
|
|
|
863 |
<dd>Coordinate (in units declared at inception of PDF document) against upper edge of the page</dd>
|
|
|
864 |
|
|
|
865 |
<dt>
|
|
|
866 |
<span class="light fixedFont">{Number}</span> <b>scale</b>
|
|
|
867 |
|
|
|
868 |
</dt>
|
|
|
869 |
<dd>(Defaults to [1.0,1.0]) x,y Scaling factor for all vectors. Elements can be any floating number Sub-one makes drawing smaller. Over-one grows the drawing. Negative flips the direction.</dd>
|
|
|
870 |
|
|
|
871 |
</dl>
|
|
|
872 |
|
|
|
873 |
|
|
|
874 |
|
|
|
875 |
|
|
|
876 |
|
|
|
877 |
<dl class="detailList">
|
|
|
878 |
<dt class="heading">Returns:</dt>
|
|
|
879 |
|
|
|
880 |
<dd><span class="light fixedFont">{<a href="../symbols/jsPDF.html">jsPDF</a>}</span> </dd>
|
|
|
881 |
|
|
|
882 |
</dl>
|
|
|
883 |
|
|
|
884 |
|
|
|
885 |
|
|
|
886 |
|
|
|
887 |
<hr />
|
|
|
888 |
|
|
|
889 |
<a name="output"> </a>
|
|
|
890 |
<div class="fixedFont">
|
|
|
891 |
|
|
|
892 |
<span class="light">{<a href="../symbols/jsPDF.html">jsPDF</a>}</span>
|
|
|
893 |
<b>output</b>(type, options)
|
|
|
894 |
|
|
|
895 |
</div>
|
|
|
896 |
<div class="description">
|
|
|
897 |
Generates the PDF document.
|
|
|
898 |
Possible values:
|
|
|
899 |
datauristring (alias dataurlstring) - Data-Url-formatted data returned as string.
|
|
|
900 |
datauri (alias datauri) - Data-Url-formatted data pushed into current window's location (effectively reloading the window with contents of the PDF).
|
|
|
901 |
|
|
|
902 |
If `type` argument is undefined, output is raw body of resulting PDF returned as a string.
|
|
|
903 |
|
|
|
904 |
|
|
|
905 |
</div>
|
|
|
906 |
|
|
|
907 |
|
|
|
908 |
|
|
|
909 |
|
|
|
910 |
<dl class="detailList">
|
|
|
911 |
<dt class="heading">Parameters:</dt>
|
|
|
912 |
|
|
|
913 |
<dt>
|
|
|
914 |
<span class="light fixedFont">{String}</span> <b>type</b>
|
|
|
915 |
|
|
|
916 |
</dt>
|
|
|
917 |
<dd>A string identifying one of the possible output types.</dd>
|
|
|
918 |
|
|
|
919 |
<dt>
|
|
|
920 |
<span class="light fixedFont">{Object}</span> <b>options</b>
|
|
|
921 |
|
|
|
922 |
</dt>
|
|
|
923 |
<dd>An object providing some additional signalling to PDF generator.</dd>
|
|
|
924 |
|
|
|
925 |
</dl>
|
|
|
926 |
|
|
|
927 |
|
|
|
928 |
|
|
|
929 |
|
|
|
930 |
|
|
|
931 |
<dl class="detailList">
|
|
|
932 |
<dt class="heading">Returns:</dt>
|
|
|
933 |
|
|
|
934 |
<dd><span class="light fixedFont">{<a href="../symbols/jsPDF.html">jsPDF</a>}</span> </dd>
|
|
|
935 |
|
|
|
936 |
</dl>
|
|
|
937 |
|
|
|
938 |
|
|
|
939 |
|
|
|
940 |
|
|
|
941 |
<hr />
|
|
|
942 |
|
|
|
943 |
<a name="rect"> </a>
|
|
|
944 |
<div class="fixedFont">
|
|
|
945 |
|
|
|
946 |
<span class="light">{<a href="../symbols/jsPDF.html">jsPDF</a>}</span>
|
|
|
947 |
<b>rect</b>(x, y, w, h, style)
|
|
|
948 |
|
|
|
949 |
</div>
|
|
|
950 |
<div class="description">
|
|
|
951 |
Adds a rectangle to PDF
|
|
|
952 |
|
|
|
953 |
|
|
|
954 |
</div>
|
|
|
955 |
|
|
|
956 |
|
|
|
957 |
|
|
|
958 |
|
|
|
959 |
<dl class="detailList">
|
|
|
960 |
<dt class="heading">Parameters:</dt>
|
|
|
961 |
|
|
|
962 |
<dt>
|
|
|
963 |
<span class="light fixedFont">{Number}</span> <b>x</b>
|
|
|
964 |
|
|
|
965 |
</dt>
|
|
|
966 |
<dd>Coordinate (in units declared at inception of PDF document) against left edge of the page</dd>
|
|
|
967 |
|
|
|
968 |
<dt>
|
|
|
969 |
<span class="light fixedFont">{Number}</span> <b>y</b>
|
|
|
970 |
|
|
|
971 |
</dt>
|
|
|
972 |
<dd>Coordinate (in units declared at inception of PDF document) against upper edge of the page</dd>
|
|
|
973 |
|
|
|
974 |
<dt>
|
|
|
975 |
<span class="light fixedFont">{Number}</span> <b>w</b>
|
|
|
976 |
|
|
|
977 |
</dt>
|
|
|
978 |
<dd>Width (in units declared at inception of PDF document)</dd>
|
|
|
979 |
|
|
|
980 |
<dt>
|
|
|
981 |
<span class="light fixedFont">{Number}</span> <b>h</b>
|
|
|
982 |
|
|
|
983 |
</dt>
|
|
|
984 |
<dd>Height (in units declared at inception of PDF document)</dd>
|
|
|
985 |
|
|
|
986 |
<dt>
|
|
|
987 |
<span class="light fixedFont">{String}</span> <b>style</b>
|
|
|
988 |
|
|
|
989 |
</dt>
|
|
|
990 |
<dd>(Defaults to active fill/stroke style) A string signalling if stroke, fill or both are to be applied.</dd>
|
|
|
991 |
|
|
|
992 |
</dl>
|
|
|
993 |
|
|
|
994 |
|
|
|
995 |
|
|
|
996 |
|
|
|
997 |
|
|
|
998 |
<dl class="detailList">
|
|
|
999 |
<dt class="heading">Returns:</dt>
|
|
|
1000 |
|
|
|
1001 |
<dd><span class="light fixedFont">{<a href="../symbols/jsPDF.html">jsPDF</a>}</span> </dd>
|
|
|
1002 |
|
|
|
1003 |
</dl>
|
|
|
1004 |
|
|
|
1005 |
|
|
|
1006 |
|
|
|
1007 |
|
|
|
1008 |
<hr />
|
|
|
1009 |
|
|
|
1010 |
<a name="setDrawColor"> </a>
|
|
|
1011 |
<div class="fixedFont">
|
|
|
1012 |
|
|
|
1013 |
<span class="light">{<a href="../symbols/jsPDF.html">jsPDF</a>}</span>
|
|
|
1014 |
<b>setDrawColor</b>(ch1, ch2, ch3, ch4)
|
|
|
1015 |
|
|
|
1016 |
</div>
|
|
|
1017 |
<div class="description">
|
|
|
1018 |
Sets the stroke color for upcoming elements.
|
|
|
1019 |
|
|
|
1020 |
Depending on the number of arguments given, Gray, RGB, or CMYK
|
|
|
1021 |
color space is implied.
|
|
|
1022 |
|
|
|
1023 |
When only ch1 is given, "Gray" color space is implied and it
|
|
|
1024 |
must be a value in the range from 0.00 (solid black) to to 1.00 (white)
|
|
|
1025 |
if values are communicated as String types, or in range from 0 (black)
|
|
|
1026 |
to 255 (white) if communicated as Number type.
|
|
|
1027 |
The RGB-like 0-255 range is provided for backward compatibility.
|
|
|
1028 |
|
|
|
1029 |
When only ch1,ch2,ch3 are given, "RGB" color space is implied and each
|
|
|
1030 |
value must be in the range from 0.00 (minimum intensity) to to 1.00
|
|
|
1031 |
(max intensity) if values are communicated as String types, or
|
|
|
1032 |
from 0 (min intensity) to to 255 (max intensity) if values are communicated
|
|
|
1033 |
as Number types.
|
|
|
1034 |
The RGB-like 0-255 range is provided for backward compatibility.
|
|
|
1035 |
|
|
|
1036 |
When ch1,ch2,ch3,ch4 are given, "CMYK" color space is implied and each
|
|
|
1037 |
value must be a in the range from 0.00 (0% concentration) to to
|
|
|
1038 |
1.00 (100% concentration)
|
|
|
1039 |
|
|
|
1040 |
Because JavaScript treats fixed point numbers badly (rounds to
|
|
|
1041 |
floating point nearest to binary representation) it is highly advised to
|
|
|
1042 |
communicate the fractional numbers as String types, not JavaScript Number type.
|
|
|
1043 |
|
|
|
1044 |
|
|
|
1045 |
</div>
|
|
|
1046 |
|
|
|
1047 |
|
|
|
1048 |
|
|
|
1049 |
|
|
|
1050 |
<dl class="detailList">
|
|
|
1051 |
<dt class="heading">Parameters:</dt>
|
|
|
1052 |
|
|
|
1053 |
<dt>
|
|
|
1054 |
<span class="light fixedFont">{Number|String}</span> <b>ch1</b>
|
|
|
1055 |
|
|
|
1056 |
</dt>
|
|
|
1057 |
<dd>Color channel value</dd>
|
|
|
1058 |
|
|
|
1059 |
<dt>
|
|
|
1060 |
<span class="light fixedFont">{Number|String}</span> <b>ch2</b>
|
|
|
1061 |
|
|
|
1062 |
</dt>
|
|
|
1063 |
<dd>Color channel value</dd>
|
|
|
1064 |
|
|
|
1065 |
<dt>
|
|
|
1066 |
<span class="light fixedFont">{Number|String}</span> <b>ch3</b>
|
|
|
1067 |
|
|
|
1068 |
</dt>
|
|
|
1069 |
<dd>Color channel value</dd>
|
|
|
1070 |
|
|
|
1071 |
<dt>
|
|
|
1072 |
<span class="light fixedFont">{Number|String}</span> <b>ch4</b>
|
|
|
1073 |
|
|
|
1074 |
</dt>
|
|
|
1075 |
<dd>Color channel value</dd>
|
|
|
1076 |
|
|
|
1077 |
</dl>
|
|
|
1078 |
|
|
|
1079 |
|
|
|
1080 |
|
|
|
1081 |
|
|
|
1082 |
|
|
|
1083 |
<dl class="detailList">
|
|
|
1084 |
<dt class="heading">Returns:</dt>
|
|
|
1085 |
|
|
|
1086 |
<dd><span class="light fixedFont">{<a href="../symbols/jsPDF.html">jsPDF</a>}</span> </dd>
|
|
|
1087 |
|
|
|
1088 |
</dl>
|
|
|
1089 |
|
|
|
1090 |
|
|
|
1091 |
|
|
|
1092 |
|
|
|
1093 |
<hr />
|
|
|
1094 |
|
|
|
1095 |
<a name="setFillColor"> </a>
|
|
|
1096 |
<div class="fixedFont">
|
|
|
1097 |
|
|
|
1098 |
<span class="light">{<a href="../symbols/jsPDF.html">jsPDF</a>}</span>
|
|
|
1099 |
<b>setFillColor</b>(ch1, ch2, ch3, ch4)
|
|
|
1100 |
|
|
|
1101 |
</div>
|
|
|
1102 |
<div class="description">
|
|
|
1103 |
Sets the fill color for upcoming elements.
|
|
|
1104 |
|
|
|
1105 |
Depending on the number of arguments given, Gray, RGB, or CMYK
|
|
|
1106 |
color space is implied.
|
|
|
1107 |
|
|
|
1108 |
When only ch1 is given, "Gray" color space is implied and it
|
|
|
1109 |
must be a value in the range from 0.00 (solid black) to to 1.00 (white)
|
|
|
1110 |
if values are communicated as String types, or in range from 0 (black)
|
|
|
1111 |
to 255 (white) if communicated as Number type.
|
|
|
1112 |
The RGB-like 0-255 range is provided for backward compatibility.
|
|
|
1113 |
|
|
|
1114 |
When only ch1,ch2,ch3 are given, "RGB" color space is implied and each
|
|
|
1115 |
value must be in the range from 0.00 (minimum intensity) to to 1.00
|
|
|
1116 |
(max intensity) if values are communicated as String types, or
|
|
|
1117 |
from 0 (min intensity) to to 255 (max intensity) if values are communicated
|
|
|
1118 |
as Number types.
|
|
|
1119 |
The RGB-like 0-255 range is provided for backward compatibility.
|
|
|
1120 |
|
|
|
1121 |
When ch1,ch2,ch3,ch4 are given, "CMYK" color space is implied and each
|
|
|
1122 |
value must be a in the range from 0.00 (0% concentration) to to
|
|
|
1123 |
1.00 (100% concentration)
|
|
|
1124 |
|
|
|
1125 |
Because JavaScript treats fixed point numbers badly (rounds to
|
|
|
1126 |
floating point nearest to binary representation) it is highly advised to
|
|
|
1127 |
communicate the fractional numbers as String types, not JavaScript Number type.
|
|
|
1128 |
|
|
|
1129 |
|
|
|
1130 |
</div>
|
|
|
1131 |
|
|
|
1132 |
|
|
|
1133 |
|
|
|
1134 |
|
|
|
1135 |
<dl class="detailList">
|
|
|
1136 |
<dt class="heading">Parameters:</dt>
|
|
|
1137 |
|
|
|
1138 |
<dt>
|
|
|
1139 |
<span class="light fixedFont">{Number|String}</span> <b>ch1</b>
|
|
|
1140 |
|
|
|
1141 |
</dt>
|
|
|
1142 |
<dd>Color channel value</dd>
|
|
|
1143 |
|
|
|
1144 |
<dt>
|
|
|
1145 |
<span class="light fixedFont">{Number|String}</span> <b>ch2</b>
|
|
|
1146 |
|
|
|
1147 |
</dt>
|
|
|
1148 |
<dd>Color channel value</dd>
|
|
|
1149 |
|
|
|
1150 |
<dt>
|
|
|
1151 |
<span class="light fixedFont">{Number|String}</span> <b>ch3</b>
|
|
|
1152 |
|
|
|
1153 |
</dt>
|
|
|
1154 |
<dd>Color channel value</dd>
|
|
|
1155 |
|
|
|
1156 |
<dt>
|
|
|
1157 |
<span class="light fixedFont">{Number|String}</span> <b>ch4</b>
|
|
|
1158 |
|
|
|
1159 |
</dt>
|
|
|
1160 |
<dd>Color channel value</dd>
|
|
|
1161 |
|
|
|
1162 |
</dl>
|
|
|
1163 |
|
|
|
1164 |
|
|
|
1165 |
|
|
|
1166 |
|
|
|
1167 |
|
|
|
1168 |
<dl class="detailList">
|
|
|
1169 |
<dt class="heading">Returns:</dt>
|
|
|
1170 |
|
|
|
1171 |
<dd><span class="light fixedFont">{<a href="../symbols/jsPDF.html">jsPDF</a>}</span> </dd>
|
|
|
1172 |
|
|
|
1173 |
</dl>
|
|
|
1174 |
|
|
|
1175 |
|
|
|
1176 |
|
|
|
1177 |
|
|
|
1178 |
<hr />
|
|
|
1179 |
|
|
|
1180 |
<a name="setFont"> </a>
|
|
|
1181 |
<div class="fixedFont">
|
|
|
1182 |
|
|
|
1183 |
<span class="light">{<a href="../symbols/jsPDF.html">jsPDF</a>}</span>
|
|
|
1184 |
<b>setFont</b>(fontName, fontStyle)
|
|
|
1185 |
|
|
|
1186 |
</div>
|
|
|
1187 |
<div class="description">
|
|
|
1188 |
Sets text font face, variant for upcoming text elements.
|
|
|
1189 |
See output of jsPDF.getFontList() for possible font names, styles.
|
|
|
1190 |
|
|
|
1191 |
|
|
|
1192 |
</div>
|
|
|
1193 |
|
|
|
1194 |
|
|
|
1195 |
|
|
|
1196 |
|
|
|
1197 |
<dl class="detailList">
|
|
|
1198 |
<dt class="heading">Parameters:</dt>
|
|
|
1199 |
|
|
|
1200 |
<dt>
|
|
|
1201 |
<span class="light fixedFont">{String}</span> <b>fontName</b>
|
|
|
1202 |
|
|
|
1203 |
</dt>
|
|
|
1204 |
<dd>Font name or family. Example: "times"</dd>
|
|
|
1205 |
|
|
|
1206 |
<dt>
|
|
|
1207 |
<span class="light fixedFont">{String}</span> <b>fontStyle</b>
|
|
|
1208 |
|
|
|
1209 |
</dt>
|
|
|
1210 |
<dd>Font style or variant. Example: "italic"</dd>
|
|
|
1211 |
|
|
|
1212 |
</dl>
|
|
|
1213 |
|
|
|
1214 |
|
|
|
1215 |
|
|
|
1216 |
|
|
|
1217 |
|
|
|
1218 |
<dl class="detailList">
|
|
|
1219 |
<dt class="heading">Returns:</dt>
|
|
|
1220 |
|
|
|
1221 |
<dd><span class="light fixedFont">{<a href="../symbols/jsPDF.html">jsPDF</a>}</span> </dd>
|
|
|
1222 |
|
|
|
1223 |
</dl>
|
|
|
1224 |
|
|
|
1225 |
|
|
|
1226 |
|
|
|
1227 |
|
|
|
1228 |
<hr />
|
|
|
1229 |
|
|
|
1230 |
<a name="setFontSize"> </a>
|
|
|
1231 |
<div class="fixedFont">
|
|
|
1232 |
|
|
|
1233 |
<span class="light">{<a href="../symbols/jsPDF.html">jsPDF</a>}</span>
|
|
|
1234 |
<b>setFontSize</b>(size)
|
|
|
1235 |
|
|
|
1236 |
</div>
|
|
|
1237 |
<div class="description">
|
|
|
1238 |
Sets font size for upcoming text elements.
|
|
|
1239 |
|
|
|
1240 |
|
|
|
1241 |
</div>
|
|
|
1242 |
|
|
|
1243 |
|
|
|
1244 |
|
|
|
1245 |
|
|
|
1246 |
<dl class="detailList">
|
|
|
1247 |
<dt class="heading">Parameters:</dt>
|
|
|
1248 |
|
|
|
1249 |
<dt>
|
|
|
1250 |
<span class="light fixedFont">{Number}</span> <b>size</b>
|
|
|
1251 |
|
|
|
1252 |
</dt>
|
|
|
1253 |
<dd>Font size in points.</dd>
|
|
|
1254 |
|
|
|
1255 |
</dl>
|
|
|
1256 |
|
|
|
1257 |
|
|
|
1258 |
|
|
|
1259 |
|
|
|
1260 |
|
|
|
1261 |
<dl class="detailList">
|
|
|
1262 |
<dt class="heading">Returns:</dt>
|
|
|
1263 |
|
|
|
1264 |
<dd><span class="light fixedFont">{<a href="../symbols/jsPDF.html">jsPDF</a>}</span> </dd>
|
|
|
1265 |
|
|
|
1266 |
</dl>
|
|
|
1267 |
|
|
|
1268 |
|
|
|
1269 |
|
|
|
1270 |
|
|
|
1271 |
<hr />
|
|
|
1272 |
|
|
|
1273 |
<a name="setFontStyle"> </a>
|
|
|
1274 |
<div class="fixedFont">
|
|
|
1275 |
|
|
|
1276 |
<span class="light">{<a href="../symbols/jsPDF.html">jsPDF</a>}</span>
|
|
|
1277 |
<b>setFontStyle</b>(style)
|
|
|
1278 |
|
|
|
1279 |
</div>
|
|
|
1280 |
<div class="description">
|
|
|
1281 |
Switches font style or variant for upcoming text elements,
|
|
|
1282 |
while keeping the font face or family same.
|
|
|
1283 |
See output of jsPDF.getFontList() for possible font names, styles.
|
|
|
1284 |
|
|
|
1285 |
|
|
|
1286 |
</div>
|
|
|
1287 |
|
|
|
1288 |
|
|
|
1289 |
|
|
|
1290 |
|
|
|
1291 |
<dl class="detailList">
|
|
|
1292 |
<dt class="heading">Parameters:</dt>
|
|
|
1293 |
|
|
|
1294 |
<dt>
|
|
|
1295 |
<span class="light fixedFont">{String}</span> <b>style</b>
|
|
|
1296 |
|
|
|
1297 |
</dt>
|
|
|
1298 |
<dd>Font style or variant. Example: "italic"</dd>
|
|
|
1299 |
|
|
|
1300 |
</dl>
|
|
|
1301 |
|
|
|
1302 |
|
|
|
1303 |
|
|
|
1304 |
|
|
|
1305 |
|
|
|
1306 |
<dl class="detailList">
|
|
|
1307 |
<dt class="heading">Returns:</dt>
|
|
|
1308 |
|
|
|
1309 |
<dd><span class="light fixedFont">{<a href="../symbols/jsPDF.html">jsPDF</a>}</span> </dd>
|
|
|
1310 |
|
|
|
1311 |
</dl>
|
|
|
1312 |
|
|
|
1313 |
|
|
|
1314 |
|
|
|
1315 |
|
|
|
1316 |
<hr />
|
|
|
1317 |
|
|
|
1318 |
<a name="setLineCap"> </a>
|
|
|
1319 |
<div class="fixedFont">
|
|
|
1320 |
|
|
|
1321 |
<span class="light">{<a href="../symbols/jsPDF.html">jsPDF</a>}</span>
|
|
|
1322 |
<b>setLineCap</b>(style)
|
|
|
1323 |
|
|
|
1324 |
</div>
|
|
|
1325 |
<div class="description">
|
|
|
1326 |
Sets the line cap styles
|
|
|
1327 |
See {jsPDF.CapJoinStyles} for variants
|
|
|
1328 |
|
|
|
1329 |
|
|
|
1330 |
</div>
|
|
|
1331 |
|
|
|
1332 |
|
|
|
1333 |
|
|
|
1334 |
|
|
|
1335 |
<dl class="detailList">
|
|
|
1336 |
<dt class="heading">Parameters:</dt>
|
|
|
1337 |
|
|
|
1338 |
<dt>
|
|
|
1339 |
<span class="light fixedFont">{String|Number}</span> <b>style</b>
|
|
|
1340 |
|
|
|
1341 |
</dt>
|
|
|
1342 |
<dd>A string or number identifying the type of line cap</dd>
|
|
|
1343 |
|
|
|
1344 |
</dl>
|
|
|
1345 |
|
|
|
1346 |
|
|
|
1347 |
|
|
|
1348 |
|
|
|
1349 |
|
|
|
1350 |
<dl class="detailList">
|
|
|
1351 |
<dt class="heading">Returns:</dt>
|
|
|
1352 |
|
|
|
1353 |
<dd><span class="light fixedFont">{<a href="../symbols/jsPDF.html">jsPDF</a>}</span> </dd>
|
|
|
1354 |
|
|
|
1355 |
</dl>
|
|
|
1356 |
|
|
|
1357 |
|
|
|
1358 |
|
|
|
1359 |
|
|
|
1360 |
<hr />
|
|
|
1361 |
|
|
|
1362 |
<a name="setLineJoin"> </a>
|
|
|
1363 |
<div class="fixedFont">
|
|
|
1364 |
|
|
|
1365 |
<span class="light">{<a href="../symbols/jsPDF.html">jsPDF</a>}</span>
|
|
|
1366 |
<b>setLineJoin</b>(style)
|
|
|
1367 |
|
|
|
1368 |
</div>
|
|
|
1369 |
<div class="description">
|
|
|
1370 |
Sets the line join styles
|
|
|
1371 |
See {jsPDF.CapJoinStyles} for variants
|
|
|
1372 |
|
|
|
1373 |
|
|
|
1374 |
</div>
|
|
|
1375 |
|
|
|
1376 |
|
|
|
1377 |
|
|
|
1378 |
|
|
|
1379 |
<dl class="detailList">
|
|
|
1380 |
<dt class="heading">Parameters:</dt>
|
|
|
1381 |
|
|
|
1382 |
<dt>
|
|
|
1383 |
<span class="light fixedFont">{String|Number}</span> <b>style</b>
|
|
|
1384 |
|
|
|
1385 |
</dt>
|
|
|
1386 |
<dd>A string or number identifying the type of line join</dd>
|
|
|
1387 |
|
|
|
1388 |
</dl>
|
|
|
1389 |
|
|
|
1390 |
|
|
|
1391 |
|
|
|
1392 |
|
|
|
1393 |
|
|
|
1394 |
<dl class="detailList">
|
|
|
1395 |
<dt class="heading">Returns:</dt>
|
|
|
1396 |
|
|
|
1397 |
<dd><span class="light fixedFont">{<a href="../symbols/jsPDF.html">jsPDF</a>}</span> </dd>
|
|
|
1398 |
|
|
|
1399 |
</dl>
|
|
|
1400 |
|
|
|
1401 |
|
|
|
1402 |
|
|
|
1403 |
|
|
|
1404 |
<hr />
|
|
|
1405 |
|
|
|
1406 |
<a name="setLineWidth"> </a>
|
|
|
1407 |
<div class="fixedFont">
|
|
|
1408 |
|
|
|
1409 |
<span class="light">{<a href="../symbols/jsPDF.html">jsPDF</a>}</span>
|
|
|
1410 |
<b>setLineWidth</b>(width)
|
|
|
1411 |
|
|
|
1412 |
</div>
|
|
|
1413 |
<div class="description">
|
|
|
1414 |
Sets line width for upcoming lines.
|
|
|
1415 |
|
|
|
1416 |
|
|
|
1417 |
</div>
|
|
|
1418 |
|
|
|
1419 |
|
|
|
1420 |
|
|
|
1421 |
|
|
|
1422 |
<dl class="detailList">
|
|
|
1423 |
<dt class="heading">Parameters:</dt>
|
|
|
1424 |
|
|
|
1425 |
<dt>
|
|
|
1426 |
<span class="light fixedFont">{Number}</span> <b>width</b>
|
|
|
1427 |
|
|
|
1428 |
</dt>
|
|
|
1429 |
<dd>Line width (in units declared at inception of PDF document)</dd>
|
|
|
1430 |
|
|
|
1431 |
</dl>
|
|
|
1432 |
|
|
|
1433 |
|
|
|
1434 |
|
|
|
1435 |
|
|
|
1436 |
|
|
|
1437 |
<dl class="detailList">
|
|
|
1438 |
<dt class="heading">Returns:</dt>
|
|
|
1439 |
|
|
|
1440 |
<dd><span class="light fixedFont">{<a href="../symbols/jsPDF.html">jsPDF</a>}</span> </dd>
|
|
|
1441 |
|
|
|
1442 |
</dl>
|
|
|
1443 |
|
|
|
1444 |
|
|
|
1445 |
|
|
|
1446 |
|
|
|
1447 |
<hr />
|
|
|
1448 |
|
|
|
1449 |
<a name="setProperties"> </a>
|
|
|
1450 |
<div class="fixedFont">
|
|
|
1451 |
|
|
|
1452 |
<span class="light">{<a href="../symbols/jsPDF.html">jsPDF</a>}</span>
|
|
|
1453 |
<b>setProperties</b>(A)
|
|
|
1454 |
|
|
|
1455 |
</div>
|
|
|
1456 |
<div class="description">
|
|
|
1457 |
Adds a properties to the PDF document
|
|
|
1458 |
|
|
|
1459 |
|
|
|
1460 |
</div>
|
|
|
1461 |
|
|
|
1462 |
|
|
|
1463 |
|
|
|
1464 |
|
|
|
1465 |
<dl class="detailList">
|
|
|
1466 |
<dt class="heading">Parameters:</dt>
|
|
|
1467 |
|
|
|
1468 |
<dt>
|
|
|
1469 |
<span class="light fixedFont">{Object}</span> <b>A</b>
|
|
|
1470 |
|
|
|
1471 |
</dt>
|
|
|
1472 |
<dd>property_name-to-property_value object structure.</dd>
|
|
|
1473 |
|
|
|
1474 |
</dl>
|
|
|
1475 |
|
|
|
1476 |
|
|
|
1477 |
|
|
|
1478 |
|
|
|
1479 |
|
|
|
1480 |
<dl class="detailList">
|
|
|
1481 |
<dt class="heading">Returns:</dt>
|
|
|
1482 |
|
|
|
1483 |
<dd><span class="light fixedFont">{<a href="../symbols/jsPDF.html">jsPDF</a>}</span> </dd>
|
|
|
1484 |
|
|
|
1485 |
</dl>
|
|
|
1486 |
|
|
|
1487 |
|
|
|
1488 |
|
|
|
1489 |
|
|
|
1490 |
<hr />
|
|
|
1491 |
|
|
|
1492 |
<a name="setTextColor"> </a>
|
|
|
1493 |
<div class="fixedFont">
|
|
|
1494 |
|
|
|
1495 |
<span class="light">{<a href="../symbols/jsPDF.html">jsPDF</a>}</span>
|
|
|
1496 |
<b>setTextColor</b>(r, g, b)
|
|
|
1497 |
|
|
|
1498 |
</div>
|
|
|
1499 |
<div class="description">
|
|
|
1500 |
Sets the text color for upcoming elements.
|
|
|
1501 |
If only one, first argument is given,
|
|
|
1502 |
treats the value as gray-scale color value.
|
|
|
1503 |
|
|
|
1504 |
|
|
|
1505 |
</div>
|
|
|
1506 |
|
|
|
1507 |
|
|
|
1508 |
|
|
|
1509 |
|
|
|
1510 |
<dl class="detailList">
|
|
|
1511 |
<dt class="heading">Parameters:</dt>
|
|
|
1512 |
|
|
|
1513 |
<dt>
|
|
|
1514 |
<span class="light fixedFont">{Number}</span> <b>r</b>
|
|
|
1515 |
|
|
|
1516 |
</dt>
|
|
|
1517 |
<dd>Red channel color value in range 0-255</dd>
|
|
|
1518 |
|
|
|
1519 |
<dt>
|
|
|
1520 |
<span class="light fixedFont">{Number}</span> <b>g</b>
|
|
|
1521 |
|
|
|
1522 |
</dt>
|
|
|
1523 |
<dd>Green channel color value in range 0-255</dd>
|
|
|
1524 |
|
|
|
1525 |
<dt>
|
|
|
1526 |
<span class="light fixedFont">{Number}</span> <b>b</b>
|
|
|
1527 |
|
|
|
1528 |
</dt>
|
|
|
1529 |
<dd>Blue channel color value in range 0-255</dd>
|
|
|
1530 |
|
|
|
1531 |
</dl>
|
|
|
1532 |
|
|
|
1533 |
|
|
|
1534 |
|
|
|
1535 |
|
|
|
1536 |
|
|
|
1537 |
<dl class="detailList">
|
|
|
1538 |
<dt class="heading">Returns:</dt>
|
|
|
1539 |
|
|
|
1540 |
<dd><span class="light fixedFont">{<a href="../symbols/jsPDF.html">jsPDF</a>}</span> </dd>
|
|
|
1541 |
|
|
|
1542 |
</dl>
|
|
|
1543 |
|
|
|
1544 |
|
|
|
1545 |
|
|
|
1546 |
|
|
|
1547 |
<hr />
|
|
|
1548 |
|
|
|
1549 |
<a name="text"> </a>
|
|
|
1550 |
<div class="fixedFont">
|
|
|
1551 |
|
|
|
1552 |
<span class="light">{<a href="../symbols/jsPDF.html">jsPDF</a>}</span>
|
|
|
1553 |
<b>text</b>(text, x, y, flags)
|
|
|
1554 |
|
|
|
1555 |
</div>
|
|
|
1556 |
<div class="description">
|
|
|
1557 |
Adds text to page. Supports adding multiline text when 'text' argument is an Array of Strings.
|
|
|
1558 |
|
|
|
1559 |
|
|
|
1560 |
</div>
|
|
|
1561 |
|
|
|
1562 |
|
|
|
1563 |
|
|
|
1564 |
|
|
|
1565 |
<dl class="detailList">
|
|
|
1566 |
<dt class="heading">Parameters:</dt>
|
|
|
1567 |
|
|
|
1568 |
<dt>
|
|
|
1569 |
<span class="light fixedFont">{String|Array}</span> <b>text</b>
|
|
|
1570 |
|
|
|
1571 |
</dt>
|
|
|
1572 |
<dd>String or array of strings to be added to the page. Each line is shifted one line down per font, spacing settings declared before this call.</dd>
|
|
|
1573 |
|
|
|
1574 |
<dt>
|
|
|
1575 |
<span class="light fixedFont">{Number}</span> <b>x</b>
|
|
|
1576 |
|
|
|
1577 |
</dt>
|
|
|
1578 |
<dd>Coordinate (in units declared at inception of PDF document) against left edge of the page</dd>
|
|
|
1579 |
|
|
|
1580 |
<dt>
|
|
|
1581 |
<span class="light fixedFont">{Number}</span> <b>y</b>
|
|
|
1582 |
|
|
|
1583 |
</dt>
|
|
|
1584 |
<dd>Coordinate (in units declared at inception of PDF document) against upper edge of the page</dd>
|
|
|
1585 |
|
|
|
1586 |
<dt>
|
|
|
1587 |
<span class="light fixedFont">{Object}</span> <b>flags</b>
|
|
|
1588 |
|
|
|
1589 |
</dt>
|
|
|
1590 |
<dd>Collection of settings signalling how the text must be encoded. Defaults are sane. If you think you want to pass some flags, you likely can read the source.</dd>
|
|
|
1591 |
|
|
|
1592 |
</dl>
|
|
|
1593 |
|
|
|
1594 |
|
|
|
1595 |
|
|
|
1596 |
|
|
|
1597 |
|
|
|
1598 |
<dl class="detailList">
|
|
|
1599 |
<dt class="heading">Returns:</dt>
|
|
|
1600 |
|
|
|
1601 |
<dd><span class="light fixedFont">{<a href="../symbols/jsPDF.html">jsPDF</a>}</span> </dd>
|
|
|
1602 |
|
|
|
1603 |
</dl>
|
|
|
1604 |
|
|
|
1605 |
|
|
|
1606 |
|
|
|
1607 |
|
|
|
1608 |
<hr />
|
|
|
1609 |
|
|
|
1610 |
<a name="triangle"> </a>
|
|
|
1611 |
<div class="fixedFont">
|
|
|
1612 |
|
|
|
1613 |
<span class="light">{<a href="../symbols/jsPDF.html">jsPDF</a>}</span>
|
|
|
1614 |
<b>triangle</b>(x1, y1, x2, y2, x3, y3, style)
|
|
|
1615 |
|
|
|
1616 |
</div>
|
|
|
1617 |
<div class="description">
|
|
|
1618 |
Adds a triangle to PDF
|
|
|
1619 |
|
|
|
1620 |
|
|
|
1621 |
</div>
|
|
|
1622 |
|
|
|
1623 |
|
|
|
1624 |
|
|
|
1625 |
|
|
|
1626 |
<dl class="detailList">
|
|
|
1627 |
<dt class="heading">Parameters:</dt>
|
|
|
1628 |
|
|
|
1629 |
<dt>
|
|
|
1630 |
<span class="light fixedFont">{Number}</span> <b>x1</b>
|
|
|
1631 |
|
|
|
1632 |
</dt>
|
|
|
1633 |
<dd>Coordinate (in units declared at inception of PDF document) against left edge of the page</dd>
|
|
|
1634 |
|
|
|
1635 |
<dt>
|
|
|
1636 |
<span class="light fixedFont">{Number}</span> <b>y1</b>
|
|
|
1637 |
|
|
|
1638 |
</dt>
|
|
|
1639 |
<dd>Coordinate (in units declared at inception of PDF document) against upper edge of the page</dd>
|
|
|
1640 |
|
|
|
1641 |
<dt>
|
|
|
1642 |
<span class="light fixedFont">{Number}</span> <b>x2</b>
|
|
|
1643 |
|
|
|
1644 |
</dt>
|
|
|
1645 |
<dd>Coordinate (in units declared at inception of PDF document) against left edge of the page</dd>
|
|
|
1646 |
|
|
|
1647 |
<dt>
|
|
|
1648 |
<span class="light fixedFont">{Number}</span> <b>y2</b>
|
|
|
1649 |
|
|
|
1650 |
</dt>
|
|
|
1651 |
<dd>Coordinate (in units declared at inception of PDF document) against upper edge of the page</dd>
|
|
|
1652 |
|
|
|
1653 |
<dt>
|
|
|
1654 |
<span class="light fixedFont">{Number}</span> <b>x3</b>
|
|
|
1655 |
|
|
|
1656 |
</dt>
|
|
|
1657 |
<dd>Coordinate (in units declared at inception of PDF document) against left edge of the page</dd>
|
|
|
1658 |
|
|
|
1659 |
<dt>
|
|
|
1660 |
<span class="light fixedFont">{Number}</span> <b>y3</b>
|
|
|
1661 |
|
|
|
1662 |
</dt>
|
|
|
1663 |
<dd>Coordinate (in units declared at inception of PDF document) against upper edge of the page</dd>
|
|
|
1664 |
|
|
|
1665 |
<dt>
|
|
|
1666 |
<span class="light fixedFont">{String}</span> <b>style</b>
|
|
|
1667 |
|
|
|
1668 |
</dt>
|
|
|
1669 |
<dd>(Defaults to active fill/stroke style) A string signalling if stroke, fill or both are to be applied.</dd>
|
|
|
1670 |
|
|
|
1671 |
</dl>
|
|
|
1672 |
|
|
|
1673 |
|
|
|
1674 |
|
|
|
1675 |
|
|
|
1676 |
|
|
|
1677 |
<dl class="detailList">
|
|
|
1678 |
<dt class="heading">Returns:</dt>
|
|
|
1679 |
|
|
|
1680 |
<dd><span class="light fixedFont">{<a href="../symbols/jsPDF.html">jsPDF</a>}</span> </dd>
|
|
|
1681 |
|
|
|
1682 |
</dl>
|
|
|
1683 |
|
|
|
1684 |
|
|
|
1685 |
|
|
|
1686 |
|
|
|
1687 |
|
|
|
1688 |
|
|
|
1689 |
|
|
|
1690 |
|
|
|
1691 |
<!-- ============================== event details ========================= -->
|
|
|
1692 |
|
|
|
1693 |
|
|
|
1694 |
<hr />
|
|
|
1695 |
</div>
|
|
|
1696 |
|
|
|
1697 |
|
|
|
1698 |
<!-- ============================== footer ================================= -->
|
|
|
1699 |
<div class="fineprint" style="clear:both">
|
|
|
1700 |
|
|
|
1701 |
Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 on Mon Oct 15 2012 22:41:49 GMT-0700 (PDT)
|
|
|
1702 |
</div>
|
|
|
1703 |
</body>
|
|
|
1704 |
</html>
|