Added highlevel ability to provide lineCap style (#499)

* Added highlevel ability to provide dashArray, and dashPhase for page.drawLine * Added dashArray and dashPhase for the rest of the drawing functions: rectangle, square, ellipse, circle, svgpath * Updated tests to reflect dashpattern changes * Added highlevel ability to provide lineCapStyle to the following page.draw functions: line, square, rectangle, circle, ellipse * Applying requested changes * Updated tests to reflect changes * Applying requested changes: lineCap to borderLineCap Co-authored-by: Peter Varga <peter.varga@xyicon.com>
Hopding · Jun 26, 2020 · 435bddf · 435bddf
1 parent bc4b172
commit 435bddf
Show file tree

Hide file tree

Showing 11 changed files with 106 additions and 39 deletions.
diff --git a/apps/deno/tests/test1.ts b/apps/deno/tests/test1.ts
@@ -18,8 +18,6 @@ import {
   popGraphicsState,
   pushGraphicsState,
   rgb,
-  setDashPattern,
-  setLineCap,
   setLineJoin,
   StandardFonts,
 } from '../../../dist/pdf-lib.esm.js';
@@ -144,10 +142,6 @@ export default async (assets: Assets) => {
   // Lower-left quadrant
   page1.moveTo(0, 0);
   page1.drawSquare({ size: size / 2, color: cmyk(1, 0, 0, 0) });
-  page1.pushOperators(
-    pushGraphicsState(),
-    setLineCap(LineCapStyle.Round),
-  );
   page1.drawCircle({
     x: size / 4,
     y: size / 4,
@@ -156,8 +150,23 @@ export default async (assets: Assets) => {
     borderDashArray: [25],
     borderDashPhase: 25,
     borderColor: cmyk(0, 1, 0, 0),
+    borderLineCap: LineCapStyle.Round,
+  });
+
+  page1.drawLine({
+    start: {
+      x: size / 4,
+      y: size / 4
+    },
+    end: {
+      x: size / 4 + 100,
+      y: size / 4 + 100
+    },
+    color: rgb(0, 1, 0),
+    thickness: 3,
+    dashArray: [12, 6],
+    lineCap: LineCapStyle.Round,
   });
-  page1.pushOperators(popGraphicsState());
 
   page1.drawLine({
     start: {

diff --git a/apps/deno/tests/test12.ts b/apps/deno/tests/test12.ts
@@ -3,6 +3,7 @@ import {
   PageSizes,
   PDFDocument,
   BlendMode,
+  LineCapStyle,
   cmyk,
   degrees,
   rgb,
@@ -72,8 +73,9 @@ const secondPage = async (pdfDoc: PDFDocument) => {
     x: inchToPt(-1),
     y: inchToPt(11),
     scale: 0.5,
-    borderWidth: 2,
-    borderDashArray: [12, 6],
+    borderWidth: 4,
+    borderDashArray: [24, 12],
+    borderLineCap: LineCapStyle.Round,
   });
   page.drawSvgPath('M200,300 L400,50 L600,300 L800,550 L1000,300', {
     x: inchToPt(-1),

diff --git a/apps/node/tests/test1.ts b/apps/node/tests/test1.ts
@@ -17,7 +17,6 @@ import {
   popGraphicsState,
   pushGraphicsState,
   rgb,
-  setLineCap,
   setLineJoin,
   StandardFonts,
   typedArrayFor,
@@ -143,10 +142,6 @@ export default async (assets: Assets) => {
   // Lower-left quadrant
   page1.moveTo(0, 0);
   page1.drawSquare({ size: size / 2, color: cmyk(1, 0, 0, 0) });
-  page1.pushOperators(
-    pushGraphicsState(),
-    setLineCap(LineCapStyle.Round),
-  );
   page1.drawCircle({
     x: size / 4,
     y: size / 4,
@@ -155,8 +150,23 @@ export default async (assets: Assets) => {
     borderDashArray: [25],
     borderDashPhase: 25,
     borderColor: cmyk(0, 1, 0, 0),
+    borderLineCap: LineCapStyle.Round,
+  });
+
+  page1.drawLine({
+    start: {
+      x: size / 4,
+      y: size / 4
+    },
+    end: {
+      x: size / 4 + 100,
+      y: size / 4 + 100
+    },
+    color: rgb(0, 1, 0),
+    thickness: 3,
+    dashArray: [12, 6],
+    lineCap: LineCapStyle.Round,
   });
-  page1.pushOperators(popGraphicsState());
 
   page1.drawLine({
     start: {

diff --git a/apps/node/tests/test12.ts b/apps/node/tests/test12.ts
@@ -3,6 +3,7 @@ import {
   PageSizes,
   PDFDocument,
   BlendMode,
+  LineCapStyle,
   cmyk,
   degrees,
   rgb,
@@ -69,8 +70,9 @@ const secondPage = async (pdfDoc: PDFDocument) => {
     x: inchToPt(-1),
     y: inchToPt(11),
     scale: 0.5,
-    borderWidth: 2,
-    borderDashArray: [12, 6],
+    borderWidth: 4,
+    borderDashArray: [24, 12],
+    borderLineCap: LineCapStyle.Round,
   });
   page.drawSvgPath('M200,300 L400,50 L600,300 L800,550 L1000,300', {
     x: inchToPt(-1),

diff --git a/apps/rn/src/tests/test1.js b/apps/rn/src/tests/test1.js
@@ -17,7 +17,6 @@ import {
   popGraphicsState,
   pushGraphicsState,
   rgb,
-  setLineCap,
   setLineJoin,
   StandardFonts,
 } from 'pdf-lib';
@@ -148,10 +147,6 @@ export default async () => {
   // Lower-left quadrant
   page1.moveTo(0, 0);
   page1.drawSquare({ size: size / 2, color: cmyk(1, 0, 0, 0) });
-  page1.pushOperators(
-    pushGraphicsState(),
-    setLineCap(LineCapStyle.Round),
-  );
   page1.drawCircle({
     x: size / 4,
     y: size / 4,
@@ -160,8 +155,23 @@ export default async () => {
     borderDashArray: [25],
     borderDashPhase: 25,
     borderColor: cmyk(0, 1, 0, 0),
+    borderLineCap: LineCapStyle.Round,
+  });
+
+  page1.drawLine({
+    start: {
+      x: size / 4,
+      y: size / 4
+    },
+    end: {
+      x: size / 4 + 100,
+      y: size / 4 + 100
+    },
+    color: rgb(0, 1, 0),
+    thickness: 3,
+    dashArray: [12, 6],
+    lineCap: LineCapStyle.Round,
   });
-  page1.pushOperators(popGraphicsState());
 
   page1.drawLine({
     start: {

diff --git a/apps/rn/src/tests/test12.js b/apps/rn/src/tests/test12.js
@@ -2,6 +2,7 @@ import {
   PageSizes,
   PDFDocument,
   BlendMode,
+  LineCapStyle,
   cmyk,
   degrees,
   rgb,
@@ -70,8 +71,9 @@ const secondPage = async (pdfDoc) => {
     x: inchToPt(-1),
     y: inchToPt(11),
     scale: 0.5,
-    borderWidth: 2,
-    borderDashArray: [12, 6],
+    borderWidth: 4,
+    borderDashArray: [24, 12],
+    borderLineCap: LineCapStyle.Round,
   });
   page.drawSvgPath('M200,300 L400,50 L600,300 L800,550 L1000,300', {
     x: inchToPt(-1),

diff --git a/apps/web/test1.html b/apps/web/test1.html
@@ -63,12 +63,10 @@
         clipEvenOdd,
         closePath,
         cmyk,
-        setDashPattern,
         degrees,
         drawRectangle,
         endPath,
         grayscale,
-        setLineCap,
         LineCapStyle,
         setLineJoin,
         LineJoinStyle,
@@ -197,10 +195,6 @@
       // Lower-left quadrant
       page1.moveTo(0, 0);
       page1.drawSquare({ size: size / 2, color: cmyk(1, 0, 0, 0) });
-      page1.pushOperators(
-        pushGraphicsState(),
-        setLineCap(LineCapStyle.Round),
-      );
       page1.drawCircle({
         x: size / 4,
         y: size / 4,
@@ -209,8 +203,23 @@
         borderDashArray: [25],
         borderDashPhase: 25,
         borderColor: cmyk(0, 1, 0, 0),
+        borderLineCap: LineCapStyle.Round,
+      });
+
+      page1.drawLine({
+        start: {
+          x: size / 4,
+          y: size / 4
+        },
+        end: {
+          x: size / 4 + 100,
+          y: size / 4 + 100
+        },
+        color: rgb(0, 1, 0),
+        thickness: 3,
+        dashArray: [12, 6],
+        lineCap: LineCapStyle.Round,
       });
-      page1.pushOperators(popGraphicsState());
 
       page1.drawLine({
         start: {

diff --git a/apps/web/test12.html b/apps/web/test12.html
@@ -36,6 +36,7 @@
     const {
       PageSizes,
       PDFDocument,
+      LineCapStyle,
       rgb,
       cmyk,
       BlendMode,
@@ -119,8 +120,9 @@
         x: inchToPt(-1),
         y: inchToPt(11),
         scale: 0.5,
-        borderWidth: 2,
-        borderDashArray: [12, 6],
+        borderWidth: 4,
+        borderDashArray: [24, 12],
+        borderLineCap: LineCapStyle.Round,
       });
       page.drawSvgPath('M200,300 L400,50 L600,300 L800,550 L1000,300', {
         x: inchToPt(-1),

diff --git a/src/api/PDFPage.ts b/src/api/PDFPage.ts
@@ -1135,6 +1135,7 @@ export default class PDFPage {
     ]);
     assertOrUndefined(options.borderDashArray, 'options.borderDashArray', [Array]);
     assertOrUndefined(options.borderDashPhase, 'options.borderDashPhase', ['number']);
+    assertOrUndefined(options.borderLineCap, 'options.borderLineCap', ['number']);
     assertRangeOrUndefined(
       options.borderOpacity,
       'options.borderOpacity',
@@ -1164,6 +1165,7 @@ export default class PDFPage {
         borderWidth: options.borderWidth ?? 0,
         borderDashArray: options.borderDashArray ?? undefined,
         borderDashPhase: options.borderDashPhase ?? undefined,
+        borderLineCap: options.borderLineCap ?? undefined,
         graphicsState: graphicsStateKey,
       }),
     );
@@ -1201,6 +1203,7 @@ export default class PDFPage {
     assertOrUndefined(options.dashPhase, 'options.dashPhase', ['number']);
     assertIsOneOf(options.lineCap, 'options.lineCap', LineCapStyle);
     assertRangeOrUndefined(options.opacity, 'opacity.opacity', 0, 1);
+    assertOrUndefined(options.lineCap, 'options.lineCap', ['number']);
     assertIsOneOfOrUndefined(options.blendMode, 'options.blendMode', BlendMode);
 
     const graphicsStateKey = this.maybeEmbedGraphicsState({
@@ -1263,6 +1266,7 @@ export default class PDFPage {
     ]);
     assertOrUndefined(options.borderDashArray, 'options.borderDashArray', [Array]);
     assertOrUndefined(options.borderDashPhase, 'options.borderDashPhase', ['number']);
+    assertOrUndefined(options.borderLineCap, 'options.borderLineCap', ['number']);
     assertRangeOrUndefined(
       options.borderOpacity,
       'options.borderOpacity',
@@ -1297,6 +1301,7 @@ export default class PDFPage {
         borderDashArray: options.borderDashArray ?? undefined,
         borderDashPhase: options.borderDashPhase ?? undefined,
         graphicsState: graphicsStateKey,
+        borderLineCap: options.borderLineCap ?? undefined,
       }),
     );
   }
@@ -1364,6 +1369,7 @@ export default class PDFPage {
     assertOrUndefined(options.borderWidth, 'options.borderWidth', ['number']);
     assertOrUndefined(options.borderDashArray, 'options.borderDashArray', [Array]);
     assertOrUndefined(options.borderDashPhase, 'options.borderDashPhase', ['number']);
+    assertOrUndefined(options.borderLineCap, 'options.borderLineCap', ['number']);
     assertIsOneOfOrUndefined(options.blendMode, 'options.blendMode', BlendMode);
 
     const graphicsStateKey = this.maybeEmbedGraphicsState({
@@ -1388,6 +1394,7 @@ export default class PDFPage {
         borderWidth: options.borderWidth ?? 0,
         borderDashArray: options.borderDashArray ?? undefined,
         borderDashPhase: options.borderDashPhase ?? undefined,
+        borderLineCap: options.borderLineCap ?? undefined,
         graphicsState: graphicsStateKey,
       }),
     );

diff --git a/src/api/PDFPageOptions.ts b/src/api/PDFPageOptions.ts
@@ -71,6 +71,7 @@ export interface PDFPageDrawSVGOptions {
   borderOpacity?: number;
   borderDashArray?: number[];
   borderDashPhase?: number; 
+  borderLineCap?: LineCapStyle;
   blendMode?: BlendMode;
 }
 
@@ -100,7 +101,8 @@ export interface PDFPageDrawRectangleOptions {
   borderColor?: Color;
   borderOpacity?: number;
   borderDashArray?: number[];
-  borderDashPhase?: number; 
+  borderDashPhase?: number;
+  borderLineCap?: LineCapStyle;
   blendMode?: BlendMode;
 }
 
@@ -117,7 +119,8 @@ export interface PDFPageDrawSquareOptions {
   borderColor?: Color;
   borderOpacity?: number;
   borderDashArray?: number[];
-  borderDashPhase?: number; 
+  borderDashPhase?: number;
+  borderLineCap?: LineCapStyle;
   blendMode?: BlendMode;
 }
 
@@ -132,7 +135,8 @@ export interface PDFPageDrawEllipseOptions {
   borderOpacity?: number;
   borderWidth?: number;
   borderDashArray?: number[];
-  borderDashPhase?: number; 
+  borderDashPhase?: number;
+  borderLineCap?: LineCapStyle;
   blendMode?: BlendMode;
 }
 
@@ -146,6 +150,7 @@ export interface PDFPageDrawCircleOptions {
   borderOpacity?: number;
   borderWidth?: number;
   borderDashArray?: number[];
-  borderDashPhase?: number; 
+  borderDashPhase?: number;
+  borderLineCap?: LineCapStyle;
   blendMode?: BlendMode;
 }