@overvis/hmi-workspace-ui 0.0.0-stage → 0.1.0

package/dist/src/workspace/graphics/bindings.d.ts

@@ -0,0 +1,847 @@
+import { type GraphicsParameterSetup } from "./symbols/bindings.js";
+import type { GraphicsSymbolDefinition } from "./symbols/definition.js";
+import type { GraphicsSymbolPropertyState } from "./symbols/viewport.js";
+import type { AppLocale } from "@overvis/hmi-shared";
+import { type GraphicsDocument, type GraphicsElement, type GraphicsConnector } from "@overvis/hmi-shared/graphics";
+import type { ParameterValueState } from "../parameters/live/model.js";
+import { type GraphicsQuality } from "./binding-value.js";
+/** Include the group readings responsible for an inherited quality badge. */
+export declare function graphicsDiagnosticParameterIds(item: GraphicsElement | GraphicsConnector, document: GraphicsDocument): string[];
+export declare function resolveGraphicsPresentation(item: Pick<GraphicsElement, "appearance" | "bindings"> & {
+    width?: number;
+    height?: number;
+    rotation?: number;
+}, document: GraphicsDocument, states: ReadonlyMap<string, ParameterValueState>, locale: AppLocale): {
+    appearance: {
+        fill: string;
+        stroke: string;
+        strokeWidth: number;
+        opacity: number;
+        text: string | Record<string, string>;
+        fontSize: number;
+        fillLevel: number;
+        visible: boolean;
+        animated: boolean;
+    };
+    width: number;
+    height: number;
+    rotation: number;
+    quality: GraphicsQuality;
+};
+/** Resolve child values before transforming groups, so parent scale and rotation affect artwork. */
+export declare function resolveGraphicsScene(document: GraphicsDocument, states: ReadonlyMap<string, ParameterValueState>, locale: AppLocale, parameters?: GraphicsParameterSetup, definitions?: ReadonlyMap<string, GraphicsSymbolDefinition>): {
+    document: {
+        version: 2;
+        title: string | Record<string, string>;
+        background: string;
+        grid: number;
+        viewBox?: {
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        };
+        elements: ({
+            id: string;
+            name: string;
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+            rotation: number;
+            parentId: string | null;
+            locked: boolean;
+            layer?: number;
+            appearance: {
+                fill: string;
+                stroke: string;
+                strokeWidth: number;
+                opacity: number;
+                text: string | Record<string, string>;
+                fontSize: number;
+                fillLevel: number;
+                visible: boolean;
+                animated: boolean;
+            };
+            bindings: ({
+                property: "text";
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                kind: "format";
+                digits: number;
+                prefix: string | Record<string, string>;
+                suffix: string | Record<string, string>;
+            } | {
+                property: "fillLevel" | "height" | "opacity" | "rotation" | "width";
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                kind: "scale";
+                inputMin: number;
+                inputMax: number;
+                outputMin: number;
+                outputMax: number;
+            } | {
+                property: "fill" | "stroke";
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                kind: "thresholds";
+                fallback: string;
+                stops: {
+                    atLeast: number;
+                    color: string;
+                }[];
+            } | {
+                operator: "eq" | "gt" | "gte" | "lt" | "lte" | "ne";
+                value: number;
+                property: "animated" | "visible";
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                kind: "condition";
+            })[];
+            action: {
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                confirm: boolean;
+                kind: "command";
+                value: string;
+                label: string | Record<string, string>;
+            } | {
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                confirm: boolean;
+                kind: "toggle";
+                status: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                onValue: string;
+                offValue: string;
+                onLabel: string | Record<string, string>;
+                offLabel: string | Record<string, string>;
+            } | {
+                kind: "parameter";
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                mode: "details" | "history" | "write";
+            } | {
+                path?: string;
+                search?: string;
+                hash?: string;
+                kind: "dashboard";
+                dashboardId: string;
+            } | null;
+            kind: "symbol";
+            symbolId: string;
+            mirrorX?: boolean;
+            mirrorY?: boolean;
+            properties: Record<string, string | number | boolean | Record<string, string>>;
+            propertyBindings: ({
+                property: string;
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                kind: "value";
+                digits?: number;
+            } | {
+                property: string;
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                kind: "states";
+                states: {
+                    value: number | boolean;
+                    state: string;
+                }[];
+            } | {
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                kind: "format";
+                digits: number;
+                prefix: string | Record<string, string>;
+                suffix: string | Record<string, string>;
+                property: string;
+            } | {
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                kind: "scale";
+                inputMin: number;
+                inputMax: number;
+                outputMin: number;
+                outputMax: number;
+                property: string;
+            } | {
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                kind: "thresholds";
+                fallback: string;
+                stops: {
+                    atLeast: number;
+                    color: string;
+                }[];
+                property: string;
+            } | {
+                operator: "eq" | "gt" | "gte" | "lt" | "lte" | "ne";
+                value: number;
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                kind: "condition";
+                property: string;
+            })[];
+            actions?: Record<string, {
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                confirm: boolean;
+                kind: "command";
+                value: string;
+                label: string | Record<string, string>;
+            } | {
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                confirm: boolean;
+                kind: "toggle";
+                status: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                onValue: string;
+                offValue: string;
+                onLabel: string | Record<string, string>;
+                offLabel: string | Record<string, string>;
+            } | {
+                kind: "parameter";
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                mode: "details" | "history" | "write";
+            } | {
+                path?: string;
+                search?: string;
+                hash?: string;
+                kind: "dashboard";
+                dashboardId: string;
+            }>;
+        } | {
+            id: string;
+            name: string;
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+            rotation: number;
+            parentId: string | null;
+            locked: boolean;
+            layer?: number;
+            appearance: {
+                fill: string;
+                stroke: string;
+                strokeWidth: number;
+                opacity: number;
+                text: string | Record<string, string>;
+                fontSize: number;
+                fillLevel: number;
+                visible: boolean;
+                animated: boolean;
+            };
+            bindings: ({
+                property: "text";
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                kind: "format";
+                digits: number;
+                prefix: string | Record<string, string>;
+                suffix: string | Record<string, string>;
+            } | {
+                property: "fillLevel" | "height" | "opacity" | "rotation" | "width";
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                kind: "scale";
+                inputMin: number;
+                inputMax: number;
+                outputMin: number;
+                outputMax: number;
+            } | {
+                property: "fill" | "stroke";
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                kind: "thresholds";
+                fallback: string;
+                stops: {
+                    atLeast: number;
+                    color: string;
+                }[];
+            } | {
+                operator: "eq" | "gt" | "gte" | "lt" | "lte" | "ne";
+                value: number;
+                property: "animated" | "visible";
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                kind: "condition";
+            })[];
+            action: {
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                confirm: boolean;
+                kind: "command";
+                value: string;
+                label: string | Record<string, string>;
+            } | {
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                confirm: boolean;
+                kind: "toggle";
+                status: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                onValue: string;
+                offValue: string;
+                onLabel: string | Record<string, string>;
+                offLabel: string | Record<string, string>;
+            } | {
+                kind: "parameter";
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                mode: "details" | "history" | "write";
+            } | {
+                path?: string;
+                search?: string;
+                hash?: string;
+                kind: "dashboard";
+                dashboardId: string;
+            } | null;
+            kind: "ellipse" | "group" | "junction" | "rectangle" | "rounded-rectangle" | "text";
+        } | {
+            id: string;
+            name: string;
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+            rotation: number;
+            parentId: string | null;
+            locked: boolean;
+            layer?: number;
+            appearance: {
+                fill: string;
+                stroke: string;
+                strokeWidth: number;
+                opacity: number;
+                text: string | Record<string, string>;
+                fontSize: number;
+                fillLevel: number;
+                visible: boolean;
+                animated: boolean;
+            };
+            bindings: ({
+                property: "text";
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                kind: "format";
+                digits: number;
+                prefix: string | Record<string, string>;
+                suffix: string | Record<string, string>;
+            } | {
+                property: "fillLevel" | "height" | "opacity" | "rotation" | "width";
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                kind: "scale";
+                inputMin: number;
+                inputMax: number;
+                outputMin: number;
+                outputMax: number;
+            } | {
+                property: "fill" | "stroke";
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                kind: "thresholds";
+                fallback: string;
+                stops: {
+                    atLeast: number;
+                    color: string;
+                }[];
+            } | {
+                operator: "eq" | "gt" | "gte" | "lt" | "lte" | "ne";
+                value: number;
+                property: "animated" | "visible";
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                kind: "condition";
+            })[];
+            action: {
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                confirm: boolean;
+                kind: "command";
+                value: string;
+                label: string | Record<string, string>;
+            } | {
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                confirm: boolean;
+                kind: "toggle";
+                status: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                onValue: string;
+                offValue: string;
+                onLabel: string | Record<string, string>;
+                offLabel: string | Record<string, string>;
+            } | {
+                kind: "parameter";
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                mode: "details" | "history" | "write";
+            } | {
+                path?: string;
+                search?: string;
+                hash?: string;
+                kind: "dashboard";
+                dashboardId: string;
+            } | null;
+            kind: "polygon";
+            points: {
+                x: number;
+                y: number;
+            }[];
+        } | {
+            id: string;
+            name: string;
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+            rotation: number;
+            parentId: string | null;
+            locked: boolean;
+            layer?: number;
+            appearance: {
+                fill: string;
+                stroke: string;
+                strokeWidth: number;
+                opacity: number;
+                text: string | Record<string, string>;
+                fontSize: number;
+                fillLevel: number;
+                visible: boolean;
+                animated: boolean;
+            };
+            bindings: ({
+                property: "text";
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                kind: "format";
+                digits: number;
+                prefix: string | Record<string, string>;
+                suffix: string | Record<string, string>;
+            } | {
+                property: "fillLevel" | "height" | "opacity" | "rotation" | "width";
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                kind: "scale";
+                inputMin: number;
+                inputMax: number;
+                outputMin: number;
+                outputMax: number;
+            } | {
+                property: "fill" | "stroke";
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                kind: "thresholds";
+                fallback: string;
+                stops: {
+                    atLeast: number;
+                    color: string;
+                }[];
+            } | {
+                operator: "eq" | "gt" | "gte" | "lt" | "lte" | "ne";
+                value: number;
+                property: "animated" | "visible";
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                kind: "condition";
+            })[];
+            action: {
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                confirm: boolean;
+                kind: "command";
+                value: string;
+                label: string | Record<string, string>;
+            } | {
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                confirm: boolean;
+                kind: "toggle";
+                status: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                onValue: string;
+                offValue: string;
+                onLabel: string | Record<string, string>;
+                offLabel: string | Record<string, string>;
+            } | {
+                kind: "parameter";
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                mode: "details" | "history" | "write";
+            } | {
+                path?: string;
+                search?: string;
+                hash?: string;
+                kind: "dashboard";
+                dashboardId: string;
+            } | null;
+            kind: "image";
+            assetId: string;
+        })[];
+        connectors: {
+            id: string;
+            name: string;
+            layer?: number;
+            parentId?: string | null;
+            locked?: boolean;
+            from: {
+                elementId: string;
+                port: string;
+            } | {
+                x: number;
+                y: number;
+            };
+            to: {
+                elementId: string;
+                port: string;
+            } | {
+                x: number;
+                y: number;
+            };
+            route: "curve" | "orthogonal" | "straight";
+            bends: {
+                x: number;
+                y: number;
+            }[];
+            arrow: boolean;
+            appearance: {
+                fill: string;
+                stroke: string;
+                strokeWidth: number;
+                opacity: number;
+                text: string | Record<string, string>;
+                fontSize: number;
+                fillLevel: number;
+                visible: boolean;
+                animated: boolean;
+            };
+            bindings: ({
+                property: "text";
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                kind: "format";
+                digits: number;
+                prefix: string | Record<string, string>;
+                suffix: string | Record<string, string>;
+            } | {
+                property: "fillLevel" | "height" | "opacity" | "rotation" | "width";
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                kind: "scale";
+                inputMin: number;
+                inputMax: number;
+                outputMin: number;
+                outputMax: number;
+            } | {
+                property: "fill" | "stroke";
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                kind: "thresholds";
+                fallback: string;
+                stops: {
+                    atLeast: number;
+                    color: string;
+                }[];
+            } | {
+                operator: "eq" | "gt" | "gte" | "lt" | "lte" | "ne";
+                value: number;
+                property: "animated" | "visible";
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                kind: "condition";
+            })[];
+            action: {
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                confirm: boolean;
+                kind: "command";
+                value: string;
+                label: string | Record<string, string>;
+            } | {
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                confirm: boolean;
+                kind: "toggle";
+                status: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                onValue: string;
+                offValue: string;
+                onLabel: string | Record<string, string>;
+                offLabel: string | Record<string, string>;
+            } | {
+                kind: "parameter";
+                source: {
+                    kind: "parameter";
+                    parameterId: string;
+                } | {
+                    kind: "slot";
+                    slotId: string;
+                };
+                mode: "details" | "history" | "write";
+            } | {
+                path?: string;
+                search?: string;
+                hash?: string;
+                kind: "dashboard";
+                dashboardId: string;
+            } | null;
+        }[];
+        slots: {
+            id: string;
+            name: string;
+            parameterId: string | null;
+        }[];
+    };
+    qualities: Map<string, GraphicsQuality>;
+    symbolBindings: Map<string, Readonly<Record<string, GraphicsSymbolPropertyState>>>;
+};