Class
UITableLayout
Lays out sibling UI elements and their child UI elements as rows/columns and cells in a table.
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.
Properties 4#
FillEmptySpaceColumnsboolean | Determines whether cells are sized such that they occupy the horizontal space of the parent UI element.ReadSafe |
FillEmptySpaceRowsboolean | Determines whether cells are sized such that they occupy the vertical space of the parent UI element.ReadSafe |
MajorAxisTableMajorAxis | Determines whether sibling UI elements are treated as rows or columns.ReadSafe |
PaddingUDim2 | Determines the empty space between cells.ReadSafe |
FillEmptySpaceColumns: boolean#
ReadSafe
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).
FillEmptySpaceRows: boolean#
ReadSafe
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).
MajorAxis: TableMajorAxis#
ReadSafe
MajorAxis determines whether sibling UI elements are treated as rows or columns.
Padding: UDim2#
ReadSafe
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.
Inherited members#
Inherited from UIGridStyleLayout 7
Properties (5)
AbsoluteContentSize, FillDirection, HorizontalAlignment, SortOrder, VerticalAlignment
Methods (2)
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild