Grid
Members
arbitrator
desc: An instance of GridGUI.ExpanderArbitrator that keeps tack of the expanding GridGUI.Cells in the grid.
type: GridGUI.ExpanderArbitrator
meta: [object]
cells
desc: An array of the GridGUI.Cells that have been added to the grid.
type: array
default: []
meta: [object]
columns
desc: An instance of GridGUI.Columns that keeps tack of the GridGUI.Columns comprising the grid.
type: GridGUI.Columns
meta: [object]
heights
desc: The latest calculated row heights.
type: array
default: []
meta: [object]
justify
desc: How the GridGUI.Grid.cells will be positioned in the grid when drawn. Can be any combination of C (Center), N (North), S (South), W (West) and E (East).
type: string
default: ""
rows
desc: An instance of GridGUI.Rows that keeps tack of the GridGUI.Rows comprising the grid.
type: GridGUI.Rows
meta: [object]
widths
desc: The latest calculated column widths.
type: array
default: []
meta: [object]
Methods
AddCell
AddCell(c)
Adds a GridGUI.Cell to the grid in the rows and columns indicated by the GridGUI.Cell.gridpos member of the cell.
parameters
CalculatePositions
CalculatePositions(area)
Calculates the positions and sizes of the GridGUI.Cells in the grid.
parameters
name: area
desc: The position and size of the grid. This is needed to support GridGUI.SubGrids.
type: GridGUI.Position
Draw
Draw(area)
Draws the GridGUI.Cells in the grid using the most recently calculated cell positions and sizes.
parameters
name: area
desc: The position and size of the grid. This is needed to support GridGUI.SubGrids.
type: GridGUI.Position
return value
desc: Returns the justified area so that the debug grid lines of GridGUI.GridGUIClass can be moved accordingly.
type: GridGUI.Position
GetMinHeight
GetMinHeight()
Returns the minimal needed height to show the GridGUI.Cells.
return value
desc: The minimal needed height to show the GridGUI.Cells
type: number
GetMinWidth
GetMinWidth()
Returns the minimal needed width to show the GridGUI.Cells.
return value
desc: The minimal needed width to show the GridGUI.Cells
type: number
RemoveCell
RemoveCell(c)
Removes a GridGUI.Cell from the grid by removing it from the rows and columns it was in, as well as removing it from the GridGUI.Grid.arbitrator.
parameters
ResetConstants
ResetConstants()
Resets the cached constants of the members.