Skip to content

Commit 5202561

Browse files
committed
document visibility
1 parent f16ebec commit 5202561

File tree

3 files changed

+29
-5
lines changed

3 files changed

+29
-5
lines changed

docs/nodes/layouts.md

+5
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ changed.
3434
| background | Color | A fill color behind the entirety of all children |
3535
| border-color | Color | The color of the group's border surrounding the children widgets |
3636
| border-width | Number | The thickness of the group's border in pixels |
37+
| visibility | String | A pv that determines the visibility of the layout, visibility is turned off if the PV's value is zero. This logic is inverted if the !Not tag is used instead of String |
3738

3839

3940
* **Example**
@@ -90,6 +91,7 @@ You may also use the alias "flow" to reference the vflow node.
9091
| background | Color | A fill color behind the entirety of all children |
9192
| border-color | Color | The color of the group's border surrounding the children widgets |
9293
| border-width | Number | The thickness of the group's border in pixels |
94+
| visibility | String | A pv that determines the visibility of the layout, visibility is turned off if the PV's value is zero. This logic is inverted if the !Not tag is used instead of String |
9395

9496

9597
* **Example**
@@ -155,6 +157,7 @@ mentioned above will also be included.
155157
| background | Color | A fill color behind the entirety of each template copy |
156158
| border-color | Color | The color of the group's border surrounding each template copy |
157159
| border-width | Number | The thickness of the group's border in pixels |
160+
| visibility | String | A pv that determines the visibility of the layout, visibility is turned off if the PV's value is zero. This logic is inverted if the !Not tag is used instead of String |
158161

159162

160163
* **Example**
@@ -220,6 +223,7 @@ You may also use the alias "repeat" to reference the vrepeat node.
220223
| background | Color | A fill color behind the entirety of each template copy |
221224
| border-color | Color | The color of the group's border surrounding each template copy |
222225
| border-width | Number | The thickness of the group's border in pixels |
226+
| visibility | String | A pv that determines the visibility of the layout, visibility is turned off if the PV's value is zero. This logic is inverted if the !Not tag is used instead of String |
223227

224228

225229
* **Example**
@@ -308,6 +312,7 @@ elements a user provides.
308312
| border-color | Color | The color of the group's border surrounding each template copy |
309313
| border-width | Number | The thickness of the group's border in pixels |
310314
| horizontal | Bool | Fill direction of the layout. Macros will be mapped to widgets across columns first, then proceed to the next row, rather than the reverse. True by default |
315+
| visibility | String | A pv that determines the visibility of the layout, visibility is turned off if the PV's value is zero. This logic is inverted if the !Not tag is used instead of String |
311316

312317

313318
* **Example**

docs/nodes/logic.md

+2
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,8 @@ the resulting UI screen. Otherwise, none of the children widgets are included.
8989
| background | Color | A fill color behind the entirety of all children |
9090
| border-color | Color | The color of the group's border surrounding the children widgets |
9191
| border-width | Number | The thickness of the group's border in pixels |
92+
| visibility | String | A pv that determines the visibility of the layout, visibility is turned off if the PV's value is zero. This logic is inverted if the !Not tag is used instead of String |
93+
9294

9395
* **Example**
9496

docs/nodes/widgets.md

+22-5
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,9 @@ nav_order: 1
2020

2121
The list of recognized CSS Widgets is as follows: "ActionButton", "Array", "BooleanButton",
2222
"CheckBox", "ComboBox", "DataBrowser", "EmbeddedDisplay", "FileSelector", "LEDMultiState",
23-
"Label", "Meter", "NavigationTabs", "Picture", "Polyline", "ProgressBar", "RadioButton",
24-
"ScaledSlider", "Scrollbar", "SlideButton", "Spinner", "StripChart", "Symbol", "Table",
25-
"Tabs", "Tank", "TextEntry", "TextSymbol", "TextUpdate", "Thermometer", "ThreeDViewer",
26-
"WebBrowser", and "XYPlot".
23+
"Label", "Meter", "NavigationTabs", "Picture", "ProgressBar", "RadioButton", "ScaledSlider",
24+
"Scrollbar", "SlideButton", "Spinner", "StripChart", "Symbol", "Table", "Tabs", "Tank",
25+
"TextSymbol", "TextUpdate", "Thermometer", "ThreeDViewer", "WebBrowser", and "XYPlot".
2726

2827
Attributes are set using the name of the function used by phoebusgen. For example, a label's `Auto Size`
2928
field in CSS-Phoebus would be set with the `auto_size` attribute in Gestalt.
@@ -106,6 +105,7 @@ direction.
106105
| border-width | Number | Thickness of widget outline, 2 by default |
107106
| start-angle | Number | Angle of the starting ray of the arc, 0 by default |
108107
| span | Number | Degrees that the arc covers, 90 by default |
108+
| visibility | String | A pv that determines the visibility of the widget, visibility is turned off if the PV's value is zero. This logic is inverted if the !Not tag is used instead of String |
109109
110110
111111
* **Example**
@@ -137,6 +137,7 @@ A widget displaying the individual bits of a pv value
137137
| off-color | Color | The display color for a bit being 0, $3C643C by default |
138138
| on-color | Color | The display color for a bit being 1, $00FF00 by default |
139139
| horizontal | Bool | Whether to arrange the display horizontally, defaults to True |
140+
| visibility | String | A pv that determines the visibility of the widget, visibility is turned off if the PV's value is zero. This logic is inverted if the !Not tag is used instead of String |
140141
141142
142143
* **Example**
@@ -166,7 +167,8 @@ A widget representing a set of buttons that gets its options from an enumerable
166167
| selected | Color | Selected item color, defaults to background color |
167168
| font | Font | Widget display font |
168169
| pv | String | The PV containing the enumerable value |
169-
| horizontal | Bool | Whether to arrange the buttons horizontally, defaults to False |
170+
| horizontal | Bool | Whether to arrange the buttons horizontally, defaults to True |
171+
| visibility | String | A pv that determines the visibility of the widget, visibility is turned off if the PV's value is zero. This logic is inverted if the !Not tag is used instead of String |
170172
171173
172174
* **Example**
@@ -195,6 +197,7 @@ A basic ellipse shape that can either be filled or an outline
195197
| background | Color | Widget interior color, transparent by default |
196198
| border-color | Color | Widget outline color, $000000 by default |
197199
| border-width | Number | Thickness of widget outline, 2 by default |
200+
| visibility | String | A pv that determines the visibility of the widget, visibility is turned off if the PV's value is zero. This logic is inverted if the !Not tag is used instead of String |
198201
199202
200203
* **Example**
@@ -244,6 +247,7 @@ A widget that displays a given image file
244247
|------------|--------|------------|
245248
| geometry | Rect | A rectangle describing the position and dimensions of the widget |
246249
| file | String | The filepath of the image to display |
250+
| visibility | String | A pv that determines the visibility of the widget, visibility is turned off if the PV's value is zero. This logic is inverted if the !Not tag is used instead of String |
247251
248252
249253
* **Example**
@@ -275,6 +279,7 @@ true, false, or undefined based upon a match with values given by the widget.
275279
| undefined-color | Color | The display color for any other value, $A0A0A4 by default |
276280
| border-color | Color | Widget border color, $000000 by default |
277281
| pv | String | The PV to read data from |
282+
| visibility | String | A pv that determines the visibility of the widget, visibility is turned off if the PV's value is zero. This logic is inverted if the !Not tag is used instead of String |
278283
279284
280285
* **Example**
@@ -304,6 +309,7 @@ A widget representing a menu that gets its options from an enumerable pv
304309
| background | Color | Widget background color |
305310
| font | Font | Widget display font |
306311
| pv | String | The PV containing the enumerable value |
312+
| visibility | String | A pv that determines the visibility of the widget, visibility is turned off if the PV's value is zero. This logic is inverted if the !Not tag is used instead of String |
307313
308314
309315
* **Example**
@@ -334,6 +340,8 @@ A widget representing a button that writes a value to a pv when pressed
334340
| font | Font | Widget display font |
335341
| pv | String | The PV that will be written to |
336342
| value | String | The value to write to the PV |
343+
| visibility | String | A pv that determines the visibility of the widget, visibility is turned off if the PV's value is zero. This logic is inverted if the !Not tag is used instead of String |
344+
337345
338346
* **Example**
339347
@@ -367,6 +375,7 @@ A closed shape consisting of a set of points that can either be filled or an out
367375
| border-color | Color | Widget outline color, $000000 by default |
368376
| border-width | Number | Thickness of widget outline, 2 by default |
369377
| points | List | A list of Rect's representing the vertices of the polygon |
378+
| visibility | String | A pv that determines the visibility of the widget, visibility is turned off if the PV's value is zero. This logic is inverted if the !Not tag is used instead of String |
370379
371380
372381
* **Example**
@@ -395,6 +404,7 @@ A set of contiguous line segments
395404
| border-color | Color | Widget line color, $000000 by default |
396405
| border-width | Number | Thickness of widget outline, 2 by default |
397406
| points | List | A list of Rect's representing the contiguous points of the polyline |
407+
| visibility | String | A pv that determines the visibility of the widget, visibility is turned off if the PV's value is zero. This logic is inverted if the !Not tag is used instead of String |
398408
399409
400410
* **Example**
@@ -422,6 +432,7 @@ A basic rectangle shape that can either be filled or an outline
422432
| background | Color | Widget interior color, transparent by default |
423433
| border-color | Color | Widget outline color, $000000 by default |
424434
| border-width | Number | Thickness of widget outline, 2 by default |
435+
| visibility | String | A pv that determines the visibility of the widget, visibility is turned off if the PV's value is zero. This logic is inverted if the !Not tag is used instead of String |
425436
426437
427438
* **Example**
@@ -459,6 +470,7 @@ dictionaries. Within each dictionary, the following values can be defined:
459470
| background | Color | Widget background color |
460471
| font | Font | Widget display font |
461472
| links | List | A list of dictionaries describing the linked UI screens |
473+
| visibility | String | A pv that determines the visibility of the widget, visibility is turned off if the PV's value is zero. This logic is inverted if the !Not tag is used instead of String |
462474

463475

464476
* **Example**
@@ -493,6 +505,7 @@ A widget representing a bar filling up based on a pv's value versus its limits
493505
| foreground | Color | Color of the filled portion of bar, $0000FF by default |
494506
| horizontal | Bool | Whether to align the bar horizontally, defaults to False |
495507
| pv | String | The PV being monitored |
508+
| visibility | String | A pv that determines the visibility of the widget, visibility is turned off if the PV's value is zero. This logic is inverted if the !Not tag is used instead of String |
496509

497510

498511
* **Example**
@@ -530,6 +543,7 @@ dictionaries. Within each dictionary, the following values can be defined:
530543
| background | Color | Widget background color |
531544
| font | Font | Widget display font |
532545
| commands | List | A list of dictionaries describing the commands that can be run |
546+
| visibility | String | A pv that determines the visibility of the widget, visibility is turned off if the PV's value is zero. This logic is inverted if the !Not tag is used instead of String |
533547

534548

535549
* **Example**
@@ -565,6 +579,7 @@ A widget representing a basic text label.
565579
| border-width | Number | Widget border thickness in pixels |
566580
| font | Font | Widget display font |
567581
| alignment | Alignment | Display text alignment. |
582+
| visibility | String | A pv that determines the visibility of the widget, visibility is turned off if the PV's value is zero. This logic is inverted if the !Not tag is used instead of String |
568583

569584

570585
* **Example**
@@ -598,6 +613,7 @@ A widget representing a text entry field.
598613
| font | Font | Widget display font |
599614
| alignment | Alignment | Display text alignment. |
600615
| pv | String | The PV that will be written to |
616+
| visibility | String | A pv that determines the visibility of the widget, visibility is turned off if the PV's value is zero. This logic is inverted if the !Not tag is used instead of String |
601617

602618

603619
* **Example**
@@ -630,6 +646,7 @@ A widget representing a text display field
630646
| font | Font | Widget display font |
631647
| alignment | Alignment | Display text alignment. |
632648
| pv | String | The PV to read data from |
649+
| visibility | String | A pv that determines the visibility of the widget, visibility is turned off if the PV's value is zero. This logic is inverted if the !Not tag is used instead of String |
633650

634651

635652
* **Example**

0 commit comments

Comments
 (0)