@openremote/or-gauge 1.8.0-snapshot.20250725074716 → 1.8.0-snapshot.20250725120001

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,121 +1,121 @@
1
- declare module 'gaugeJS' {
2
-
3
- interface PointerOptions {
4
- length: number;
5
- strokeWidth: number;
6
- color: string;
7
- }
8
- interface BaseOptions {
9
- angle: number;
10
- lineWidth: number;
11
- radiusScale: number;
12
- pointer: PointerOptions;
13
- limitMax: boolean;
14
- limitMin: boolean;
15
- colorStart: string;
16
- colorStop: string;
17
- strokeColor: string;
18
- generateGradient: boolean;
19
- highDpiSupport: boolean;
20
- }
21
-
22
- interface StaticZoneOptions {
23
- strokeStyle: string;
24
- min: number;
25
- max: number;
26
- }
27
-
28
- export interface GaugeOptions extends BaseOptions {
29
- percentColors?: Array<[number, string]> | undefined;
30
- staticLabels?: {
31
- font: string;
32
- labels: number[];
33
- color?: string | undefined;
34
- fractionDigits?: number | undefined;
35
- } | undefined;
36
- staticZones?: StaticZoneOptions[] | Array<StaticZoneOptions & { height: number; }> | undefined;
37
- renderTicks?: {
38
- divisions: number;
39
- divWidth: number;
40
- divLength: number;
41
- divColor: string;
42
- subDivisions: number;
43
- subWidth: number;
44
- subLength: number;
45
- subColor: string;
46
- } | undefined;
47
- pointer: PointerOptions & {
48
- iconPath?: string | undefined;
49
- iconScale?: number | undefined;
50
- iconAngle?: number | undefined;
51
- };
52
- }
53
- export interface TextRendererElement {
54
- innerHTML: string;
55
- style: {
56
- fontSize: string;
57
- };
58
- }
59
-
60
- export class TextRenderer {
61
- constructor(element: TextRendererElement, fractionalDigits: number);
62
-
63
- private render(gauge: Gauge): string;
64
- }
65
-
66
- export class ValueUpdater {
67
- /**
68
- * The animation speed of the gauge pointer (default is 32)
69
- */
70
- animationSpeed: number;
71
-
72
- constructor(addToAnimationQueue?: boolean | null, clear?: boolean | null);
73
-
74
- update(force?: boolean | null): boolean;
75
- }
76
-
77
- export class BaseGauge extends ValueUpdater {
78
- /**
79
- * ?
80
- * @param textField
81
- */
82
- setTextField(textField: TextRenderer | TextRendererElement): TextRenderer;
83
-
84
- /**
85
- * Sets the minimum gauge value (prefer over gauge.minValue)
86
- * @param minValue
87
- */
88
- setMinValue(minValue: number): number[] | undefined;
89
-
90
- /**
91
- * Configure the gauge renderer with the given options.
92
- * @param options The configuration options for the gauge.
93
- */
94
- setOptions(options?: GaugeOptions | null): this;
95
- }
96
-
97
- export class Gauge extends BaseGauge {
98
- /**
99
- * The max gauge value.
100
- */
101
- maxValue: number;
102
-
103
- /**
104
- * Creates a new gauge renderer for the given canvas element.
105
- * @param canvas The canvas element to render to.
106
- */
107
- constructor(canvas: HTMLCanvasElement);
108
-
109
- /**
110
- * Configure the gauge renderer with the given options.
111
- * @param options The configuration options for the gauge.
112
- */
113
- setOptions(options?: GaugeOptions | null): this;
114
-
115
- /**
116
- * Sets the current value of the gauge pointer.
117
- * @param value
118
- */
119
- set(value: number): boolean;
120
- }
121
- }
1
+ declare module 'gaugeJS' {
2
+
3
+ interface PointerOptions {
4
+ length: number;
5
+ strokeWidth: number;
6
+ color: string;
7
+ }
8
+ interface BaseOptions {
9
+ angle: number;
10
+ lineWidth: number;
11
+ radiusScale: number;
12
+ pointer: PointerOptions;
13
+ limitMax: boolean;
14
+ limitMin: boolean;
15
+ colorStart: string;
16
+ colorStop: string;
17
+ strokeColor: string;
18
+ generateGradient: boolean;
19
+ highDpiSupport: boolean;
20
+ }
21
+
22
+ interface StaticZoneOptions {
23
+ strokeStyle: string;
24
+ min: number;
25
+ max: number;
26
+ }
27
+
28
+ export interface GaugeOptions extends BaseOptions {
29
+ percentColors?: Array<[number, string]> | undefined;
30
+ staticLabels?: {
31
+ font: string;
32
+ labels: number[];
33
+ color?: string | undefined;
34
+ fractionDigits?: number | undefined;
35
+ } | undefined;
36
+ staticZones?: StaticZoneOptions[] | Array<StaticZoneOptions & { height: number; }> | undefined;
37
+ renderTicks?: {
38
+ divisions: number;
39
+ divWidth: number;
40
+ divLength: number;
41
+ divColor: string;
42
+ subDivisions: number;
43
+ subWidth: number;
44
+ subLength: number;
45
+ subColor: string;
46
+ } | undefined;
47
+ pointer: PointerOptions & {
48
+ iconPath?: string | undefined;
49
+ iconScale?: number | undefined;
50
+ iconAngle?: number | undefined;
51
+ };
52
+ }
53
+ export interface TextRendererElement {
54
+ innerHTML: string;
55
+ style: {
56
+ fontSize: string;
57
+ };
58
+ }
59
+
60
+ export class TextRenderer {
61
+ constructor(element: TextRendererElement, fractionalDigits: number);
62
+
63
+ private render(gauge: Gauge): string;
64
+ }
65
+
66
+ export class ValueUpdater {
67
+ /**
68
+ * The animation speed of the gauge pointer (default is 32)
69
+ */
70
+ animationSpeed: number;
71
+
72
+ constructor(addToAnimationQueue?: boolean | null, clear?: boolean | null);
73
+
74
+ update(force?: boolean | null): boolean;
75
+ }
76
+
77
+ export class BaseGauge extends ValueUpdater {
78
+ /**
79
+ * ?
80
+ * @param textField
81
+ */
82
+ setTextField(textField: TextRenderer | TextRendererElement): TextRenderer;
83
+
84
+ /**
85
+ * Sets the minimum gauge value (prefer over gauge.minValue)
86
+ * @param minValue
87
+ */
88
+ setMinValue(minValue: number): number[] | undefined;
89
+
90
+ /**
91
+ * Configure the gauge renderer with the given options.
92
+ * @param options The configuration options for the gauge.
93
+ */
94
+ setOptions(options?: GaugeOptions | null): this;
95
+ }
96
+
97
+ export class Gauge extends BaseGauge {
98
+ /**
99
+ * The max gauge value.
100
+ */
101
+ maxValue: number;
102
+
103
+ /**
104
+ * Creates a new gauge renderer for the given canvas element.
105
+ * @param canvas The canvas element to render to.
106
+ */
107
+ constructor(canvas: HTMLCanvasElement);
108
+
109
+ /**
110
+ * Configure the gauge renderer with the given options.
111
+ * @param options The configuration options for the gauge.
112
+ */
113
+ setOptions(options?: GaugeOptions | null): this;
114
+
115
+ /**
116
+ * Sets the current value of the gauge pointer.
117
+ * @param value
118
+ */
119
+ set(value: number): boolean;
120
+ }
121
+ }
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- or-gauge is a component that is currently in development.<br />
2
- The basics are implemented, but no data support yet.
3
-
4
- Documentation coming soon.
1
+ or-gauge is a component that is currently in development.<br />
2
+ The basics are implemented, but no data support yet.
3
+
4
+ Documentation coming soon.