@nmmty/lazycanvas 0.6.0 → 0.6.2

package/dist/structures/components/QuadraticLayer.js

@@ -15,8 +15,8 @@ class QuadraticLayer extends BaseLayer_1.BaseLayer {
     props;
     /**
      * Constructs a new QuadraticLayer instance.
-     * @param props {IQuadraticLayerProps} - The properties of the Quadratic Layer.
-     * @param misc {IBaseLayerMisc} - Miscellaneous options for the layer.
+     * @param {IQuadraticLayerProps} [props] - The properties of the Quadratic Layer.
+     * @param {IBaseLayerMisc} [misc] - Miscellaneous options for the layer.
      */
     constructor(props, misc) {
         super(types_1.LayerType.QuadraticCurve, props || {}, misc);
@@ -25,8 +25,8 @@ class QuadraticLayer extends BaseLayer_1.BaseLayer {
     }
     /**
      * Sets the control point of the quadratic layer.
-     * @param x {ScaleType} - The x-coordinate of the control point.
-     * @param y {ScaleType} - The y-coordinate of the control point.
+     * @param {ScaleType} [x] - The x-coordinate of the control point.
+     * @param {ScaleType} [y] - The y-coordinate of the control point.
      * @returns {this} The current instance for chaining.
      */
     setControlPoint(x, y) {
@@ -35,8 +35,8 @@ class QuadraticLayer extends BaseLayer_1.BaseLayer {
     }
     /**
      * Sets the end point of the quadratic layer.
-     * @param x {ScaleType} - The x-coordinate of the end point.
-     * @param y {ScaleType} - The y-coordinate of the end point.
+     * @param {ScaleType} [x] - The x-coordinate of the end point.
+     * @param {ScaleType} [y] - The y-coordinate of the end point.
      * @returns {this} The current instance for chaining.
      */
     setEndPosition(x, y) {
@@ -45,7 +45,7 @@ class QuadraticLayer extends BaseLayer_1.BaseLayer {
     }
     /**
      * Sets the color of the layer.
-     * @param color {ColorType} - The color of the layer.
+     * @param {ColorType} [color] - The color of the layer.
      * @returns {this} The current instance for chaining.
      * @throws {LazyError} If the color is not provided or invalid.
      */
@@ -59,12 +59,12 @@ class QuadraticLayer extends BaseLayer_1.BaseLayer {
     }
     /**
      * Sets the stroke properties of the layer.
-     * @param width {number} - The width of the stroke.
-     * @param cap {CanvasLineCap} - The cap style of the stroke.
-     * @param join {CanvasLineJoin} - The join style of the stroke.
-     * @param dash {number[]} - The dash pattern of the stroke.
-     * @param dashOffset {number} - The dash offset of the stroke.
-     * @param miterLimit {number} - The miter limit of the stroke.
+     * @param {number} [width] - The width of the stroke.
+     * @param {string} [cap] - The cap style of the stroke.
+     * @param {string} [join] - The join style of the stroke.
+     * @param {number[]} [dash] - The dash pattern of the stroke.
+     * @param {number} [dashOffset] - The dash offset of the stroke.
+     * @param {number} [miterLimit] - The miter limit of the stroke.
      * @returns {this} The current instance for chaining.
      */
     setStroke(width, cap, join, dash, dashOffset, miterLimit) {
@@ -80,9 +80,9 @@ class QuadraticLayer extends BaseLayer_1.BaseLayer {
     }
     /**
      * Calculates the bounding box of the quadratic curve.
-     * @param ctx {SKRSContext2D} - The canvas rendering context.
-     * @param canvas {Canvas | SvgCanvas} - The canvas instance.
-     * @param manager {LayersManager} - The layers manager.
+     * @param {SKRSContext2D} [ctx] - The canvas rendering context.
+     * @param {Canvas | SvgCanvas} [canvas] - The canvas instance.
+     * @param {LayersManager} [manager] - The layers manager.
      * @returns {Object} The bounding box details including max, min, center, width, and height.
      */
     getBoundingBox(ctx, canvas, manager) {
@@ -100,10 +100,10 @@ class QuadraticLayer extends BaseLayer_1.BaseLayer {
     }
     /**
      * Draws the quadratic curve on the canvas.
-     * @param ctx {SKRSContext2D} - The canvas rendering context.
-     * @param canvas {Canvas | SvgCanvas} - The canvas instance.
-     * @param manager {LayersManager} - The layers manager.
-     * @param debug {boolean} - Whether to enable debug logging.
+     * @param {SKRSContext2D} [ctx] - The canvas rendering context.
+     * @param {Canvas | SvgCanvas} [canvas] - The canvas instance.
+     * @param {LayersManager} [manager] - The layers manager.
+     * @param {boolean} [debug] - Whether to enable debug logging.
      */
     async draw(ctx, canvas, manager, debug) {
         const parcer = (0, utils_1.parser)(ctx, canvas, manager);
@@ -154,12 +154,14 @@ class QuadraticLayer extends BaseLayer_1.BaseLayer {
     }
     /**
      * Validates the properties of the Quadratic Layer.
-     * @param data {IQuadraticLayerProps} - The properties to validate.
+     * @param {IQuadraticLayerProps} [data] - The properties to validate.
      * @returns {IQuadraticLayerProps} The validated properties.
      */
     validateProps(data) {
         return {
             ...super.validateProps(data),
+            filled: data.filled || false,
+            fillStyle: data.fillStyle || '#000000',
             centring: data.centring || types_1.Centring.None,
             controlPoints: data.controlPoints || [{ x: 0, y: 0 }],
             endPoint: data.endPoint || { x: 0, y: 0 },

package/dist/structures/components/TextLayer.d.ts

@@ -1,7 +1,7 @@
 import { BaseLayer, IBaseLayer, IBaseLayerMisc, IBaseLayerProps } from "./BaseLayer";
-import { ScaleType, ColorType, AnyWeight, AnyTextAlign, AnyTextBaseline, AnyTextDirection, LineCap, LineJoin, LayerType } from "../../types";
+import { ScaleType, ColorType, AnyWeight, AnyTextAlign, AnyTextBaseline, AnyTextDirection, LineCap, LineJoin, LayerType, SubStringColor } from "../../types";
 import { Canvas, SKRSContext2D, SvgCanvas } from "@napi-rs/canvas";
-import { LayersManager } from "../managers/LayersManager";
+import { LayersManager } from "../managers";
 /**
  * Interface representing a Text Layer.
  */
@@ -23,6 +23,18 @@ export interface ITextLayerProps extends IBaseLayerProps {
      * The text content of the layer.
      */
     text: string;
+    /**
+     * Whether the layer is filled.
+     */
+    filled: boolean;
+    /**
+     * The fill style (color or pattern) of the layer.
+     */
+    fillStyle: ColorType;
+    /**
+     * Array of substring color configurations for partial text coloring.
+     */
+    subStringColors?: SubStringColor[];
     /**
      * The font configuration for the text.
      */
@@ -126,21 +138,21 @@ export declare class TextLayer extends BaseLayer<ITextLayerProps> {
     props: ITextLayerProps;
     /**
      * Constructs a new TextLayer instance.
-     * @param props {ITextLayerProps} - The properties of the Text Layer.
-     * @param misc {IBaseLayerMisc} - Miscellaneous options for the layer.
+     * @param {ITextLayerProps} [props] - The properties of the Text Layer.
+     * @param {IBaseLayerMisc} [misc] - Miscellaneous options for the layer.
      */
     constructor(props?: ITextLayerProps, misc?: IBaseLayerMisc);
     /**
      * Sets the text of the text layer.
-     * @param text {string} - The text content of the layer.
+     * @param {string} [text] - The text content of the layer.
      * @returns {this} The current instance for chaining.
      */
     setText(text: string): this;
     /**
      * Sets the font of the text layer.
-     * @param familyOrConfig {string | { family: string; size: number; weight: AnyWeight }} - The font family or configuration object.
-     * @param size {number} - The font size (required if `familyOrConfig` is a string).
-     * @param weight {AnyWeight} - The font weight (required if `familyOrConfig` is a string).
+     * @param {string | { family: string; size: number; weight: AnyWeight }} [familyOrConfig] - The font family or configuration object.
+     * @param {number} [size] - The font size (required if `familyOrConfig` is a string).
+     * @param {AnyWeight} [weight] - The font weight (required if `familyOrConfig` is a string).
      * @returns {this} The current instance for chaining.
      * @throws {LazyError} If size or weight is not provided when `familyOrConfig` is a string.
      */
@@ -151,65 +163,65 @@ export declare class TextLayer extends BaseLayer<ITextLayerProps> {
     }, size?: number, weight?: AnyWeight): this;
     /**
      * Configures the multiline properties of the text layer.
-     * @param enabled {boolean} - Whether multiline is enabled.
-     * @param width {ScaleType} - The width of the multiline text area.
-     * @param height {ScaleType} - The height of the multiline text area.
-     * @param spacing {number} - The spacing between lines (optional).
+     * @param {ScaleType} [width] - The width of the multiline text area.
+     * @param {ScaleType} [height] - The height of the multiline text area.
+     * @param {number} [spacing] - The spacing between lines (optional).
      * @returns {this} The current instance for chaining.
      */
-    setMultiline(enabled: boolean, width: ScaleType, height: ScaleType, spacing?: number): this;
+    setMultiline(width: ScaleType, height: ScaleType, spacing?: number): this;
     /**
      * Sets the color of the text layer.
-     * @param color {ColorType} - The color of the text.
+     * @param {ColorType} [color] - The base color of the text.
+     * @param {SubStringColor[]} [sub] - Optional substring colors for partial text coloring.
      * @returns {this} The current instance for chaining.
      * @throws {LazyError} If the color is not provided or invalid.
      */
-    setColor(color: ColorType): this;
+    setColor(color: ColorType, ...sub: SubStringColor[]): this;
     /**
      * Sets the alignment of the text layer.
-     * @param align {AnyTextAlign} - The alignment of the text.
+     * @param {AnyTextAlign} [align] - The alignment of the text.
      * @returns {this} The current instance for chaining.
      */
     setAlign(align: AnyTextAlign): this;
     /**
      * Sets the baseline of the text layer.
-     * @param baseline {AnyTextBaseline} - The baseline of the text.
+     * @param {AnyTextBaseline} [baseline] - The baseline of the text.
      * @returns {this} The current instance for chaining.
      */
     setBaseline(baseline: AnyTextBaseline): this;
     /**
      * Sets the direction of the text layer.
-     * @param direction {AnyTextDirection} - The direction of the text.
+     * @param {AnyTextDirection} [direction] - The direction of the text.
      * @returns {this} The current instance for chaining.
      */
     setDirection(direction: AnyTextDirection): this;
     /**
      * Configures the stroke properties of the text layer.
-     * @param width {number} - The width of the stroke.
-     * @param cap {string} - The cap style of the stroke (optional).
-     * @param join {string} - The join style of the stroke (optional).
-     * @param dash {number[]} - The dash pattern of the stroke (optional).
-     * @param dashOffset {number} - The dash offset of the stroke (optional).
-     * @param miterLimit {number} - The miter limit of the stroke (optional).
+     * @param {number} [width] - The width of the stroke.
+     * @param {string} [cap] - The cap style of the stroke.
+     * @param {string} [join] - The join style of the stroke.
+     * @param {number[]} [dash] - The dash pattern of the stroke.
+     * @param {number} [dashOffset] - The dash offset of the stroke.
+     * @param {number} [miterLimit] - The miter limit of the stroke.
      * @returns {this} The current instance for chaining.
      */
     setStroke(width: number, cap?: LineCap, join?: LineJoin, dash?: number[], dashOffset?: number, miterLimit?: number): this;
     /**
      * Sets the spacing between words in the text layer.
-     * @param wordSpacing {number} - The spacing between words.
+     * @param {number} [wordSpacing] - The spacing between words.
      * @returns {this} The current instance for chaining.
      */
     setWordSpacing(wordSpacing: number): this;
     /**
      * Sets the spacing between letters in the text layer.
-     * @param letterSpacing {number} - The spacing between letters.
+     * @param {number} [letterSpacing] - The spacing between letters.
      * @returns {this} The current instance for chaining.
      */
     setLetterSpacing(letterSpacing: number): this;
     /**
      * Measures the dimensions of the text.
-     * @param ctx {SKRSContext2D} - The canvas rendering context.
-     * @param canvas {Canvas | SvgCanvas} - The canvas instance.
+     * @param {SKRSContext2D} [ctx] - The canvas rendering context.
+     * @param {Canvas | SvgCanvas} [canvas] - The canvas instance.
      * @returns {Object} The width and height of the text.
      */
     measureText(ctx: SKRSContext2D, canvas: Canvas | SvgCanvas): {
@@ -218,21 +230,22 @@ export declare class TextLayer extends BaseLayer<ITextLayerProps> {
     };
     /**
      * Draws the text layer on the canvas.
-     * @param ctx {SKRSContext2D} - The canvas rendering context.
-     * @param canvas {Canvas | SvgCanvas} - The canvas instance.
-     * @param manager {LayersManager} - The layers manager.
-     * @param debug {boolean} - Whether to enable debug logging.
+     * @param {SKRSContext2D} [ctx] - The canvas rendering context.
+     * @param {Canvas | SvgCanvas} [canvas] - The canvas instance.
+     * @param {LayersManager} [manager] - The layers manager.
+     * @param {boolean} [debug] - Whether to enable debug logging.
      */
     draw(ctx: SKRSContext2D, canvas: Canvas | SvgCanvas, manager: LayersManager, debug: boolean): Promise<void>;
     /**
      * Draws the text on the canvas.
-     * @param props {ITextLayerProps} - The properties of the text layer.
-     * @param ctx {SKRSContext2D} - The canvas rendering context.
-     * @param fillStyle {string | CanvasGradient | CanvasPattern} - The fill style for the text.
-     * @param text {string} - The text content.
-     * @param x {number} - The x-coordinate of the text.
-     * @param y {number} - The y-coordinate of the text.
-     * @param w {number} - The width of the text area.
+     * @param {ITextLayerProps} [props] - The properties of the text layer.
+     * @param {SKRSContext2D} [ctx] - The canvas rendering context.
+     * @param {string | CanvasGradient | CanvasPattern}  [fillStyle] - The fill style for the text.
+     * @param {string} [text] - The text content.
+     * @param {number} [x] - The x-coordinate of the text.
+     * @param {number} [y] - The y-coordinate of the text.
+     * @param {number} [w] - The width of the text area.
+     * @param {number} [textOffset] - The offset of this text segment in the original full text (for multiline support).
      */
     private drawText;
     /**
@@ -242,8 +255,8 @@ export declare class TextLayer extends BaseLayer<ITextLayerProps> {
     toJSON(): ITextLayer;
     /**
      * Validates the properties of the Text Layer.
-     * @param props {ITextLayerProps} - The properties to validate.
+     * @param {ITextLayerProps} [data] - The properties to validate.
      * @returns {ITextLayerProps} The validated properties.
      */
-    protected validateProps(props: ITextLayerProps): ITextLayerProps;
+    protected validateProps(data: ITextLayerProps): ITextLayerProps;
 }