jspdf-dynamo 1.0.0 → 1.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. package/dist/index.cjs +26 -23
  2. package/dist/index.d.cts +16 -5
  3. package/dist/index.d.ts +16 -5
  4. package/dist/index.js +26 -23
  5. package/documentation/1. Introduction/Introduction.txt +2 -2
  6. package/documentation/3. Variables/Introduction.txt +15 -12
  7. package/documentation/3. Variables/SystemMaintained.txt +44 -65
  8. package/documentation/4. Commands/AddBookmark.txt +3 -3
  9. package/documentation/4. Commands/AddImageFromFile.txt +3 -3
  10. package/documentation/4. Commands/AddImageFromUrl.txt +4 -7
  11. package/documentation/4. Commands/AddPage.txt +1 -1
  12. package/documentation/4. Commands/CheckPage.txt +2 -2
  13. package/documentation/4. Commands/Commands.txt +7 -0
  14. package/documentation/4. Commands/CopyVar.txt +1 -1
  15. package/documentation/4. Commands/Do.txt +2 -2
  16. package/documentation/4. Commands/DoRepeat.txt +2 -2
  17. package/documentation/4. Commands/DrawBox.txt +2 -2
  18. package/documentation/4. Commands/DrawDebugGrid.txt +2 -2
  19. package/documentation/4. Commands/DrawImage.txt +2 -2
  20. package/documentation/4. Commands/DrawLine.txt +2 -2
  21. package/documentation/4. Commands/DrawTextBox.txt +1 -1
  22. package/documentation/4. Commands/DrawTextWrapped.txt +40 -17
  23. package/documentation/4. Commands/ForEachPage.txt +3 -3
  24. package/documentation/4. Commands/GetEnvVar.txt +2 -2
  25. package/documentation/4. Commands/IfNotBlank.txt +3 -3
  26. package/documentation/4. Commands/IncVar.txt +7 -7
  27. package/documentation/4. Commands/Include.txt +16 -15
  28. package/documentation/4. Commands/IncludeUrl.txt +53 -0
  29. package/documentation/4. Commands/MultVar.txt +7 -7
  30. package/documentation/4. Commands/SavePdf.txt +6 -0
  31. package/documentation/4. Commands/SelectPage.txt +6 -0
  32. package/documentation/4. Commands/SetCurrentX.txt +4 -4
  33. package/documentation/4. Commands/SetCurrentY.txt +2 -2
  34. package/documentation/4. Commands/SetDocumentInfo.txt +3 -3
  35. package/documentation/4. Commands/SetFillColour.txt +8 -25
  36. package/documentation/4. Commands/SetFontName.txt +3 -1
  37. package/documentation/4. Commands/SetFontSize.txt +0 -16
  38. package/documentation/4. Commands/SetFontStyle.txt +28 -10
  39. package/documentation/4. Commands/SetLineColour.txt +9 -27
  40. package/documentation/4. Commands/SetLineWidth.txt +1 -1
  41. package/documentation/4. Commands/SetLogLevel.txt +6 -0
  42. package/documentation/4. Commands/SetMargin.txt +1 -1
  43. package/documentation/4. Commands/SetTextColour.txt +43 -0
  44. package/documentation/4. Commands/SetVar.txt +7 -7
  45. package/documentation/4. Commands/WriteLog.txt +56 -0
  46. package/documentation/Documentation.pdf +2093 -1853
  47. package/documentation/documentation.txt +19 -10
  48. package/examples/1.Simple/simple.pdf +2 -2
  49. package/package.json +10 -4
  50. package/documentation/4. Commands/SetPageOrientation.txt +0 -42
  51. package/documentation/6. Other/PossibleEnhancements.txt +0 -63
  52. package/documentation/6. Other/To Be Documented.txt +0 -50
@@ -4,55 +4,38 @@
4
4
 
5
5
  .SetVar CommandSubHeading Syntax
6
6
  .Do CommandSubHeading
7
- .SetVar CommandLine1 .SetFillColor Red Green Blue
7
+ .SetVar CommandLine1 .SetFillColor Colour
8
8
  .Do CommandLine2
9
9
 
10
10
  .SetVar CommandSubHeading Parameters
11
11
  .Do CommandSubHeading
12
- .SetVar CommandLine1 Red
13
- .SetVar CommandLine2 The amount of red in the colour, represented as a number in the range
14
- .Do CommandLine2
15
- .SetVar CommandLine2 of 0 to 255
16
- .Do CommandLine2
17
- .SetVar CommandLine1 Green
18
- .SetVar CommandLine2 The amount of green in the colour, represented as a number in the range
19
- .Do CommandLine2
20
- .SetVar CommandLine2 of 0 to 255
21
- .Do CommandLine2
22
- .SetVar CommandLine1 Blue
23
- .SetVar CommandLine2 The amount of blue in the colour, represented as a number in the range
24
- .Do CommandLine2
25
- .SetVar CommandLine2 of 0 to 255
12
+ .SetVar CommandLine1 Colour
13
+ .SetVar CommandLine2 Either a CSS named colour or a hexadecimal RGB colour.
26
14
  .Do CommandLine2
27
15
 
28
16
  .SetVar CommandSubHeading Other
29
17
  .Do CommandSubHeading
30
- .SetVar CommandLine1 Colours are specified in the RGB style using three numbers in the range of 0 to 255,
31
- .Do CommandLine
32
- .SetVar CommandLine1 representing the amount of red, green and blue in the final colour.
33
- .Do CommandLine
34
- .incCurrentY %halfLineGap%
35
18
  .SetVar CommandLine1 The variable _LastResult is set to '1' by this command.
36
19
  .Do CommandLine
37
20
 
38
21
  .SetVar CommandSubHeading Examples
39
22
  .Do CommandSubHeading
40
- .SetVar CommandLine1 Set the colour of subsequent filled boxes to be grey:
23
+ .SetVar CommandLine1 Set the colour of subsequent filled boxes to be a light blue:
41
24
  .Do CommandLine
42
25
  .incCurrentY %halfLineGap%
43
- .SetVar CommandLine1 .SetLineColour 200 200 200
26
+ .SetVar CommandLine1 .SetFillColour LightSkyBlue
44
27
  .Do CommandLine2
45
28
 
46
29
  .incCurrentY %_FontHeight%
47
- .SetVar CommandLine1 Set the colour of subsequent filled boxes to be green:
30
+ .SetVar CommandLine1 Set the colour of subsequent filled boxes to be lime green:
48
31
  .Do CommandLine
49
32
  .incCurrentY %halfLineGap%
50
- .SetVar CommandLine1 .SetLineColour 0 180 0
33
+ .SetVar CommandLine1 .SetFillColour #32cd32
51
34
  .Do CommandLine2
52
35
 
53
36
  .SetVar CommandSubHeading See Also
54
37
  .Do CommandSubHeading
55
- .SetVar CommandLine1 DrawBox, SetLineColour
38
+ .SetVar CommandLine1 DrawBox, SetLineColour, SetTextColour
56
39
  .Do CommandLine
57
40
 
58
41
  .incCurrentY %_FontHeight%
@@ -1,4 +1,6 @@
1
1
  .SetVar CommandName SetFontName
2
2
  .Do CommandHeading
3
3
  .SetVar CommandLine1 To be documented.
4
- .Do CommandLine
4
+ .Do CommandLine
5
+
6
+ .incCurrentY %_FontHeight%
@@ -3,20 +3,4 @@
3
3
  .SetVar CommandLine1 To be documented.
4
4
  .Do CommandLine
5
5
 
6
- .incCurrentY %_FontHeight%
7
- .SetVar CommandLine1 Set a variable named 'BoldText' and then use this variable to set the emphasis of subsequent
8
- .Do CommandLine
9
- .SetVar CommandLine1 text to be bold:
10
- .Do CommandLine
11
- .incCurrentY %halfLineGap%
12
- .SetVar CommandLine1 .SetVar BoldText 1
13
- .Do CommandLine2
14
- .SetVar CommandLine1 .SetFontStyle %%%%BoldText%%%%
15
- .Do CommandLine2
16
-
17
- .SetVar CommandSubHeading See Also
18
- .Do CommandSubHeading
19
- .SetVar CommandLine1 DrawTextBox, DrawText, SetFontType, SetFontSize, SetTextColour
20
- .Do CommandLine
21
-
22
6
  .incCurrentY %_FontHeight%
@@ -17,18 +17,22 @@
17
17
  .SetVar CommandLine2 The typographical emphasis to apply:
18
18
  .Do CommandLine2
19
19
  .incCurrentY %halfLineGap%
20
- .SetVar CommandLine2 Normal - Normal text (no typographical emphasis)
20
+ .SetVar CommandLine2 -
21
+ .SetVar CommandLine3 Normal - Normal text (no typographical emphasis)
21
22
  .Do CommandLine2
22
23
 
23
- .SetVar CommandLine2 Bold - Bold text
24
+ .SetVar CommandLine2 -
25
+ .SetVar CommandLine3 Bold - Bold text
24
26
  .SetFontStyle Bold
25
27
  .Do CommandLine2
26
28
 
27
- .SetVar CommandLine2 Italic - Italic text
29
+ .SetVar CommandLine2 -
30
+ .SetVar CommandLine3 Italic - Italic text
28
31
  .SetFontStyle Italic
29
32
  .Do CommandLine2
30
33
 
31
- .SetVar CommandLine2 BoldItalic - Bold and italic text
34
+ .SetVar CommandLine2 -
35
+ .SetVar CommandLine3 BoldItalic - Bold and italic text
32
36
  .SetFontStyle BoldItalic
33
37
  .Do CommandLine2
34
38
 
@@ -36,14 +40,11 @@
36
40
 
37
41
  .SetVar CommandSubHeading Other
38
42
  .Do CommandSubHeading
39
- .SetVar CommandLine1 The font style name is not case sensitive so can be either upper, lower
40
- .Do CommandLine
41
- .SetVar CommandLine1 or mixed case.
43
+ .SetVar CommandLine1 The font style name is not case sensitive so can be either upper, lower or mixed case.
42
44
  .Do CommandLine
43
45
  .incCurrentY %halfLineGap%
44
46
  .SetVar CommandLine1 If a valid font style is provided the variable _LastResult is set to '1' otherwise the current
45
- .Do CommandLine
46
- .SetVar CommandLine1 typographical emphasis is unchanged and _LastResult is set to '0'.
47
+ .SetVar CommandLine1 %CommandLine1% typographical emphasis is unchanged and _LastResult is set to '0'.
47
48
  .Do CommandLine
48
49
 
49
50
  .SetVar CommandSubHeading Examples
@@ -51,5 +52,22 @@
51
52
  .SetVar CommandLine1 Set the emphasis of subsequent text to be italic:
52
53
  .Do CommandLine
53
54
  .incCurrentY %halfLineGap%
54
- .SetVar CommandLine1 .SetFontStyle 2
55
+ .SetVar CommandLine1 .SetFontStyle italic
56
+ .Do CommandLine2
57
+
58
+ .incCurrentY %_FontHeight%
59
+ .SetVar CommandLine1 Set a variable named 'BoldText' and then use this variable to set the emphasis of subsequent
60
+ .SetVar CommandLine1 %CommandLine1% text to be bold:
61
+ .Do CommandLine
62
+ .incCurrentY %halfLineGap%
63
+ .SetVar CommandLine1 .SetVar BoldText bold
55
64
  .Do CommandLine2
65
+ .SetVar CommandLine1 .SetFontStyle %%%%BoldText%%%%
66
+ .Do CommandLine2
67
+
68
+ .SetVar CommandSubHeading See Also
69
+ .Do CommandSubHeading
70
+ .SetVar CommandLine1 DrawTextBox, DrawText, SetFontType, SetFontSize, SetTextColour
71
+ .Do CommandLine
72
+
73
+ .incCurrentY %_FontHeight%
@@ -1,58 +1,40 @@
1
1
  .SetVar CommandName SetLineColour
2
2
  .Do CommandHeading
3
- .DrawText 0 %_CurrentY Set the colour of subsequent lines drawn with the DrawBox and DrawLine commands.
3
+ .DrawText 0 %_CurrentY% Set the colour of subsequent lines drawn with the DrawBox and DrawLine commands.
4
4
 
5
5
  .SetVar CommandSubHeading Syntax
6
6
  .Do CommandSubHeading
7
- .SetVar CommandLine1 .SetLineColor Red Green Blue
7
+ .SetVar CommandLine1 .SetLineColor Colour
8
8
  .Do CommandLine2
9
9
 
10
10
  .SetVar CommandSubHeading Parameters
11
11
  .Do CommandSubHeading
12
- .SetVar CommandLine1 Red
13
- .SetVar CommandLine2 The amount of red in the colour, represented as a number in the range
14
- .Do CommandLine2
15
- .SetVar CommandLine2 of 0 to 255
16
- .Do CommandLine2
17
- .SetVar CommandLine1 Green
18
- .SetVar CommandLine2 The amount of green in the colour, represented as a number in the range
19
- .Do CommandLine2
20
- .SetVar CommandLine2 of 0 to 255
21
- .Do CommandLine2
22
- .SetVar CommandLine1 Blue
23
- .SetVar CommandLine2 The amount of blue in the colour, represented as a number in the range
24
- .Do CommandLine2
25
- .SetVar CommandLine2 of 0 to 255
26
- .Do CommandLine2
12
+ .SetVar CommandLine1 Colour
13
+ .SetVar CommandLine2 Either a CSS named colour or a hexadecimal RGB colour.
27
14
 
28
15
  .SetVar CommandSubHeading Other
29
16
  .Do CommandSubHeading
30
- .SetVar CommandLine1 Colours are specified in the RGB style using three numbers in the range of 0 to 255,
31
- .Do CommandLine
32
- .SetVar CommandLine1 representing the amount of red, green and blue in the final colour.
33
- .Do CommandLine
34
- .incCurrentY %halfLineGap%
35
17
  .SetVar CommandLine1 The variable _LastResult is set to '1' by this command.
36
18
  .Do CommandLine
37
19
 
38
20
  .SetVar CommandSubHeading Examples
39
21
  .Do CommandSubHeading
40
- .SetVar CommandLine1 Set the colour of subsequent lines to be black:
22
+ .SetVar CommandLine1 Set the colour of subsequent lines to be purple:
41
23
  .Do CommandLine
42
24
  .incCurrentY %halfLineGap%
43
- .SetVar CommandLine1 .SetLineColour 0 0 0
25
+ .SetVar CommandLine1 .SetLineColour purple
44
26
  .Do CommandLine2
45
27
 
46
28
  .incCurrentY %_FontHeight%
47
- .SetVar CommandLine1 Set the colour of subsequent lines to be blue:
29
+ .SetVar CommandLine1 Set the colour of subsequent lines to be bright pink:
48
30
  .Do CommandLine
49
31
  .incCurrentY %halfLineGap%
50
- .SetVar CommandLine1 .SetLineColour 0 0 200
32
+ .SetVar CommandLine1 .SetLineColour #ff69b4
51
33
  .Do CommandLine2
52
34
 
53
35
  .SetVar CommandSubHeading See Also
54
36
  .Do CommandSubHeading
55
- .SetVar CommandLine1 DrawBox, DrawLine, SetFillColour, SetLineWidth
37
+ .SetVar CommandLine1 DrawBox, DrawLine, SetFillColour, SetLineWidth, SetTextColour
56
38
  .Do CommandLine
57
39
 
58
40
  .incCurrentY %_FontHeight%
@@ -10,7 +10,7 @@
10
10
  .SetVar CommandSubHeading Parameters
11
11
  .Do CommandSubHeading
12
12
  .SetVar CommandLine1 Width
13
- .SetVar CommandLine2 The width of the line(s) to be drawn in millimeters, as a floating point number
13
+ .SetVar CommandLine2 The width of the line(s) to be drawn, as a floating point number
14
14
  .Do CommandLine2
15
15
 
16
16
  .SetVar CommandSubHeading Other
@@ -0,0 +1,6 @@
1
+ .SetVar CommandName SetLogLevel
2
+ .Do CommandHeading
3
+ .SetVar CommandLine1 To be documented.
4
+ .Do CommandLine
5
+
6
+ .incCurrentY %_FontHeight%
@@ -32,7 +32,7 @@
32
32
  .SetVar CommandLine2 V or Vertical - Both vertical margins, top and bottom
33
33
  .Do CommandLine2
34
34
  .SetVar CommandLine1 Size
35
- .SetVar CommandLine2 The size of the margin in millimeters.
35
+ .SetVar CommandLine2 The size of the margin.
36
36
  .Do CommandLine2
37
37
 
38
38
  .SetVar CommandSubHeading Other
@@ -0,0 +1,43 @@
1
+ .SetVar CommandName SetTextColour
2
+ .Do CommandHeading
3
+ .DrawText 0 %_CurrentY% Set the colour of subsequent text.
4
+
5
+ .SetVar CommandSubHeading Syntax
6
+ .Do CommandSubHeading
7
+ .SetVar CommandLine1 .SetTextColour Colour
8
+ .Do CommandLine2
9
+
10
+ .SetVar CommandSubHeading Parameters
11
+ .Do CommandSubHeading
12
+ .SetVar CommandLine1 Colour
13
+ .SetVar CommandLine2 Either a CSS named colour or a hexadecimal RGB colour.
14
+ .Do CommandLine2
15
+
16
+ .SetVar CommandSubHeading Other
17
+ .Do CommandSubHeading
18
+ .SetVar CommandLine1 The variable _LastResult is set to '1' by this command.
19
+ .Do CommandLine
20
+
21
+ .SetVar CommandSubHeading Examples
22
+ .Do CommandSubHeading
23
+ .SetVar CommandLine1 Set the colour of subsequent text to be brown:
24
+ .Do CommandLine
25
+ .incCurrentY %halfLineGap%
26
+ .SetVar CommandLine1 .SetTextColour Brown
27
+ .Do CommandLine2
28
+
29
+ .incCurrentY %_FontHeight%
30
+ .SetVar CommandLine1 Set the colour of subsequent text to be dark blue:
31
+ .Do CommandLine
32
+ .incCurrentY %halfLineGap%
33
+ .SetVar CommandLine1 .SetVar myColour #00008b
34
+ .Do CommandLine2
35
+ .SetVar CommandLine1 .SetTextColour %%%%myColour%%%%
36
+ .Do CommandLine2
37
+
38
+ .SetVar CommandSubHeading See Also
39
+ .Do CommandSubHeading
40
+ .SetVar CommandLine1 DrawBox, SetFillColour, SetLineColour
41
+ .Do CommandLine
42
+
43
+ .incCurrentY %_FontHeight%
@@ -4,7 +4,7 @@
4
4
 
5
5
  .SetVar CommandSubHeading Syntax
6
6
  .Do CommandSubHeading
7
- .SetVar CommandLine1 .SetVar Variable Value
7
+ .SetVar CommandLine1 .SetVar Variable Value
8
8
  .Do CommandLine2
9
9
 
10
10
  .SetVar CommandSubHeading Parameters
@@ -20,10 +20,10 @@
20
20
  .Do CommandSubHeading
21
21
  .SetVar CommandLine1 Variable _LastResult is set to '1' if a valid variable name is provided, otherwise it is set to '0'.
22
22
  .Do CommandLine
23
+ .incCurrentY %halfLineGap%
23
24
  .SetVar CommandLine1 The JsPdfDynamo maintained variables (those whose name starts with an underscore) can
25
+ .SetVar CommandLine1 %CommandLine1% not be changed using this command.
24
26
  .Do CommandLine
25
- .SetVar CommandLine1 not be changed using this command.
26
- .Do CommandLine
27
27
  .incCurrentY %halfLineGap%
28
28
  .SetVar CommandLine1 To set a variable to blank, omit the value parameter.
29
29
  .Do CommandLine
@@ -36,21 +36,21 @@
36
36
  .SetVar CommandLine1 Set the variable 'Heading' to 'A mighty Good Heading':
37
37
  .Do CommandLine
38
38
  .incCurrentY %halfLineGap%
39
- .SetVar CommandLine1 .SetVar Heading A mighty Good Heading
39
+ .SetVar CommandLine1 .SetVar Heading A mighty Good Heading
40
40
  .Do CommandLine2
41
41
  .incCurrentY %_FontHeight%
42
42
 
43
43
  .SetVar CommandLine1 Save the current vertical position on the page in the variable 'top':
44
44
  .Do CommandLine
45
45
  .incCurrentY %halfLineGap%
46
- .SetVar CommandLine1 .SetVar Top %%%%_CurrentY%%%%
46
+ .SetVar CommandLine1 .SetVar Top %%%%_CurrentY%%%%
47
47
  .Do CommandLine2
48
48
  .incCurrentY %_FontHeight%
49
49
 
50
50
  .SetVar CommandLine1 Set the variable 'Index' to '3':
51
51
  .Do CommandLine
52
52
  .incCurrentY %halfLineGap%
53
- .SetVar CommandLine1 .SetVar Index 3
53
+ .SetVar CommandLine1 .SetVar Index 3
54
54
  .Do CommandLine2
55
55
  .incCurrentY %_FontHeight%
56
56
 
@@ -59,7 +59,7 @@
59
59
  .SetVar CommandLine1 variable 'CurrentItem' has the value of '7':
60
60
  .Do CommandLine
61
61
  .incCurrentY %halfLineGap%
62
- .SetVar CommandLine1 .SetVar Item%%%%CurrentItem%%%% %%%%Description%%%%
62
+ .SetVar CommandLine1 .SetVar Item%%%%CurrentItem%%%% %%%%Description%%%%
63
63
  .Do CommandLine2
64
64
 
65
65
  .SetVar CommandSubHeading See Also
@@ -0,0 +1,56 @@
1
+ .SetVar CommandName WriteLog
2
+ .Do CommandHeading
3
+ .SetVar CommandLine1 Writes a message to the logger with the given severity level.
4
+ .Do CommandLine
5
+
6
+ .SetVar CommandSubHeading Syntax
7
+ .Do CommandSubHeading
8
+ .SetVar CommandLine1 .WriteLog severity message
9
+ .Do CommandLine2
10
+
11
+ .SetVar CommandSubHeading Parameters
12
+ .Do CommandSubHeading
13
+ .SetVar CommandLine1 severity
14
+ .SetVar CommandLine2 The severity of the message expressed as either a number (0-4) or as text
15
+ .SetVar CommandLine2 %CommandLine2% (trace, debug, info, warn, error).
16
+ .Do CommandLine2
17
+ .SetVar CommandLine1 message
18
+ .SetVar CommandLine2 The message to be written.
19
+ .Do CommandLine2
20
+
21
+ .SetVar CommandSubHeading Other
22
+ .Do CommandSubHeading
23
+ .SetVar CommandLine1 The variable _LastResult is not changed by this command.
24
+ .Do CommandLine
25
+ .incCurrentY %halfLineGap%
26
+ .SetVar CommandLine1 The output of the message is dependent on the minimum log level of the (optional) logger
27
+ .SetVar CommandLine1 %CommandLine1% passed into the JsPdfDynamo object on creation, and the current
28
+ .SetVar CommandLine1 %CommandLine1% minimum log level set by the SetLogLevel command.
29
+ .Do CommandLine
30
+ .incCurrentY %halfLineGap%
31
+ .SetVar CommandLine1 The initial minimum log level of the JsPdfDynamo class is 'info'.
32
+ .Do CommandLine
33
+
34
+ .SetVar CommandSubHeading Examples
35
+ .Do CommandSubHeading
36
+ .SetVar CommandLine1 Write an informational message:
37
+ .Do CommandLine
38
+ .incCurrentY %halfLineGap%
39
+ .SetVar CommandLine1 .WriteLog info Job completed!
40
+ .Do CommandLine2
41
+
42
+ .incCurrentY %_FontHeight%
43
+ .SetVar CommandLine1 Write a debug message showing the current value of the variable 'amount':
44
+ .Do CommandLine
45
+ .incCurrentY %halfLineGap%
46
+ .SetVar CommandLine1 .SetLogLevel debug
47
+ .Do CommandLine2
48
+ .SetVar CommandLine1 .WriteLog debug The current amount is %%%%amount%%%%
49
+ .Do CommandLine2
50
+
51
+ .SetVar CommandSubHeading See Also
52
+ .Do CommandSubHeading
53
+ .SetVar CommandLine1 SetLogLevel
54
+ .Do CommandLine
55
+
56
+ .incCurrentY %_FontHeight%