@record-evolution/widget-gauge 1.5.21 → 1.5.22

package/package.json

@@ -3,7 +3,7 @@
     "description": "REWidget widget-gauge",
     "license": "MIT",
     "author": "widget-gauge",
-    "version": "1.5.21",
+    "version": "1.5.22",
     "type": "module",
     "main": "dist/widget-gauge.js",
     "types": "dist/src/widget-gauge.d.ts",
@@ -16,6 +16,7 @@
         "start": "tsc && concurrently -k -r \"tsc --watch --preserveWatchOutput\" \"wds\"",
         "build": "rollup -c rollup.config.js --bundleConfigAsCjs",
         "watch": "rollup -w -c rollup.config.js --bundleConfigAsCjs",
+        "types": "cat src/definition-schema.json | json2ts > src/definition-schema.d.ts",
         "start:build": "npm run build && es-dev-server --root-dir dist --app-index index.html --compatibility none --open",
         "lint": "eslint --ext .ts,.html . --ignore-path .gitignore && prettier \"**/*.ts\" --check --ignore-path .gitignore",
         "format": "eslint --ext .ts,.html . --fix --ignore-path .gitignore && prettier \"**/*.ts\" --write --ignore-path .gitignore",
@@ -41,6 +42,7 @@
         "eslint": "^8.53.0",
         "eslint-config-prettier": "^9.0.0",
         "husky": "^8.0.3",
+        "json-schema-to-typescript": "^13.1.1",
         "lint-staged": "^15.0.2",
         "prettier": "^3.0.3",
         "rimraf": "^5.0.5",

package/src/default-data.json

@@ -1,29 +1,30 @@
 {
-  "settings": {
-
-  },
-  "dataseries": [{
-    "label": "Demo Gauge Temperature",
-    "unit": "°C",
-    "valueColor": "black",
-    "sections": [-20, 80, 90, 120],
-    "backgroundColors": [
-      "#AAC8A7",
-      "#F1C27B",
-      "#FF9B9B"
-    ],
-    "averageLatest": 1,
-    "data": [{
-      "value": 90,
-      "pivot": "Frankfurt"
-    }]
-  },{
-    "label": "Demo Gauge Pascal",
-    "unit": "Pa",
-    "valueColor": "green",
-    "averageLatest": 1,
-    "data": [{
-      "value": 79
-    }]
-  }]
-}
+    "settings": {},
+    "dataseries": [
+        {
+            "label": "Demo Gauge Temperature",
+            "unit": "°C",
+            "valueColor": "black",
+            "sections": [-20, 80, 90, 120],
+            "backgroundColors": ["#AAC8A7", "#F1C27B", "#FF9B9B"],
+            "averageLatest": 1,
+            "data": [
+                {
+                    "value": 90,
+                    "pivot": "Frankfurt"
+                }
+            ]
+        },
+        {
+            "label": "Demo Gauge Pascal",
+            "unit": "Pa",
+            "valueColor": "green",
+            "averageLatest": 1,
+            "data": [
+                {
+                    "value": 79
+                }
+            ]
+        }
+    ]
+}

package/src/definition-schema.d.ts

@@ -0,0 +1,65 @@
+/* eslint-disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export type Title = string;
+export type Subtitle = string;
+export type Label = string;
+/**
+ * The unit of the values. e.g. °C or km/h
+ */
+export type Unit = string;
+/**
+ * The amount of gauge sections. Starting from the min value, ending with the max value.
+ */
+export type Sections = number[];
+/**
+ * Background color for each section. This Array is one shorter than the number of sections.
+ */
+export type SectionBackgroundColors = {
+  [k: string]: unknown;
+}[];
+/**
+ * Calculate the average over the given number of newest values. (If pivoted, then per each of the pivot dataseries.) If not specified then the latest value is shown without modification.
+ */
+export type AverageLatestValues = number;
+export type Value = number;
+/**
+ * You can specify a column in the input data to autogenerate dataseries for each distinct entry in this column. E.g. if you have a table with columns [city, timestamp, temperature] and specify ''city'' as pivot column, then you will get a gauge for each city.
+ */
+export type PivotColumn = string;
+/**
+ * The data used to draw this data series.
+ */
+export type Data = {
+  value: Value;
+  pivot?: PivotColumn;
+  [k: string]: unknown;
+}[];
+export type Gauges = {
+  label: Label;
+  valueColor?: ValueColor;
+  unit?: Unit;
+  sections?: Sections;
+  backgroundColors?: SectionBackgroundColors;
+  averageLatest?: AverageLatestValues;
+  data?: Data;
+  [k: string]: unknown;
+}[];
+
+export interface GaugeChartConfiguration {
+  settings?: GlobalSettings;
+  dataseries?: Gauges;
+  [k: string]: unknown;
+}
+export interface GlobalSettings {
+  title?: Title;
+  subTitle?: Subtitle;
+  [k: string]: unknown;
+}
+export interface ValueColor {
+  [k: string]: unknown;
+}

package/src/definition-schema.json

@@ -25,6 +25,7 @@
             "order": 2,
             "items": {
                 "type": "object",
+                "required": ["label"],
                 "properties": {
                     "label": {
                         "title": "Label",
@@ -49,7 +50,7 @@
                         "type": "array",
                         "order": 4,
                         "items": {
-                            "type": "string"
+                            "type": "number"
                         }
                     },
                     "backgroundColors": {
@@ -75,6 +76,7 @@
                         "buffersize": 1000,
                         "items": {
                             "type": "object",
+                            "required": ["value"],
                             "properties": {
                                 "value": {
                                     "title": "Value",
@@ -95,4 +97,4 @@
             }
         }
     }
-}
+}

package/src/types.ts

@@ -2,7 +2,7 @@ export interface Settings {
     title: string
     subTitle: string
     columnLayout: boolean
-  }
+}
 
 export interface Data {
     value: number
@@ -17,7 +17,7 @@ export interface Dataseries {
     backgroundColors: string[]
     data: Data[]
     // not input values
-    needleValue: number 
+    needleValue: number
     range: number
     ranges: number[]
 }
@@ -25,4 +25,4 @@ export interface Dataseries {
 export interface InputData {
     settings: Settings
     dataseries: Dataseries[]
-}
+}