Row
Members
catched
desc: Whether or not the members have already been calculate.
type: bool
default: false
cells
desc: A collection of arrays of GridGUI.Cells indexed by the index of the columns they are placed on.
type: Associative Array
default: {}
meta: [object]
confligtingExpanders
desc: A collection of cells that have vertical expansion conflicts.
type: Associative Array
default: {}
meta: [object, cached]
expanderMaxValue
desc: The largest vertical expansion weight in this row.
type: number
default: 0
meta: [cached]
expanders
desc: The sum of all the vertical expansion weights of cells that are in this row.
type: number
default: 0
meta: [cached]
fixedWidth
desc: The sum of the maximal fixed heights for each column, that is the sum of the largest fixed height for each array of overlapping cells in GridGUI.Column.cells.
type: number
default: 0
meta: [cached]
index
desc: The index of the row in the grid.
type: number
default: 0
minWidth
desc: The sum of the maximal minimal heights for each column, that is the sum of the largest minimal height for each array of overlapping cells in GridGUI.Column.cells.
type: number
default: 0
meta: [cached]
nonExpanders
desc: The amount of cells with fixed size in this row.
type: number
default: 0
meta: [cached]
Methods
__CalculateConfligtingExpanders
__CalculateConfligtingExpanders(c)
Updates GridGUI.Row.confligtingExpanders with the GridGUI.Cell for a cell if it has vertical conflicts.
parameters
__CalculateExpanders
__CalculateExpanders(c)
Updates GridGUI.Row.expanders with the result of GridGUI.Cell.GetExpansionHeightValue for a cell.
parameters
__CalculateFixedHeight
__CalculateFixedHeight(c)
Updates GridGUI.Row.fixedHeight with the result of GridGUI.Cell.GetFixedHeight for a cell if it is larger than the previous value.
parameters
__CalculateMinHeight
__CalculateMinHeight(c)
Updates GridGUI.Row.minHeight with the result of GridGUI.Cell.GetNeededHeight for a cell if it is larger than the previous value.
parameters
__CalculateNonExpanders
__CalculateNonExpanders(c)
Increments GridGUI.Row.nonExpanders if the GridGUI.Cell does not expand vertically.
parameters
__New
__New(index)
Constructor.
parameters
name: index
desc: The index of the row in the grid.
type: number
return value
desc: A new GridGUI.Row instance.
type: GridGUI.Row
CalculateConstants
CalculateConstants()
Calculates the values for the GridGUI.Row members that are cached.
CalculateHeight
CalculateHeight(height, expandersH, nonExpandersH, width, expandersW, nonExpandersW)
Calculates the height of the row.
parameters
name: height
desc: The unclaimed height of the grid, that is the height of the grid or subgrid left after removing the height of the fixed cells.
type: number
name: expandersH
desc: An array of the sum of vertical expansion weights for each row.
type: associative array
name: nonExpandersH
desc: An array of the amount of fixed size cells in each row.
type: associative array
name: width
desc: The unclaimed width of the grid, that is the width of the GUI or subgrid left after removing the width of the fixed cells.
type: number
name: expandersW
desc: An array of the sum of horizontal expansion weights for each column.
type: associative array
name: nonExpandersW
desc: An array of the amount of fixed size cells in each column.
type: associative array
return value
desc: The height of the row.
type: number
GetExpanderMaxValue
GetExpanderMaxValue()
Getter for GridGUI.Row.expanderMaxValue.
return value
desc: The largest vertical expansion weight of a cell in the row.
type: number
GetExpanders
GetExpanders()
Getter for GridGUI.Row.expanders.
return value
desc: The sum of vertical expansion weight of cells in the row.
type: number
GetFixedHeight
GetFixedHeight()
Getter for GridGUI.Row.fixedHeight.
return value
desc: The largest fixed height of a cell in the row.
type: number
GetMinHeight
GetMinHeight()
Getter for GridGUI.Row.minHeight.
return value
desc: The largest minimal height of a cell in the row.
type: number
GetNonExpanders
GetNonExpanders()
Getter for GridGUI.Row.nonExpanders.
return value
desc: The amount of cells with fixed height in the row.
type: number