@muhammara/native-core 7.0.0-alpha.1 → 7.0.0-beta.2

package/lib/recipe/vector.js

@@ -12,6 +12,8 @@
 //   DecimalColor component values range from 0 to 255.
 //   PercentColor component values range from 1 to 100.
 
+const { linkPdf } = require("./annotation");
+
 /**
  * Draw a circle
  * @name circle
@@ -74,7 +76,8 @@ exports.circle = function circle(x, y, radius, options = {}) {
       diameter,
       diameter,
       pathOptions,
-      (ctx) => {
+      (ctx, xObject) => {
+        ctx.gs(xObject.getGsName(pathOptions.strokeGsId));
         ctx
           .d(pathOptions.dash, pathOptions.dashPhase)
           .drawCircle(
@@ -88,6 +91,8 @@ exports.circle = function circle(x, y, radius, options = {}) {
       },
     );
   }
+  if (options.link)
+    this.link(options.link, x - radius, y - radius, diameter, diameter);
   return this;
 };
 
@@ -173,6 +178,7 @@ exports.rectangle = function rectangle(x, y, width, height, options = {}) {
       height,
       pathOptions,
       (ctx, xObject) => {
+        ctx.gs(xObject.getGsName(pathOptions.strokeGsId));
         // ... requires adjusting the internal drawing to accomodate line thickness.
         const margin = pathOptions.width;
         xObject.stroke(colorModel);
@@ -203,6 +209,11 @@ exports.rectangle = function rectangle(x, y, width, height, options = {}) {
       },
     );
   }
+  if (options.link) {
+    if (options.useGivenCoords)
+      linkPdf(this, options.link, x, y, width, height);
+    else this.link(options.link, x, y, width, height);
+  }
 
   return this;
 };
@@ -362,6 +373,7 @@ exports.ellipse = function ellipse(cx, cy, rx, ry, options = {}) {
       height,
       pathOptions,
       (ctx, xObject) => {
+        ctx.gs(xObject.getGsName(pathOptions.strokeGsId));
         const margin = pathOptions.width / 2;
         xObject.stroke(colorModel);
         ctx.w(pathOptions.width).d(pathOptions.dash, pathOptions.dashPhase);
@@ -378,6 +390,7 @@ exports.ellipse = function ellipse(cx, cy, rx, ry, options = {}) {
       },
     );
   }
+  if (options.link) this.link(options.link, cx - rx, cy - ry, width, height);
   return this;
 };
 
@@ -518,6 +531,7 @@ exports.arc = function arc(
       diameter,
       pathOptions,
       (ctx, xObject) => {
+        ctx.gs(xObject.getGsName(pathOptions.strokeGsId));
         const margin = pathOptions.width / 2;
         xObject.stroke(colorModel);
         ctx.w(pathOptions.width).d(pathOptions.dash, pathOptions.dashPhase);
@@ -532,34 +546,118 @@ exports.arc = function arc(
     );
   }
 
+  if (options.link)
+    this.link(options.link, x - radius, y - radius, diameter, diameter);
+  return this;
+};
+
+/**
+ * Draw a closed sector of a circle.
+ * @name pie
+ * @function
+ * @memberof Recipe#
+ * @param {number} x - the x coordinate of the pie center point
+ * @param {number} y - the y coordinate of the pie center point
+ * @param {number} radius - the distance from the center point to the arc
+ * @param {number} [startAngle=0] - the start of the arc in degree units
+ * @param {number} [endAngle=360] - the end of the arc in degree units
+ * @param {Object} [options] - The path options.
+ * @returns {Recipe} The recipe instance.
+ */
+exports.pie = function pie(x, y, radius, startAngle, endAngle, options = {}) {
+  return this.arc(x, y, radius, startAngle, endAngle, {
+    ...options,
+    sector: true,
+  });
+};
+
+/**
+ * Set the line style for the current page content context.
+ * @name lineStyle
+ * @function
+ * @memberof Recipe#
+ * @param {Recipe.LineStyleOptions} [options] - The line style options.
+ * @param {number} [options.width] - The line width.
+ * @param {number} [options.lineWidth] - Alias for width.
+ * @param {number} [options.cap] - The PDF line cap style.
+ * @param {number} [options.join] - The PDF line join style.
+ * @param {number} [options.miterLimit] - The miter limit.
+ * @param {number[]} [options.dash] - The dash pattern.
+ * @param {number} [options.dashPhase] - The dash pattern phase.
+ * @returns {Recipe} The recipe instance.
+ */
+exports.lineStyle = function lineStyle(options = {}) {
+  this.current = this.current || {};
+  this.current.lineStyle = this.current.lineStyle || {};
+
+  if (options.width !== undefined || options.lineWidth !== undefined) {
+    const width = options.width ?? options.lineWidth;
+    this.current.lineStyle.width = width;
+    this.pageContext.w(width);
+  }
+  if (options.cap !== undefined) {
+    this.current.lineStyle.cap = options.cap;
+    this.pageContext.J(options.cap);
+  }
+  if (options.join !== undefined) {
+    this.current.lineStyle.join = options.join;
+    this.pageContext.j(options.join);
+  }
+  if (options.miterLimit !== undefined) {
+    this.current.lineStyle.miterLimit = options.miterLimit;
+    this.pageContext.M(options.miterLimit);
+  }
+  if (options.dash !== undefined || options.dashPhase !== undefined) {
+    const dash = options.dash ?? this.current.lineStyle.dash ?? [];
+    const dashPhase =
+      options.dashPhase ?? this.current.lineStyle.dashPhase ?? 0;
+    this.current.lineStyle.dash = dash;
+    this.current.lineStyle.dashPhase = dashPhase;
+  }
+  return this._setLineStyle(options);
+};
+
+exports._setLineStyle = function _setLineStyle(options = {}) {
+  if (options.width !== undefined || options.lineWidth !== undefined)
+    this.pageContext.w(options.width ?? options.lineWidth);
+  if (options.cap !== undefined) this.pageContext.J(options.cap);
+  if (options.join !== undefined) this.pageContext.j(options.join);
+  if (options.miterLimit !== undefined) this.pageContext.M(options.miterLimit);
+  if (options.dash !== undefined || options.dashPhase !== undefined)
+    this.pageContext.d(
+      options.dash ?? this.current.lineStyle.dash ?? [],
+      options.dashPhase ?? this.current.lineStyle.dashPhase ?? 0,
+    );
   return this;
 };
 
 /**
  * Set the line width.
  *
- * This compatibility method currently has no effect.
  * @name lineWidth
  * @function
  * @memberof Recipe#
- * @param {number} width - The requested line width.
+ * @param {number} width - The line width.
  * @returns {Recipe} The recipe instance.
  */
-exports.lineWidth = function lineWidth() {
-  return this;
+exports.lineWidth = function lineWidth(width) {
+  return this.lineStyle({ width });
 };
 
 /**
- * Set the fill opacity.
+ * Set fill and stroke opacity.
  *
- * This compatibility method currently has no effect.
- * @name fillOpacity
+ * @name opacity
  * @function
  * @memberof Recipe#
- * @param {number} opacity - The requested fill opacity.
+ * @param {number} value - The requested opacity from 0 (transparent) to 1 (opaque).
  * @returns {Recipe} The recipe instance.
  */
-exports.fillOpacity = function fillOpacity() {
+exports.opacity = function opacity(value) {
+  if (!Number.isFinite(value) || value < 0 || value > 1) {
+    throw new RangeError("Opacity must be a finite number between 0 and 1");
+  }
+  this.current.opacity = value;
   return this;
 };
 

package/lib/recipe-info.js

@@ -0,0 +1,10 @@
+// Metadata fields accepted by Recipe constructor options and info().
+var recipeInfoKeys = Object.freeze({
+  author: "author",
+  title: "title",
+  subject: "subject",
+  keywords: "keywords",
+});
+var standardInfoKeys = Object.freeze(Object.values(recipeInfoKeys));
+
+module.exports = { recipeInfoKeys, standardInfoKeys };