forked from parallax/jsPDF
-
Notifications
You must be signed in to change notification settings - Fork 9
/
jspdf.js
1691 lines (1520 loc) · 51.5 KB
/
jspdf.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/** @preserve jsPDF ( ${buildDate} ${commitID} )
Copyright (c) 2010 James Hall, https://github.com/MrRio/jsPDF
Copyright (c) 2012 Willow Systems Corporation, willow-systems.com
MIT license.
*/
/*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included 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 OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
* ====================================================================
*/
/**
Creates new jsPDF document object instance
@class
@param orientation One of "portrait" or "landscape" (or shortcuts "p" (Default), "l")
@param unit Measurement unit to be used when coordinates are specified. One of "pt" (points), "mm" (Default), "cm", "in"
@param format One of 'a3', 'a4' (Default),'a5' ,'letter' ,'legal'
@returns {jsPDF}
@name jsPDF
*/
var jsPDF = (function() {
'use strict'
// this will run on <=IE9, possibly some niche browsers
// new webkit-based, FireFox, IE10 already have native version of this.
if (typeof btoa === 'undefined') {
var btoa = function(data) {
// DO NOT ADD UTF8 ENCODING CODE HERE!!!!
// UTF8 encoding encodes bytes over char code 128
// and, essentially, turns an 8-bit binary streams
// (that base64 can deal with) into 7-bit binary streams.
// (by default server does not know that and does not recode the data back to 8bit)
// You destroy your data.
// binary streams like jpeg image data etc, while stored in JavaScript strings,
// (which are 16bit arrays) are in 8bit format already.
// You do NOT need to char-encode that before base64 encoding.
// if you, by act of fate
// have string which has individual characters with code
// above 255 (pure unicode chars), encode that BEFORE you base64 here.
// you can use absolutely any approch there, as long as in the end,
// base64 gets an 8bit (char codes 0 - 255) stream.
// when you get it on the server after un-base64, you must
// UNencode it too, to get back to 16, 32bit or whatever original bin stream.
// Note, Yes, JavaScript strings are, in most cases UCS-2 -
// 16-bit character arrays. This does not mean, however,
// that you always have to UTF8 it before base64.
// it means that if you have actual characters anywhere in
// that string that have char code above 255, you need to
// recode *entire* string from 16-bit (or 32bit) to 8-bit array.
// You can do binary split to UTF16 (BE or LE)
// you can do utf8, you can split the thing by hand and prepend BOM to it,
// but whatever you do, make sure you mirror the opposite on
// the server. If server does not expect to post-process un-base64
// 8-bit binary stream, think very very hard about messing around with encoding.
// so, long story short:
// DO NOT ADD UTF8 ENCODING CODE HERE!!!!
/* @preserve
====================================================================
base64 encoder
MIT, GPL
version: 1109.2015
discuss at: http://phpjs.org/functions/base64_encode
+ original by: Tyler Akins (http://rumkin.com)
+ improved by: Bayron Guevara
+ improved by: Thunder.m
+ improved by: Kevin van Zonneveld (http://kevin.vanzonneveld.net)
+ bugfixed by: Pellentesque Malesuada
+ improved by: Kevin van Zonneveld (http://kevin.vanzonneveld.net)
+ improved by: Rafal Kukawski (http://kukawski.pl)
+ Daniel Dotsenko, Willow Systems Corp, willow-systems.com
====================================================================
*/
var b64 = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/="
, b64a = b64.split('')
, o1, o2, o3, h1, h2, h3, h4, bits, i = 0,
ac = 0,
enc = "",
tmp_arr = [];
do { // pack three octets into four hexets
o1 = data.charCodeAt(i++);
o2 = data.charCodeAt(i++);
o3 = data.charCodeAt(i++);
bits = o1 << 16 | o2 << 8 | o3;
h1 = bits >> 18 & 0x3f;
h2 = bits >> 12 & 0x3f;
h3 = bits >> 6 & 0x3f;
h4 = bits & 0x3f;
// use hexets to index into b64, and append result to encoded string
tmp_arr[ac++] = b64a[h1] + b64a[h2] + b64a[h3] + b64a[h4];
} while (i < data.length);
enc = tmp_arr.join('');
var r = data.length % 3;
return (r ? enc.slice(0, r - 3) : enc) + '==='.slice(r || 3);
// end of base64 encoder MIT, GPL
}
}
var getObjectLength = typeof Object.keys === 'function' ?
function(object){
return Object.keys(object).length
} :
function(object){
var i = 0
for (var e in object){if(object.hasOwnProperty(e)){ i++ }}
return i
}
/**
PubSub implementation
@class
@name PubSub
*/
var PubSub = function(context){
'use strict'
/** @preserve
-----------------------------------------------------------------------------------------------
JavaScript PubSub library
2012 (c) ddotsenko@willowsystems.com
based on Peter Higgins (dante@dojotoolkit.org)
Loosely based on Dojo publish/subscribe API, limited in scope. Rewritten blindly.
Original is (c) Dojo Foundation 2004-2010. Released under either AFL or new BSD, see:
http://dojofoundation.org/license for more information.
-----------------------------------------------------------------------------------------------
*/
/**
@private
@fieldOf PubSub
*/
this.topics = {}
/**
Stores what will be `this` within the callback functions.
@private
@fieldOf PubSub#
*/
this.context = context
/**
Allows caller to emit an event and pass arguments to event listeners.
@public
@function
@param topic {String} Name of the channel on which to voice this event
@param **args Any number of arguments you want to pass to the listeners of this event.
@methodOf PubSub#
@name publish
*/
this.publish = function(topic, args) {
'use strict'
if (this.topics[topic]) {
var currentTopic = this.topics[topic]
, args = Array.prototype.slice.call(arguments, 1)
, toremove = []
, fn
, i, l
, pair
for (i = 0, l = currentTopic.length; i < l; i++) {
pair = currentTopic[i] // this is a [function, once_flag] array
fn = pair[0]
if (pair[1] /* 'run once' flag set */){
pair[0] = function(){}
toremove.push(i)
}
fn.apply(this.context, args)
}
for (i = 0, l = toremove.length; i < l; i++) {
currentTopic.splice(toremove[i], 1)
}
}
}
/**
Allows listener code to subscribe to channel and be called when data is available
@public
@function
@param topic {String} Name of the channel on which to voice this event
@param callback {Function} Executable (function pointer) that will be ran when event is voiced on this channel.
@param once {Boolean} (optional. False by default) Flag indicating if the function is to be triggered only once.
@returns {Object} A token object that cen be used for unsubscribing.
@methodOf PubSub#
@name subscribe
*/
this.subscribe = function(topic, callback, once) {
'use strict'
if (!this.topics[topic]) {
this.topics[topic] = [[callback, once]];
} else {
this.topics[topic].push([callback,once]);
}
return {
"topic": topic,
"callback": callback
};
};
/**
Allows listener code to unsubscribe from a channel
@public
@function
@param token {Object} A token object that was returned by `subscribe` method
@methodOf PubSub#
@name unsubscribe
*/
this.unsubscribe = function(token) {
if (this.topics[token.topic]) {
var currentTopic = this.topics[token.topic]
for (var i = 0, l = currentTopic.length; i < l; i++) {
if (currentTopic[i][0] === token.callback) {
currentTopic.splice(i, 1)
}
}
}
}
}
/**
@constructor
@private
*/
function jsPDF(/** String */ orientation, /** String */ unit, /** String */ format){
// Default parameter values
if (typeof orientation === 'undefined') orientation = 'p'
else orientation = orientation.toString().toLowerCase()
if (typeof unit === 'undefined') unit = 'mm'
if (typeof format === 'undefined') format = 'a4'
var format_as_string = format.toString().toLowerCase()
, version = '20120619'
, content = []
, content_length = 0
, pdfVersion = '1.3' // PDF Version
, pageFormats = { // Size in pt of various paper formats
'a3': [841.89, 1190.55]
, 'a4': [595.28, 841.89]
, 'a5': [420.94, 595.28]
, 'letter': [612, 792]
, 'legal': [612, 1008]
}
, textColor = '0 g'
, drawColor = '0 G'
, page = 0
, pages = []
, objectNumber = 2 // 'n' Current object number
, outToPages = false // switches where out() prints. outToPages true = push to pages obj. outToPages false = doc builder content
, offsets = [] // List of offsets. Activated and reset by buildDocument(). Pupulated by various calls buildDocument makes.
, fonts = {} // collection of font objects, where key is fontKey - a dynamically created label for a given font.
, fontmap = {} // mapping structure fontName > fontStyle > font key - performance layer. See addFont()
, activeFontSize = 16
, activeFontKey // will be string representing the KEY of the font as combination of fontName + fontStyle
, lineWidth = 0.200025 // 2mm
, pageHeight
, pageWidth
, k // Scale factor
, documentProperties = {'title':'','subject':'','author':'','keywords':'','creator':''}
, lineCapID = 0
, lineJoinID = 0
, API = {}
, events = new PubSub(API)
if (unit == 'pt') {
k = 1
} else if(unit == 'mm') {
k = 72/25.4
} else if(unit == 'cm') {
k = 72/2.54
} else if(unit == 'in') {
k = 72
} else {
throw('Invalid unit: ' + unit)
}
// Dimensions are stored as user units and converted to points on output
if (format_as_string in pageFormats) {
pageHeight = pageFormats[format_as_string][1] / k
pageWidth = pageFormats[format_as_string][0] / k
} else {
try {
pageHeight = format[1]
pageWidth = format[0]
}
catch(err) {
throw('Invalid format: ' + format)
}
}
if (orientation === 'p' || orientation === 'portrait') {
orientation = 'p'
if ( pageWidth > pageHeight ) {
var tmp = pageWidth
pageWidth = pageHeight
pageHeight = tmp
}
} else if (orientation === 'l' || orientation === 'landscape') {
orientation = 'l'
if ( pageHeight > pageWidth ) {
var tmp = pageWidth
pageWidth = pageHeight
pageHeight = tmp
}
} else {
throw('Invalid orientation: ' + orientation)
}
/////////////////////
// Private functions
/////////////////////
// simplified (speedier) replacement for sprintf's %.2f conversion
var f2 = function(number){
return number.toFixed(2)
}
// simplified (speedier) replacement for sprintf's %.3f conversion
, f3 = function(number){
return number.toFixed(3)
}
// simplified (speedier) replacement for sprintf's %02d
, padd2 = function(number) {
var n = (number).toFixed(0)
if ( number < 10 ) return '0' + n
else return n
}
// simplified (speedier) replacement for sprintf's %02d
, padd10 = function(number) {
var n = (number).toFixed(0)
if (n.length < 10) return new Array( 11 - n.length ).join( '0' ) + n
else return n
}
, out = function(string) {
if(outToPages /* set by beginPage */) {
pages[page].push(string)
} else {
content.push(string)
content_length += string.length + 1 // +1 is for '\n' that will be used to join contents of content
}
}
, newObject = function() {
// Begin a new object
objectNumber ++
offsets[objectNumber] = content_length
out(objectNumber + ' 0 obj');
return objectNumber
}
, putPages = function() {
var wPt = pageWidth * k
var hPt = pageHeight * k
// outToPages = false as set in endDocument(). out() writes to content.
var n, p
for(n=1; n <= page; n++) {
newObject()
out('<</Type /Page')
out('/Parent 1 0 R');
out('/Resources 2 0 R')
out('/Contents ' + (objectNumber + 1) + ' 0 R>>')
out('endobj')
// Page content
p = pages[n].join('\n')
newObject()
out('<</Length ' + p.length + '>>')
putStream(p)
out('endobj')
}
offsets[1] = content_length
out('1 0 obj')
out('<</Type /Pages')
var kids = '/Kids ['
for (var i = 0; i < page; i++) {
kids += (3 + 2 * i) + ' 0 R '
}
out(kids + ']')
out('/Count ' + page)
out('/MediaBox [0 0 '+f2(wPt)+' '+f2(hPt)+']')
out('>>')
out('endobj');
}
, putStream = function(str) {
out('stream')
out(str)
out('endstream')
}
, putResources = function() {
putFonts()
events.publish('putResources')
// Resource dictionary
offsets[2] = content_length
out('2 0 obj')
out('<<')
putResourceDictionary()
out('>>')
out('endobj')
}
, putFonts = function() {
for (var fontKey in fonts) {
if (fonts.hasOwnProperty(fontKey)) {
putFont(fonts[fontKey])
}
}
}
, putFont = function(font) {
font.objectNumber = newObject()
out('<</BaseFont/' + font.PostScriptName + '/Type/Font')
if (typeof font.encoding === 'string') {
out('/Encoding/'+font.encoding)
}
out('/Subtype/Type1>>')
out('endobj')
}
, addToFontDictionary = function(fontKey, fontName, fontStyle) {
// this is mapping structure for quick font key lookup.
// returns the KEY of the font (ex: "F1") for a given pair of font name and type (ex: "Arial". "Italic")
var undef
if (fontmap[fontName] === undef){
fontmap[fontName] = {} // fontStyle is a var interpreted and converted to appropriate string. don't wrap in quotes.
}
fontmap[fontName][fontStyle] = fontKey
}
/**
FontObject describes a particular font as member of an instnace of jsPDF
It's a collection of properties like 'id' (to be used in PDF stream),
'fontName' (font's family name), 'fontStyle' (font's style variant label)
@class
@public
@property id {String} PDF-document-instance-specific label assinged to the font.
@property PostScriptName {String} PDF specification full name for the font
@property encoding {Object} Encoding_name-to-Font_metrics_object mapping.
@name FontObject
*/
, FontObject = {}
, addFont = function(PostScriptName, fontName, fontStyle, encoding) {
var fontKey = 'F' + (getObjectLength(fonts) + 1).toString(10)
// This is FontObject
var font = fonts[fontKey] = {
'id': fontKey
// , 'objectNumber': will be set by putFont()
, 'PostScriptName': PostScriptName
, 'fontName': fontName
, 'fontStyle': fontStyle
, 'encoding': encoding
, 'metadata': {}
}
addToFontDictionary(fontKey, fontName, fontStyle)
events.publish('addFont', font)
return fontKey
}
, addFonts = function() {
var HELVETICA = "helvetica"
, TIMES = "times"
, COURIER = "courier"
, NORMAL = "normal"
, BOLD = "bold"
, ITALIC = "italic"
, BOLD_ITALIC = "bolditalic"
, encoding = 'StandardEncoding'
, standardFonts = [
['Helvetica', HELVETICA, NORMAL]
, ['Helvetica-Bold', HELVETICA, BOLD]
, ['Helvetica-Oblique', HELVETICA, ITALIC]
, ['Helvetica-BoldOblique', HELVETICA, BOLD_ITALIC]
, ['Courier', COURIER, NORMAL]
, ['Courier-Bold', COURIER, BOLD]
, ['Courier-Oblique', COURIER, ITALIC]
, ['Courier-BoldOblique', COURIER, BOLD_ITALIC]
, ['Times-Roman', TIMES, NORMAL]
, ['Times-Bold', TIMES, BOLD]
, ['Times-Italic', TIMES, ITALIC]
, ['Times-BoldItalic', TIMES, BOLD_ITALIC]
]
var i, l, fontKey, parts
for (i = 0, l = standardFonts.length; i < l; i++) {
fontKey = addFont(
standardFonts[i][0]
, standardFonts[i][1]
, standardFonts[i][2]
, encoding
)
// adding aliases for standard fonts, this time matching the capitalization
parts = standardFonts[i][0].split('-')
addToFontDictionary(fontKey, parts[0], parts[1] || '')
}
events.publish('addFonts', {'fonts':fonts, 'dictionary':fontmap})
}
, putResourceDictionary = function() {
out('/ProcSet [/PDF /Text /ImageB /ImageC /ImageI]')
out('/Font <<')
// Do this for each font, the '1' bit is the index of the font
for (var fontKey in fonts) {
if (fonts.hasOwnProperty(fontKey)) {
out('/' + fontKey + ' ' + fonts[fontKey].objectNumber + ' 0 R')
}
}
out('>>')
out('/XObject <<')
putXobjectDict()
out('>>')
}
, putXobjectDict = function() {
// Loop through images, or other data objects
events.publish('putXobjectDict')
}
, putInfo = function() {
out('/Producer (jsPDF ' + version + ')')
if(documentProperties.title) {
out('/Title (' + pdfEscape(documentProperties.title) + ')')
}
if(documentProperties.subject) {
out('/Subject (' + pdfEscape(documentProperties.subject) + ')')
}
if(documentProperties.author) {
out('/Author (' + pdfEscape(documentProperties.author) + ')')
}
if(documentProperties.keywords) {
out('/Keywords (' + pdfEscape(documentProperties.keywords) + ')')
}
if(documentProperties.creator) {
out('/Creator (' + pdfEscape(documentProperties.creator) + ')')
}
var created = new Date()
out('/CreationDate (D:' +
[
created.getFullYear()
, padd2(created.getMonth() + 1)
, padd2(created.getDate())
, padd2(created.getHours())
, padd2(created.getMinutes())
, padd2(created.getSeconds())
].join('')+
')'
)
}
, putCatalog = function () {
out('/Type /Catalog')
out('/Pages 1 0 R')
// @TODO: Add zoom and layout modes
out('/OpenAction [3 0 R /FitH null]')
out('/PageLayout /OneColumn')
}
, putTrailer = function () {
out('/Size ' + (objectNumber + 1))
out('/Root ' + objectNumber + ' 0 R')
out('/Info ' + (objectNumber - 1) + ' 0 R')
}
, beginPage = function() {
page ++
// Do dimension stuff
outToPages = true
pages[page] = []
}
, _addPage = function() {
beginPage()
// Set line width
out(f2(lineWidth * k) + ' w')
// Set draw color
out(drawColor)
// resurrecting non-default line caps, joins
if (lineCapID !== 0) out(lineCapID.toString(10)+' J')
if (lineJoinID !== 0) out(lineJoinID.toString(10)+' j')
events.publish('addPage', {'pageNumber':page})
}
/**
Returns a document-specific font key - a label assigned to a
font name + font type combination at the time the font was added
to the font inventory.
Font key is used as label for the desired font for a block of text
to be added to the PDF document stream.
@private
@function
@param fontName {String} can be undefined on "falthy" to indicate "use current"
@param fontStyle {String} can be undefined on "falthy" to indicate "use current"
@returns {String} Font key.
*/
, getFont = function(fontName, fontStyle) {
var key, undef
if (fontName === undef) {
fontName = fonts[activeFontKey]['fontName']
}
if (fontStyle === undef) {
fontStyle = fonts[activeFontKey]['fontStyle']
}
try {
key = fontmap[fontName][fontStyle] // returns a string like 'F3' - the KEY corresponding tot he font + type combination.
} catch (e) {
key = undef
}
if (!key){
throw new Error("Unable to look up font label for font '"+fontName+"', '"+fontStyle+"'. Refer to getFontList() for available fonts.")
}
return key
}
, buildDocument = function() {
outToPages = false // switches out() to content
content = []
offsets = []
// putHeader()
out('%PDF-' + pdfVersion)
putPages()
putResources()
// Info
newObject()
out('<<')
putInfo()
out('>>')
out('endobj')
// Catalog
newObject()
out('<<')
putCatalog()
out('>>')
out('endobj')
// Cross-ref
var o = content_length
out('xref')
out('0 ' + (objectNumber + 1))
out('0000000000 65535 f ')
for (var i=1; i <= objectNumber; i++) {
out(padd10(offsets[i]) + ' 00000 n ')
}
// Trailer
out('trailer')
out('<<')
putTrailer()
out('>>')
out('startxref')
out(o)
out('%%EOF')
outToPages = true
return content.join('\n')
}
/**
@public
@function
@param text {String}
@param flags {Object} Encoding flags.
@returns {String} Encoded string
*/
, to8bitStream = function(text, flags){
/* PDF 1.3 spec:
"For text strings encoded in Unicode, the first two bytes must be 254 followed by
255, representing the Unicode byte order marker, U+FEFF. (This sequence conflicts
with the PDFDocEncoding character sequence thorn ydieresis, which is unlikely
to be a meaningful beginning of a word or phrase.) The remainder of the
string consists of Unicode character codes, according to the UTF-16 encoding
specified in the Unicode standard, version 2.0. Commonly used Unicode values
are represented as 2 bytes per character, with the high-order byte appearing first
in the string."
In other words, if there are chars in a string with char code above 255, we
recode the string to UCS2 BE - string doubles in length and BOM is prepended.
HOWEVER!
Actual *content* (body) text (as opposed to strings used in document properties etc)
does NOT expect BOM. There, it is treated as a literal GID (Glyph ID)
Because of Adobe's focus on "you subset your fonts!" you are not supposed to have
a font that maps directly Unicode (UCS2 / UTF16BE) code to font GID, but you could
fudge it with "Identity-H" encoding and custom CIDtoGID map that mimics Unicode
code page. There, however, all characters in the stream are treated as GIDs,
including BOM, which is the reason we need to skip BOM in content text (i.e. that
that is tied to a font).
To signal this "special" PDFEscape / to8bitStream handling mode,
API.text() function sets (unless you overwrite it with manual values
given to API.text(.., flags) )
flags.autoencode = true
flags.noBOM = true
*/
/*
`flags` properties relied upon:
.sourceEncoding = string with encoding label.
"Unicode" by default. = encoding of the incoming text.
pass some non-existing encoding name
(ex: 'Do not touch my strings! I know what I am doing.')
to make encoding code skip the encoding step.
.outputEncoding = Either valid PDF encoding name
(must be supported by jsPDF font metrics, otherwise no encoding)
or a JS object, where key = sourceCharCode, value = outputCharCode
missing keys will be treated as: sourceCharCode === outputCharCode
.noBOM
See comment higher above for explanation for why this is important
.autoencode
See comment higher above for explanation for why this is important
*/
var i, l, undef
if (flags === undef) {
flags = {}
}
var sourceEncoding = flags.sourceEncoding ? sourceEncoding : 'Unicode'
, encodingBlock
, outputEncoding = flags.outputEncoding
, newtext
, isUnicode, ch, bch
// This 'encoding' section relies on font metrics format
// attached to font objects by, among others,
// "Willow Systems' standard_font_metrics plugin"
// see jspdf.plugin.standard_font_metrics.js for format
// of the font.metadata.encoding Object.
// It should be something like
// .encoding = {'codePages':['WinANSI....'], 'WinANSI...':{code:code, ...}}
// .widths = {0:width, code:width, ..., 'fof':divisor}
// .kerning = {code:{previous_char_code:shift, ..., 'fof':-divisor},...}
if ((flags.autoencode || outputEncoding ) &&
fonts[activeFontKey].metadata &&
fonts[activeFontKey].metadata[sourceEncoding] &&
fonts[activeFontKey].metadata[sourceEncoding].encoding
) {
encodingBlock = fonts[activeFontKey].metadata[sourceEncoding].encoding
// each font has default encoding. Some have it clearly defined.
if (!outputEncoding && fonts[activeFontKey].encoding) {
outputEncoding = fonts[activeFontKey].encoding
}
// Hmmm, the above did not work? Let's try again, in different place.
if (!outputEncoding && encodingBlock.codePages) {
outputEncoding = encodingBlock.codePages[0] // let's say, first one is the default
}
if (typeof outputEncoding === 'string') {
outputEncoding = encodingBlock[outputEncoding]
}
// we want output encoding to be a JS Object, where
// key = sourceEncoding's character code and
// value = outputEncoding's character code.
if (outputEncoding) {
isUnicode = false
newtext = []
for (i = 0, l = text.length; i < l; i++) {
ch = outputEncoding[text.charCodeAt(i)]
if (ch) {
newtext.push(
String.fromCharCode(ch)
)
} else {
newtext.push(
text[i]
)
}
// since we are looping over chars anyway, might as well
// check for residual unicodeness
if (newtext[i].charCodeAt(0) >> 8 /* more than 255 */ ) {
isUnicode = true
}
}
text = newtext.join('')
}
}
i = text.length
// isUnicode may be set to false above. Hence the triple-equal to undefined
while (isUnicode === undef && i !== 0){
if ( text.charCodeAt(i - 1) >> 8 /* more than 255 */ ) {
isUnicode = true
}
;i--;
}
if (!isUnicode) {
return text
} else {
newtext = flags.noBOM ? [] : [254, 255]
for (i = 0, l = text.length; i < l; i++) {
ch = text.charCodeAt(i)
bch = ch >> 8 // divide by 256
if (bch >> 8 /* something left after dividing by 256 second time */ ) {
throw new Error("Character at position "+i.toString(10)+" of string '"+text+"' exceeds 16bits. Cannot be encoded into UCS-2 BE")
}
newtext.push(bch)
newtext.push(ch - ( bch << 8))
}
return String.fromCharCode.apply(undef, newtext)
}
}
// Replace '/', '(', and ')' with pdf-safe versions
, pdfEscape = function(text, flags) {
// doing to8bitStream does NOT make this PDF display unicode text. For that
// we also need to reference a unicode font and embed it - royal pain in the rear.
// There is still a benefit to to8bitStream - PDF simply cannot handle 16bit chars,
// which JavaScript Strings are happy to provide. So, while we still cannot display
// 2-byte characters property, at least CONDITIONALLY converting (entire string containing)
// 16bit chars to (USC-2-BE) 2-bytes per char + BOM streams we ensure that entire PDF
// is still parseable.
// This will allow immediate support for unicode in document properties strings.
return to8bitStream(text, flags).replace(/\\/g, '\\\\').replace(/\(/g, '\\(').replace(/\)/g, '\\)')
}
, getStyle = function(style){
// see Path-Painting Operators of PDF spec
var op = 'S'; // stroke
if (style === 'F') {
op = 'f'; // fill
} else if (style === 'FD' || style === 'DF') {
op = 'B'; // both
}
return op;
}
//---------------------------------------
// Public API
/*
Object exposing internal API to plugins
@public
*/
API.internal = {
'pdfEscape': pdfEscape
, 'getStyle': getStyle
/**
Returns {FontObject} describing a particular font.
@public
@function
@param fontName {String} (Optional) Font's family name
@param fontStyle {String} (Optional) Font's style variation name (Example:"Italic")
@returns {FontObject}
*/
, 'getFont': function(){ return fonts[getFont.apply(API, arguments)] }
, 'getFontSize': function() { return activeFontSize }
, 'btoa': btoa
, 'write': function(string1, string2, string3, etc){
out(
arguments.length === 1?
arguments[0] :
Array.prototype.join.call(arguments, ' ')
)
}
, 'getCoordinateString': function(value){
return f2(value * k)
}
, 'getVerticalCoordinateString': function(value){
return f2((pageHeight - value) * k)
}
, 'collections': {}
, 'newObject': newObject
, 'putStream': putStream
, 'events': events
// ratio that you use in multiplication of a given "size" number to arrive to 'point'
// units of measurement.
// scaleFactor is set at initialization of the document and calculated against the stated
// default measurement units for the document.
// If default is "mm", k is the number that will turn number in 'mm' into 'points' number.
// through multiplication.
, 'scaleFactor': k
, 'pageSize': {'width':pageWidth, 'height':pageHeight}
}
/**
Adds (and transfers the focus to) new page to the PDF document.
@function
@returns {jsPDF}
@methodOf jsPDF#
@name addPage
*/
API.addPage = function() {
_addPage()
return this
}
/**
Adds text to page. Supports adding multiline text when 'text' argument is an Array of Strings.
@function
@param {String|Array} text 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.
@param {Number} x Coordinate (in units declared at inception of PDF document) against left edge of the page
@param {Number} y Coordinate (in units declared at inception of PDF document) against upper edge of the page
@param {Object} flags 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.
@returns {jsPDF}
@methodOf jsPDF#
@name text
*/
API.text = function(text, x, y, flags) {
/**
* Inserts something like this into PDF
BT
/F1 16 Tf % Font name + size
16 TL % How many units down for next line in multiline text
0 g % color
28.35 813.54 Td % position
(line one) Tj
T* (line two) Tj
T* (line three) Tj
ET
*/
var undef
// Pre-August-2012 the order of arguments was function(x, y, text, flags)
// in effort to make all calls have similar signature like
// function(data, coordinates... , miscellaneous)
// this method had its args flipped.
// code below allows backward compatibility with old arg order.
var _first, _second, _third
if (typeof arguments[0] === 'number') {
_first = arguments[2]
_second = arguments[0]
_third = arguments[1]
text = _first
x = _second
y = _third
}
// If there are any newlines in text, we assume
// the user wanted to print multiple lines, so break the
// text up into an array. If the text is already an array,
// we assume the user knows what they are doing.
if (typeof text === 'string' && text.match(/[\n\r]/)) {
text = text.split(/\r\n|\r|\n/g)
}
if (typeof flags === 'undefined') {
flags = {'noBOM':true,'autoencode':true}
} else {
if (flags.noBOM === undef) {
flags.noBOM = true
}
if (flags.autoencode === undef) {
flags.autoencode = true
}
}
var newtext, str
if (typeof text === 'string') {
str = pdfEscape(text, flags)
} else if (text instanceof Array) /* Array */{
// we don't want to destroy original text array, so cloning it
newtext = text.concat()
// we do array.join('text that must not be PDFescaped")
// thus, pdfEscape each component separately
for ( var i = newtext.length - 1; i !== -1 ; i--) {
newtext[i] = pdfEscape( newtext[i], flags)
}
str = newtext.join( ") Tj\nT* (" )
} else {