@esrf/daiquiri-lib 5.1.0 → 5.1.1

package/dist/index.d.ts

@@ -2294,21 +2294,33 @@ declare function HardwareState(props: {
 }): react_jsx_runtime.JSX.Element;
 
 interface StateComparator {
+    /** The state comparator */
     comparator: string;
+    /** The state value to compare */
     comparison: string;
+    /** Optionally, a color for this comparison */
     color?: string;
 }
 interface SynopticElementType {
+    /** The svg element class name */
     name: string;
+    /** Which property to use as the value, i.e. `s1b.position` */
     value?: string;
+    /** How many digits to display */
     value_display_digits?: number;
+    /** Optionally, Which property to use to display the state. If left blank, the aggregated state from each element in `ids` below will be used */
     state?: string;
+    /** Optionally, a comparison, can be a single comparison for red/green or a list of comparisons with colors */
     state_comparison?: StateComparator | StateComparator[];
+    /** A list of hardware object ids to display on click */
     ids?: string[];
 }
 interface SynopticType {
+    /** A list of elements to be mapped to their classes in the svg */
     elements: SynopticElementType[];
+    /** The synoptic file to load */
     synoptic: string;
+    /** Whether to enable daiquiri `colorisation` of icons */
     color_icons: boolean;
 }
 interface Props$2 {