UITableLayout
Lays out sibling UI elements and their child UI elements as rows/columns and cells in a table.
| Memory category | Instances |
|---|
Member index 4
Description
A UITableLayout lays out sibling UI elements as rows in a table. Child UI elements (the table cells) of these rows are then arranged in columns (within rows). Each cell within a row has the same height, and each cell within a column has the same width.
By changing the UIGridStyleLayout.FillDirection, sibling UI elements can act as columns instead.
When applied, a UITableLayout will take control of sibling and cell elements' GuiObject.Size and GuiObject.Position. Changing these in the Properties window is still possible will not produce any effect.
Dimensions of the cells in the resulting table are controlled by the parent UI element's dimensions. Unless UITableLayout.FillEmptySpaceColumns or UITableLayout.FillEmptySpaceRows is enabled, the cell dimensions will be that of the parent UI element (and thus tables with more than one cell extend outside of their parent).
Cells will continue to respect UISizeConstraint objects within them. In other words, setting UISizeConstraint.MinSize on UISizeConstraints within the header cells can determine the size of the rest of the cells. If UISizeConstraint.MaxSize restricts a cell's size from filling the allotted space (i.e. another row/column is wider than it), it will align to the top-left.
History 21
- 726 Change Default of Padding from UDim2({0, 0}, {0, 0}) to
- 726 Change Default of MajorAxis from RowMajor to
- 726 Change Default of FillEmptySpaceRows from false to
- 726 Change Default of FillEmptySpaceColumns from false to
- 553 Change Default of Padding from to UDim2({0, 0}, {0, 0})
- 553 Change Default of MajorAxis from to RowMajor
- 553 Change Default of FillEmptySpaceRows from to false
- 553 Change Default of FillEmptySpaceColumns from to false
- 486 Change ThreadSafety of Padding from ReadOnly to ReadSafe
- 486 Change ThreadSafety of MajorAxis from ReadOnly to ReadSafe
- 486 Change ThreadSafety of FillEmptySpaceRows from ReadOnly to ReadSafe
- 486 Change ThreadSafety of FillEmptySpaceColumns from ReadOnly to ReadSafe
- 462 Change ThreadSafety of Padding from to ReadOnly
- 462 Change ThreadSafety of MajorAxis from to ReadOnly
- 462 Change ThreadSafety of FillEmptySpaceRows from to ReadOnly
- 462 Change ThreadSafety of FillEmptySpaceColumns from to ReadOnly
- 290 Add Padding
- 290 Add MajorAxis
- 290 Add FillEmptySpaceRows
- 290 Add FillEmptySpaceColumns
- 290 Add UITableLayout
Members 4
FillEmptySpaceColumns
| Type | Default | |
|---|---|---|
| bool | ||
FillEmptySpaceColumns determines whether cells' X size are set such that the entire horizontal space of the parent UI element is used. Enabling this is useful for making sure your table takes up a more easily predictable amount of horizontal space (the X-axis size of the parent UI element). It is still possible that a UISizeConstraint applied to cells will cause underflow/overflow.
When enabling this property, the column widths will be approximately equal to the parent's GuiBase2d.AbsoluteSize.X component divided by the number of columns (not accounting for padding or other factors).
| Thread safety | ReadSafe |
|---|---|
| Category | Appearance |
| Loaded/Saved | true |
History 5
- 726 Change Default of FillEmptySpaceColumns from false to
- 553 Change Default of FillEmptySpaceColumns from to false
- 486 Change ThreadSafety of FillEmptySpaceColumns from ReadOnly to ReadSafe
- 462 Change ThreadSafety of FillEmptySpaceColumns from to ReadOnly
- 290 Add FillEmptySpaceColumns
FillEmptySpaceRows
| Type | Default | |
|---|---|---|
| bool | ||
FillEmptySpaceRows determines whether cells' Y size are set such that the entire vertical space of the parent UI element is used. Enabling this is useful for making sure your table takes up a more easily predictable amount of vertical space (the Y-axis size of the parent UI element). It is still possible that a UISizeConstraint applied to cells will cause underflow/overflow.
When enabling this property, the row heights will be approximately equal to the parent's GuiBase2d.AbsoluteSize.Y component divided by the number of rows (not accounting for padding or other factors).
| Thread safety | ReadSafe |
|---|---|
| Category | Appearance |
| Loaded/Saved | true |
History 5
- 726 Change Default of FillEmptySpaceRows from false to
- 553 Change Default of FillEmptySpaceRows from to false
- 486 Change ThreadSafety of FillEmptySpaceRows from ReadOnly to ReadSafe
- 462 Change ThreadSafety of FillEmptySpaceRows from to ReadOnly
- 290 Add FillEmptySpaceRows
MajorAxis
| Type | Default | |
|---|---|---|
| TableMajorAxis | ||
MajorAxis determines whether sibling UI elements are treated as rows or columns.
| Thread safety | ReadSafe |
|---|---|
| Category | Behavior |
| Loaded/Saved | true |
Padding
| Type | Default | |
|---|---|---|
| UDim2 | ||
Padding will position elements with extra space between them. This can be done using Scale or Offset components of UDim2. Negative values can bring elements closer together. When non-zero, the sibling UI elements may be visible between the cells contained within them.
| Thread safety | ReadSafe |
|---|---|
| Category | Appearance |
| Loaded/Saved | true |