@inweb/markup 25.8.19 → 25.8.21

package/src/markup/Konva/MarkupColor.ts

@@ -22,57 +22,56 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 /**
- * Markup color.
+ * Defines the markup color helper object.
  */
 export class MarkupColor {
   public R: number;
   public G: number;
   public B: number;
-
-  private _hex: string;
+  public HEX: string;
 
   /**
-   * Color in #000000 format
+   * Creates an instance of the color.
+   *
+   * @param r - The `red` component of the color, as a number between 0 and 255.
+   * @param g - The `green` component of the color, as a number between 0 and 255.
+   * @param b - The `blue` component of the color, as a number between 0 and 255.
    */
-  get HexColor(): string {
-    return "#" + this._hex;
+  constructor(r: number, g: number, b: number) {
+    this.setColor(r, g, b);
   }
 
   /**
-   * Color as object with r,g,b properties
+   * Returns the color as a string in hexadecimal color syntax `#RGB` using its primary color
+   * components (red, green, blue) written as hexadecimal numbers.
    */
-  get RGB(): { r: number; g: number; b: number } {
-    return { r: this.R, g: this.G, b: this.B };
+  public asHex(): string {
+    return "#" + this.HEX;
   }
 
   /**
-   * Create an instance of Color
-   *
-   * @param r - Red color in [0,255] range
-   * @param g - Green color in [0,255] range
-   * @param b - Blue color in [0,255] range
+   * Returns the color as an {r, g, b} object.
    */
-  constructor(r: number, g: number, b: number) {
-    this.setColor(r, g, b);
+  public asRGB(): { r: number; g: number; b: number } {
+    return { r: this.R, g: this.G, b: this.B };
   }
 
   /**
-   * Set Color for current instance
+   * Sets the color.
    *
-   * @param r - Red color in [0,255] range
-   * @param g - Green color in [0,255] range
-   * @param b - Blue color in [0,255] range
+   * @param r - The `red` component of the color, as a number between 0 and 255.
+   * @param g - The `green` component of the color, as a number between 0 and 255.
+   * @param b - The `blue` component of the color, as a number between 0 and 255.
    */
   public setColor(r: number, g: number, b: number): void {
     this.R = r;
     this.G = g;
     this.B = b;
-
-    this._hex = this.rgbToHex(r, g, b);
+    this.HEX = this.rgbToHex(r, g, b);
   }
 
   private rgbToHex(r: number, g: number, b: number): string {
-    const valueToHex = (c) => {
+    const valueToHex = (c: number) => {
       const hex = c.toString(16);
       return hex === "0" ? "00" : hex;
     };