@sme.up/ketchup 6.6.0 → 6.7.0

package/dist/collection/components/kup-gauge/kup-gauge.js

@@ -1,4 +1,4 @@
-import { Component, Element, forceUpdate, h, Host, Method, Prop, } from '@stencil/core';
+import { forceUpdate, h, Host, } from '@stencil/core';
 import { KupDebugCategory } from '../../managers/kup-debug/kup-debug-declarations';
 import { kupManagerInstance, } from '../../managers/kup-manager/kup-manager';
 import { getProps, setProps, unformattedStringToFormattedStringNumber, } from '../../utils/utils';
@@ -363,463 +363,463 @@ export class KupGauge {
         this.measurementUnit));
     }
     const width = { width: this.widthComponent };
-    return (h(Host, null,
-      h("style", null, this.kupManager.theme.setKupStyle(this.rootElement)),
-      h("div", { id: componentWrapperId, class: "gauge__container" },
-        h("svg", { class: "gauge", style: width, viewBox: `0 0 ${this.size} ${valueLabelYPosition}` },
-          h("g", { transform: `rotate(-90) translate(-${halvedSize}, ${halvedSize})` }, arcsElements),
-          this.needleCircle ? (h("circle", { class: "gauge__needle-base", cx: halvedSize, cy: halvedSize, r: needleCircleRadius })) : null,
-          h("path", { class: "gauge__needle", d: this.paintNeedle(needleLength, needleCircleRadius, halvedSize, halvedSize, this.calculateValuePercentage(this.value)) }),
-          textElements,
-          valueText))));
+    return (h(Host, null, h("style", null, this.kupManager.theme.setKupStyle(this.rootElement)), h("div", { id: componentWrapperId, class: "gauge__container" }, h("svg", { class: "gauge", style: width, viewBox: `0 0 ${this.size} ${valueLabelYPosition}` }, h("g", { transform: `rotate(-90) translate(-${halvedSize}, ${halvedSize})` }, arcsElements), this.needleCircle ? (h("circle", { class: "gauge__needle-base", cx: halvedSize, cy: halvedSize, r: needleCircleRadius })) : null, h("path", { class: "gauge__needle", d: this.paintNeedle(needleLength, needleCircleRadius, halvedSize, halvedSize, this.calculateValuePercentage(this.value)) }), textElements, valueText))));
   }
   disconnectedCallback() {
     this.kupManager.theme.unregister(this);
   }
   static get is() { return "kup-gauge"; }
   static get encapsulation() { return "shadow"; }
-  static get originalStyleUrls() { return {
-    "$": ["kup-gauge.scss"]
-  }; }
-  static get styleUrls() { return {
-    "$": ["kup-gauge.css"]
-  }; }
-  static get properties() { return {
-    "arcThickness": {
-      "type": "number",
-      "mutable": false,
-      "complexType": {
-        "original": "number",
-        "resolved": "number",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [{
-            "name": "namespace",
-            "text": "kup-gauge.arcThickness"
-          }, {
-            "name": "see",
-            "text": "kup-gauge.size"
-          }],
-        "text": "Sets how much the arc of the gauge should be thick."
-      },
-      "attribute": "arc-thickness",
-      "reflect": false,
-      "defaultValue": "30"
-    },
-    "colors": {
-      "type": "unknown",
-      "mutable": false,
-      "complexType": {
-        "original": "string[]",
-        "resolved": "string[]",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [],
-        "text": "Array of three elements to specify the color of the arcs."
-      },
-      "defaultValue": "[\r\n        `var(${KupThemeColorValues.SUCCESS})`,\r\n        `var(${KupThemeColorValues.WARNING})`,\r\n        `var(${KupThemeColorValues.DANGER})`,\r\n    ]"
-    },
-    "customStyle": {
-      "type": "string",
-      "mutable": false,
-      "complexType": {
-        "original": "string",
-        "resolved": "string",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [{
-            "name": "default",
-            "text": "\"\""
-          }, {
-            "name": "see",
-            "text": "https://ketchup.smeup.com/ketchup-showcase/#/customization"
-          }],
-        "text": "Custom style of the component."
-      },
-      "attribute": "custom-style",
-      "reflect": false,
-      "defaultValue": "''"
-    },
-    "firstThreshold": {
-      "type": "number",
-      "mutable": false,
-      "complexType": {
-        "original": "number",
-        "resolved": "number",
-        "references": {}
-      },
-      "required": false,
-      "optional": true,
-      "docs": {
-        "tags": [],
-        "text": "The first threshold, establishing the length of the first and second arc."
-      },
-      "attribute": "first-threshold",
-      "reflect": false
-    },
-    "labelDistance": {
-      "type": "number",
-      "mutable": true,
-      "complexType": {
-        "original": "number",
-        "resolved": "number",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [],
-        "text": "The distance the label and the value has from the gauge graph."
-      },
-      "attribute": "label-distance",
-      "reflect": false,
-      "defaultValue": "20"
-    },
-    "maxValue": {
-      "type": "number",
-      "mutable": true,
-      "complexType": {
-        "original": "number",
-        "resolved": "number",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [],
-        "text": "The maximum value reachable in the current graph."
-      },
-      "attribute": "max-value",
-      "reflect": false,
-      "defaultValue": "100"
-    },
-    "measurementUnit": {
-      "type": "string",
-      "mutable": false,
-      "complexType": {
-        "original": "string",
-        "resolved": "string",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [],
-        "text": "A string which will be appended to the displayed values of the component."
-      },
-      "attribute": "measurement-unit",
-      "reflect": false,
-      "defaultValue": "''"
-    },
-    "minValue": {
-      "type": "number",
-      "mutable": true,
-      "complexType": {
-        "original": "number",
-        "resolved": "number",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [],
-        "text": "The minimum value reachable in the current graph."
-      },
-      "attribute": "min-value",
-      "reflect": false,
-      "defaultValue": "-100"
-    },
-    "needleCircle": {
-      "type": "boolean",
-      "mutable": false,
-      "complexType": {
-        "original": "boolean",
-        "resolved": "boolean",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [],
-        "text": "When true, shows a rounded needle."
-      },
-      "attribute": "needle-circle",
-      "reflect": false,
-      "defaultValue": "false"
-    },
-    "onlyValue": {
-      "type": "boolean",
-      "mutable": false,
-      "complexType": {
-        "original": "boolean",
-        "resolved": "boolean",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [],
-        "text": "When true, ignore thresholds in gauge and show colored value's arc."
-      },
-      "attribute": "only-value",
-      "reflect": false,
-      "defaultValue": "false"
-    },
-    "reverseColors": {
-      "type": "boolean",
-      "mutable": false,
-      "complexType": {
-        "original": "boolean",
-        "resolved": "boolean",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [],
-        "text": "When true, the colors inside the colors array are used in the reversed order."
-      },
-      "attribute": "reverse-colors",
-      "reflect": false,
-      "defaultValue": "false"
-    },
-    "secondThreshold": {
-      "type": "number",
-      "mutable": false,
-      "complexType": {
-        "original": "number",
-        "resolved": "number",
-        "references": {}
-      },
-      "required": false,
-      "optional": true,
-      "docs": {
-        "tags": [],
-        "text": "The second threshold, establishing the length of the second and third arc."
-      },
-      "attribute": "second-threshold",
-      "reflect": false
-    },
-    "showLabels": {
-      "type": "boolean",
-      "mutable": false,
-      "complexType": {
-        "original": "boolean",
-        "resolved": "boolean",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [],
-        "text": "If set to false, threshold values of the gauge are not displayed."
-      },
-      "attribute": "show-labels",
-      "reflect": false,
-      "defaultValue": "true"
-    },
-    "showMaxmin": {
-      "type": "boolean",
-      "mutable": false,
-      "complexType": {
-        "original": "boolean",
-        "resolved": "boolean",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [],
-        "text": "If set to false, the maximum and minimum values of the gauge are not displayed."
-      },
-      "attribute": "show-maxmin",
-      "reflect": false,
-      "defaultValue": "true"
-    },
-    "showValue": {
-      "type": "boolean",
-      "mutable": false,
-      "complexType": {
-        "original": "boolean",
-        "resolved": "boolean",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [],
-        "text": "If set to false, the current value of the gauge is not displayed."
-      },
-      "attribute": "show-value",
-      "reflect": false,
-      "defaultValue": "true"
-    },
-    "size": {
-      "type": "number",
-      "mutable": false,
-      "complexType": {
-        "original": "number",
-        "resolved": "number",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [{
-            "name": "namespace",
-            "text": "kup-gauge.size"
-          }, {
-            "name": "see",
-            "text": "kup-gauge.arcThickness"
-          }],
-        "text": "Con be used change the viewbox of the SVG.\r\nBy manipulating this value, some customizations of the aspect of the gauge is achievable."
-      },
-      "attribute": "size",
-      "reflect": false,
-      "defaultValue": "300"
-    },
-    "value": {
-      "type": "number",
-      "mutable": true,
-      "complexType": {
-        "original": "number",
-        "resolved": "number",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [],
-        "text": "The current value of the gauge.\r\nThe gauge's needle points to the percentage based on this prop."
-      },
-      "attribute": "value",
-      "reflect": false,
-      "defaultValue": "0"
-    },
-    "valueSize": {
-      "type": "number",
-      "mutable": false,
-      "complexType": {
-        "original": "number",
-        "resolved": "number",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [],
-        "text": "The current size of gauge's value.\r\nCorrect values are: 0,1,2 or 3."
-      },
-      "attribute": "value-size",
-      "reflect": false,
-      "defaultValue": "0"
-    },
-    "widthComponent": {
-      "type": "string",
-      "mutable": false,
-      "complexType": {
-        "original": "string",
-        "resolved": "string",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [],
-        "text": "Set Width gauge."
-      },
-      "attribute": "width-component",
-      "reflect": false,
-      "defaultValue": "'100%'"
-    }
-  }; }
-  static get methods() { return {
-    "getProps": {
-      "complexType": {
-        "signature": "(descriptions?: boolean) => Promise<GenericObject>",
-        "parameters": [{
-            "tags": [{
-                "name": "param",
-                "text": "descriptions - When provided and true, the result will be the list of props with their description."
-              }],
-            "text": "- When provided and true, the result will be the list of props with their description."
-          }],
-        "references": {
-          "Promise": {
-            "location": "global"
-          },
-          "GenericObject": {
-            "location": "import",
-            "path": "../../types/GenericTypes"
-          }
+  static get originalStyleUrls() {
+    return {
+      "$": ["kup-gauge.scss"]
+    };
+  }
+  static get styleUrls() {
+    return {
+      "$": ["kup-gauge.css"]
+    };
+  }
+  static get properties() {
+    return {
+      "arcThickness": {
+        "type": "number",
+        "mutable": false,
+        "complexType": {
+          "original": "number",
+          "resolved": "number",
+          "references": {}
         },
-        "return": "Promise<GenericObject>"
-      },
-      "docs": {
-        "text": "Used to retrieve component's props values.",
-        "tags": [{
-            "name": "param",
-            "text": "descriptions - When provided and true, the result will be the list of props with their description."
-          }, {
-            "name": "returns",
-            "text": "List of props as object, each key will be a prop."
-          }]
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [{
+              "name": "namespace",
+              "text": "kup-gauge.arcThickness"
+            }, {
+              "name": "see",
+              "text": "kup-gauge.size"
+            }],
+          "text": "Sets how much the arc of the gauge should be thick."
+        },
+        "attribute": "arc-thickness",
+        "reflect": false,
+        "defaultValue": "30"
+      },
+      "colors": {
+        "type": "unknown",
+        "mutable": false,
+        "complexType": {
+          "original": "string[]",
+          "resolved": "string[]",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [],
+          "text": "Array of three elements to specify the color of the arcs."
+        },
+        "defaultValue": "[\r\n        `var(${KupThemeColorValues.SUCCESS})`,\r\n        `var(${KupThemeColorValues.WARNING})`,\r\n        `var(${KupThemeColorValues.DANGER})`,\r\n    ]"
+      },
+      "customStyle": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "string",
+          "resolved": "string",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [{
+              "name": "default",
+              "text": "\"\""
+            }, {
+              "name": "see",
+              "text": "https://ketchup.smeup.com/ketchup-showcase/#/customization"
+            }],
+          "text": "Custom style of the component."
+        },
+        "attribute": "custom-style",
+        "reflect": false,
+        "defaultValue": "''"
+      },
+      "firstThreshold": {
+        "type": "number",
+        "mutable": false,
+        "complexType": {
+          "original": "number",
+          "resolved": "number",
+          "references": {}
+        },
+        "required": false,
+        "optional": true,
+        "docs": {
+          "tags": [],
+          "text": "The first threshold, establishing the length of the first and second arc."
+        },
+        "attribute": "first-threshold",
+        "reflect": false
+      },
+      "labelDistance": {
+        "type": "number",
+        "mutable": true,
+        "complexType": {
+          "original": "number",
+          "resolved": "number",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [],
+          "text": "The distance the label and the value has from the gauge graph."
+        },
+        "attribute": "label-distance",
+        "reflect": false,
+        "defaultValue": "20"
+      },
+      "maxValue": {
+        "type": "number",
+        "mutable": true,
+        "complexType": {
+          "original": "number",
+          "resolved": "number",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [],
+          "text": "The maximum value reachable in the current graph."
+        },
+        "attribute": "max-value",
+        "reflect": false,
+        "defaultValue": "100"
+      },
+      "measurementUnit": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "string",
+          "resolved": "string",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [],
+          "text": "A string which will be appended to the displayed values of the component."
+        },
+        "attribute": "measurement-unit",
+        "reflect": false,
+        "defaultValue": "''"
+      },
+      "minValue": {
+        "type": "number",
+        "mutable": true,
+        "complexType": {
+          "original": "number",
+          "resolved": "number",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [],
+          "text": "The minimum value reachable in the current graph."
+        },
+        "attribute": "min-value",
+        "reflect": false,
+        "defaultValue": "-100"
+      },
+      "needleCircle": {
+        "type": "boolean",
+        "mutable": false,
+        "complexType": {
+          "original": "boolean",
+          "resolved": "boolean",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [],
+          "text": "When true, shows a rounded needle."
+        },
+        "attribute": "needle-circle",
+        "reflect": false,
+        "defaultValue": "false"
+      },
+      "onlyValue": {
+        "type": "boolean",
+        "mutable": false,
+        "complexType": {
+          "original": "boolean",
+          "resolved": "boolean",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [],
+          "text": "When true, ignore thresholds in gauge and show colored value's arc."
+        },
+        "attribute": "only-value",
+        "reflect": false,
+        "defaultValue": "false"
+      },
+      "reverseColors": {
+        "type": "boolean",
+        "mutable": false,
+        "complexType": {
+          "original": "boolean",
+          "resolved": "boolean",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [],
+          "text": "When true, the colors inside the colors array are used in the reversed order."
+        },
+        "attribute": "reverse-colors",
+        "reflect": false,
+        "defaultValue": "false"
+      },
+      "secondThreshold": {
+        "type": "number",
+        "mutable": false,
+        "complexType": {
+          "original": "number",
+          "resolved": "number",
+          "references": {}
+        },
+        "required": false,
+        "optional": true,
+        "docs": {
+          "tags": [],
+          "text": "The second threshold, establishing the length of the second and third arc."
+        },
+        "attribute": "second-threshold",
+        "reflect": false
+      },
+      "showLabels": {
+        "type": "boolean",
+        "mutable": false,
+        "complexType": {
+          "original": "boolean",
+          "resolved": "boolean",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [],
+          "text": "If set to false, threshold values of the gauge are not displayed."
+        },
+        "attribute": "show-labels",
+        "reflect": false,
+        "defaultValue": "true"
+      },
+      "showMaxmin": {
+        "type": "boolean",
+        "mutable": false,
+        "complexType": {
+          "original": "boolean",
+          "resolved": "boolean",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [],
+          "text": "If set to false, the maximum and minimum values of the gauge are not displayed."
+        },
+        "attribute": "show-maxmin",
+        "reflect": false,
+        "defaultValue": "true"
+      },
+      "showValue": {
+        "type": "boolean",
+        "mutable": false,
+        "complexType": {
+          "original": "boolean",
+          "resolved": "boolean",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [],
+          "text": "If set to false, the current value of the gauge is not displayed."
+        },
+        "attribute": "show-value",
+        "reflect": false,
+        "defaultValue": "true"
+      },
+      "size": {
+        "type": "number",
+        "mutable": false,
+        "complexType": {
+          "original": "number",
+          "resolved": "number",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [{
+              "name": "namespace",
+              "text": "kup-gauge.size"
+            }, {
+              "name": "see",
+              "text": "kup-gauge.arcThickness"
+            }],
+          "text": "Con be used change the viewbox of the SVG.\r\nBy manipulating this value, some customizations of the aspect of the gauge is achievable."
+        },
+        "attribute": "size",
+        "reflect": false,
+        "defaultValue": "300"
+      },
+      "value": {
+        "type": "number",
+        "mutable": true,
+        "complexType": {
+          "original": "number",
+          "resolved": "number",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [],
+          "text": "The current value of the gauge.\r\nThe gauge's needle points to the percentage based on this prop."
+        },
+        "attribute": "value",
+        "reflect": false,
+        "defaultValue": "0"
+      },
+      "valueSize": {
+        "type": "number",
+        "mutable": false,
+        "complexType": {
+          "original": "number",
+          "resolved": "number",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [],
+          "text": "The current size of gauge's value.\r\nCorrect values are: 0,1,2 or 3."
+        },
+        "attribute": "value-size",
+        "reflect": false,
+        "defaultValue": "0"
+      },
+      "widthComponent": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "string",
+          "resolved": "string",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [],
+          "text": "Set Width gauge."
+        },
+        "attribute": "width-component",
+        "reflect": false,
+        "defaultValue": "'100%'"
       }
-    },
-    "refresh": {
-      "complexType": {
-        "signature": "() => Promise<void>",
-        "parameters": [],
-        "references": {
-          "Promise": {
-            "location": "global"
-          }
+    };
+  }
+  static get methods() {
+    return {
+      "getProps": {
+        "complexType": {
+          "signature": "(descriptions?: boolean) => Promise<GenericObject>",
+          "parameters": [{
+              "tags": [{
+                  "name": "param",
+                  "text": "descriptions - When provided and true, the result will be the list of props with their description."
+                }],
+              "text": "- When provided and true, the result will be the list of props with their description."
+            }],
+          "references": {
+            "Promise": {
+              "location": "global"
+            },
+            "GenericObject": {
+              "location": "import",
+              "path": "../../types/GenericTypes"
+            }
+          },
+          "return": "Promise<GenericObject>"
         },
-        "return": "Promise<void>"
+        "docs": {
+          "text": "Used to retrieve component's props values.",
+          "tags": [{
+              "name": "param",
+              "text": "descriptions - When provided and true, the result will be the list of props with their description."
+            }, {
+              "name": "returns",
+              "text": "List of props as object, each key will be a prop."
+            }]
+        }
       },
-      "docs": {
-        "text": "This method is used to trigger a new render of the component.",
-        "tags": []
-      }
-    },
-    "setProps": {
-      "complexType": {
-        "signature": "(props: GenericObject) => Promise<void>",
-        "parameters": [{
-            "tags": [{
-                "name": "param",
-                "text": "props - Object containing props that will be set to the component."
-              }],
-            "text": "- Object containing props that will be set to the component."
-          }],
-        "references": {
-          "Promise": {
-            "location": "global"
+      "refresh": {
+        "complexType": {
+          "signature": "() => Promise<void>",
+          "parameters": [],
+          "references": {
+            "Promise": {
+              "location": "global"
+            }
           },
-          "GenericObject": {
-            "location": "import",
-            "path": "../../types/GenericTypes"
-          }
+          "return": "Promise<void>"
         },
-        "return": "Promise<void>"
+        "docs": {
+          "text": "This method is used to trigger a new render of the component.",
+          "tags": []
+        }
       },
-      "docs": {
-        "text": "Sets the props to the component.",
-        "tags": [{
-            "name": "param",
-            "text": "props - Object containing props that will be set to the component."
-          }]
+      "setProps": {
+        "complexType": {
+          "signature": "(props: GenericObject) => Promise<void>",
+          "parameters": [{
+              "tags": [{
+                  "name": "param",
+                  "text": "props - Object containing props that will be set to the component."
+                }],
+              "text": "- Object containing props that will be set to the component."
+            }],
+          "references": {
+            "Promise": {
+              "location": "global"
+            },
+            "GenericObject": {
+              "location": "import",
+              "path": "../../types/GenericTypes"
+            }
+          },
+          "return": "Promise<void>"
+        },
+        "docs": {
+          "text": "Sets the props to the component.",
+          "tags": [{
+              "name": "param",
+              "text": "props - Object containing props that will be set to the component."
+            }]
+        }
       }
-    }
-  }; }
+    };
+  }
   static get elementRef() { return "rootElement"; }
 }