-
Notifications
You must be signed in to change notification settings - Fork 1
/
ui-basecontrol.Rmd
66 lines (50 loc) · 3.11 KB
/
ui-basecontrol.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
---
title: "BaseControl"
output: html_document
---
**This control type is abstract and can not be used directly.**
Every jamovi user control inherits from `BaseControl`.
##Properties
All jamovi controls have the following properties.
Property | Description | Form |
------------- | ------------------------------------------| -------------------- |
`type` | Set the type of control, for a list of types click [here](ui-advanced-design.html#Controls). | enum of valid Control names
`name` | The name of the control. This allows for access to the control when customizing behavior, for example enabling/disabling. It needs to be unique to all other controls. | Unique string
`stage` | This is the stage of development. The control will only be visible in the appropriate jamovi instance. | 0 : released [always visible]\
1 : under development\
2 : proposed
`margin` | The level of spacing around the control when displayed. | *enum*: small, normal, large, none
`cell` | The zero-based row and column index where the control is to be placed within the parent `LayoutBox`. | object consisting of\
`row`: row index\
`column`: column index
`stretchFactor` | A stretch factor greater than zero will cause the control to fill the available horizontal space by an amount proportional to the sum of all other sibling `stretchFactors` defined in the same row. It is important to note that when specifying a non-zero `stretchFactor` on a control, it is required that the parent of the control also have a non-zero `stretchFactor`. Failing to do so will result in unhelpful layout. | number >= 0
`horizontalAlignment` | Specifies the horizontal alignment of the control when placed in the parent `LayoutBox` cell | *enum*: left, center, right
`verticalAlignment` | Specifies the vertical alignment of the control when placed in the parent `LayoutBox` cell | *enum*: top, center, bottom
`minWidth` | Specifies the minimum width of the `LayoutBox` cell into which the control will be placed. | number >= 0
`minHeight` | Specifies the minimum height of the `LayoutBox` cell into which the control will be placed. | number >= 0
`maxWidth` | Specifies the maximum width of the `LayoutBox` cell into which the control will be placed. | number >= 0
`maxHeight` | Specifies the maximum height of the `LayoutBox` cell into which the control will be placed. | number >= 0
------------------------------------
##Controls
Below is a list of controls that inherit from `BaseControl`.
###Layout Controls
- [LayoutBox](ui-layoutbox.html)
- [CollapseBox](ui-collapsebox.html)
- [Supplier](ui-supplier.html)
- [VariableSupplier](ui-variablesupplier.html)
- [TargetLayoutBox](ui-targetlayoutbox.html)
####Parent Controls
- [CheckBox](ui-checkbox.html)
- [RadioButton](ui-radiobutton.html)
- [Label](ui-label.html)
###Option Controls
- [TextBox](ui-textbox.html)
- [CheckBox](ui-checkbox.html)
- [RadioButton](ui-radiobutton.html)
- [ComboBox](ui-combobox.html)
- [Label](ui-label.html)
- [ListBox](ui-listbox.html)
- [VariableLabel](ui-variablelabel.html)
- [TermLabel](ui-termlabel.html)
### Display Controls
- [Label](ui-label.html)