forked from parallax/jsPDF
-
Notifications
You must be signed in to change notification settings - Fork 0
/
viewerpreferences.js
229 lines (212 loc) · 10.5 KB
/
viewerpreferences.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
/**
* jsPDF viewerPreferences Plugin
* @author Aras Abbasi (github.com/arasabbasi)
* Licensed under the MIT License.
* http://opensource.org/licenses/mit-license
*/
/**
* Adds the ability to set ViewerPreferences and by thus
* controlling the way the document is to be presented on the
* screen or in print.
*/
(function (jsPDFAPI) {
"use strict";
/**
* Set the ViewerPreferences of the generated PDF
*
* @param {Object} options Array with the ViewerPreferences<br />
* Example: doc.viewerPreferences({"FitWindow":true});<br />
* <br />
* You can set following preferences:<br />
* <br/>
* <b>HideToolbar</b> <i>(boolean)</i><br />
* Default value: false<br />
* <br />
* <b>HideMenubar</b> <i>(boolean)</i><br />
* Default value: false.<br />
* <br />
* <b>HideWindowUI</b> <i>(boolean)</i><br />
* Default value: false.<br />
* <br />
* <b>FitWindow</b> <i>(boolean)</i><br />
* Default value: false.<br />
* <br />
* <b>CenterWindow</b> <i>(boolean)</i><br />
* Default value: false<br />
* <br />
* <b>DisplayDocTitle</b> <i>(boolean)</i><br />
* Default value: false.<br />
* <br />
* <b>NonFullScreenPageMode</b> <i>(String)</i><br />
* Possible values: UseNone, UseOutlines, UseThumbs, UseOC<br />
* Default value: UseNone<br/>
* <br />
* <b>Direction</b> <i>(String)</i><br />
* Possible values: L2R, R2L<br />
* Default value: L2R.<br />
* <br />
* <b>ViewArea</b> <i>(String)</i><br />
* Possible values: MediaBox, CropBox, TrimBox, BleedBox, ArtBox<br />
* Default value: CropBox.<br />
* <br />
* <b>ViewClip</b> <i>(String)</i><br />
* Possible values: MediaBox, CropBox, TrimBox, BleedBox, ArtBox<br />
* Default value: CropBox<br />
* <br />
* <b>PrintArea</b> <i>(String)</i><br />
* Possible values: MediaBox, CropBox, TrimBox, BleedBox, ArtBox<br />
* Default value: CropBox<br />
* <br />
* <b>PrintClip</b> <i>(String)</i><br />
* Possible values: MediaBox, CropBox, TrimBox, BleedBox, ArtBox<br />
* Default value: CropBox.<br />
* <br />
* <b>PrintScaling</b> <i>(String)</i><br />
* Possible values: AppDefault, None<br />
* Default value: AppDefault.<br />
* <br />
* <b>Duplex</b> <i>(String)</i><br />
* Possible values: Simplex, DuplexFlipLongEdge, DuplexFlipShortEdge
* Default value: none<br />
* <br />
* <b>PickTrayByPDFSize</b> <i>(boolean)</i><br />
* Default value: false<br />
* <br />
* <b>PrintPageRange</b> <i>(Array)</i><br />
* Example: [[1,5], [7,9]]<br />
* Default value: as defined by PDF viewer application<br />
* <br />
* <b>NumCopies</b> <i>(Number)</i><br />
* Possible values: 1, 2, 3, 4, 5<br />
* Default value: 1<br />
* <br />
* For more information see the PDF Reference, sixth edition on Page 577
* @param {boolean} doReset True to reset the settings
* @function
* @returns jsPDF
* @methodOf jsPDF#
* @example
* var doc = new jsPDF()
* doc.text('This is a test', 10, 10)
* doc.viewerPreferences({'FitWindow': true}, true)
* doc.save("viewerPreferences.pdf")
*
* // Example printing 10 copies, using cropbox, and hiding UI.
* doc.viewerPreferences({
* 'HideWindowUI': true,
* 'PrintArea': 'CropBox',
* 'NumCopies': 10
* })
* @name viewerPreferences
*/
jsPDFAPI.viewerPreferences = function (options, doReset) {
options = options || {};
doReset = doReset || false;
var configuration;
var configurationTemplate = {
"HideToolbar": {defaultValue: false, value: false, type: "boolean", explicitSet: false, valueSet: [true, false], pdfVersion: 1.3},
"HideMenubar": {defaultValue: false, value: false, type: "boolean", explicitSet: false, valueSet: [true, false], pdfVersion: 1.3},
"HideWindowUI": {defaultValue: false, value: false, type: "boolean", explicitSet: false, valueSet: [true, false], pdfVersion: 1.3},
"FitWindow": {defaultValue: false, value: false, type: "boolean", explicitSet: false, valueSet: [true, false], pdfVersion: 1.3},
"CenterWindow": {defaultValue: false, value: false, type: "boolean", explicitSet: false, valueSet: [true, false], pdfVersion: 1.3},
"DisplayDocTitle": {defaultValue: false, value: false, type: "boolean", explicitSet: false, valueSet: [true, false], pdfVersion: 1.4},
"NonFullScreenPageMode": {defaultValue: "UseNone", value: "UseNone", type: "name", explicitSet: false, valueSet: ["UseNone", "UseOutlines", "UseThumbs", "UseOC"], pdfVersion: 1.3},
"Direction": {defaultValue: "L2R", value: "L2R", type: "name", explicitSet: false, valueSet: ["L2R", "R2L"], pdfVersion: 1.3},
"ViewArea": {defaultValue: "CropBox", value: "CropBox", type: "name", explicitSet: false, valueSet: ["MediaBox", "CropBox", "TrimBox", "BleedBox", "ArtBox"], pdfVersion: 1.4},
"ViewClip": {defaultValue: "CropBox", value: "CropBox", type: "name", explicitSet: false, valueSet: ["MediaBox", "CropBox", "TrimBox", "BleedBox", "ArtBox"], pdfVersion: 1.4},
"PrintArea": {defaultValue: "CropBox", value: "CropBox", type: "name", explicitSet: false, valueSet: ["MediaBox", "CropBox", "TrimBox", "BleedBox", "ArtBox"], pdfVersion: 1.4},
"PrintClip": {defaultValue: "CropBox", value: "CropBox", type: "name", explicitSet: false, valueSet: ["MediaBox", "CropBox", "TrimBox", "BleedBox", "ArtBox"], pdfVersion: 1.4},
"PrintScaling": {defaultValue: "AppDefault", value: "AppDefault", type: "name", explicitSet: false, valueSet: ["AppDefault", "None"], pdfVersion: 1.6},
"Duplex": {defaultValue: "", value: "none", type: "name", explicitSet: false, valueSet: ["Simplex", "DuplexFlipShortEdge", "DuplexFlipLongEdge", "none"], pdfVersion: 1.7},
"PickTrayByPDFSize": {defaultValue: false, value: false, type: "boolean", explicitSet: false, valueSet: [true, false], pdfVersion: 1.7},
"PrintPageRange": {defaultValue: "", value: "", type: "array", explicitSet: false, valueSet: null, pdfVersion: 1.7},
"NumCopies": {defaultValue: 1, value: 1, type: "integer", explicitSet: false, valueSet: null, pdfVersion: 1.7}
};
var configurationKeys = Object.keys(configurationTemplate);
var rangeArray = [];
var i = 0;
var j = 0;
var k = 0;
var isValid = true;
var method;
var value;
function arrayContainsElement(array, element) {
var iterator;
var result = false;
for (iterator = 0; iterator < array.length; iterator += 1) {
if (array[iterator] === element) {
result = true;
}
}
return result;
}
if (this.internal.viewerpreferences === undefined) {
this.internal.viewerpreferences = {};
this.internal.viewerpreferences.configuration = JSON.parse(JSON.stringify(configurationTemplate));
this.internal.viewerpreferences.isSubscribed = false;
}
configuration = this.internal.viewerpreferences.configuration;
if (options === "reset" || doReset === true) {
var len = configurationKeys.length;
for (k = 0; k < len; k += 1) {
configuration[configurationKeys[k]].value = configuration[configurationKeys[k]].defaultValue;
configuration[configurationKeys[k]].explicitSet = false;
}
}
if (typeof options === "object") {
for (method in options) {
value = options[method];
if (arrayContainsElement(configurationKeys, method) && value !== undefined) {
if (configuration[method].type === "boolean" && typeof value === "boolean") {
configuration[method].value = value;
} else if (configuration[method].type === "name" && arrayContainsElement(configuration[method].valueSet, value)) {
configuration[method].value = value;
} else if (configuration[method].type === "integer" && Number.isInteger(value)) {
configuration[method].value = value;
} else if (configuration[method].type === "array") {
for (i = 0; i < value.length; i += 1) {
isValid = true;
if (value[i].length === 1 && typeof value[i][0] === "number") {
rangeArray.push(String(value[i]));
} else if (value[i].length > 1) {
for (j = 0; j < value[i].length; j += 1) {
if (typeof value[i][j] !== "number") {
isValid = false;
}
}
if (isValid === true) {
rangeArray.push(String(value[i].join("-")));
}
}
}
configuration[method].value = String(rangeArray);
} else {
configuration[method].value = configuration[method].defaultValue;
}
configuration[method].explicitSet = true;
}
}
}
if (this.internal.viewerpreferences.isSubscribed === false) {
this.internal.events.subscribe("putCatalog", function () {
var pdfDict = [];
var vPref;
for (vPref in configuration) {
if (configuration[vPref].explicitSet === true) {
if (configuration[vPref].type === "name") {
pdfDict.push("/" + vPref + " /" + configuration[vPref].value);
} else {
pdfDict.push("/" + vPref + " " + configuration[vPref].value);
}
}
}
if (pdfDict.length !== 0) {
this.internal.write("/ViewerPreferences\n<<\n" + pdfDict.join("\n") + "\n>>");
}
});
this.internal.viewerpreferences.isSubscribed = true;
}
this.internal.viewerpreferences.configuration = configuration;
return this;
};
})(jsPDF.API);