This class represents a row of a LayoutGrid structure.
Remarks
The results of the calculation of the geometry of the row will be placed into the instances of this class after the layout.
This class cannot be instantiated
Default Values of Properties
| bottomPadding | 0.0 | |
| height | 0.0 | |
| indexFixed | true | The index of the row is fixed. |
| minimumHeight | 0.0 | |
| position | 0.0 | |
| tightness | 0.0 | The row will not be compressed. |
| topPadding | 0.0 |
Type Details
- yFiles module
- algorithms
See Also
Properties
Gets or sets the bottom padding in which no element will lie in the resulting layout.
Remarks
0.Default Value
0.0.Property Value
Throws
- Exception({ name: 'ArgumentError' })
- if the given bottom padding is negative
Sample Graphs
Gets or sets the height of the row.
Remarks
The height needs to be greater than or equal to 0.
Note that the result is zero unless a layout or manual adjustment has been applied.
Default Value
0.0.Property Value
Throws
- Exception({ name: 'ArgumentError' })
- if the height is negative
Gets the index of the row within the LayoutGrid.
Property Value
Gets or sets whether the index of the row is fixed or it should be chosen automatically in order to minimize edge lengths.
Remarks
Default Value
true.The index of the row is fixed.
Property Value
true if the row index is fixed, false if it may be chosen automaticallyGets or sets the minimum height of the row.
Remarks
0.Default Value
0.0.Property Value
Throws
- Exception({ name: 'ArgumentError' })
- if the minimum height is negative
Sample Graphs
Gets or sets the tightness factor of this row.
Remarks
This value must lie within the interval [0,1].
The larger the value, the more the row will be forced to obtain its minimum height:
- a value of
0.0dwill disable the compression of the row. - a value of
1.0dwill try to force the row to obtain its specified minimumHeight.
Default Value
0.0.The row will not be compressed.
Property Value
[0,1]Throws
- Exception({ name: 'ArgumentError' })
- if the tightness value is outside the interval
[0,1]
Gets or sets the top padding in which no element will lie in the resulting layout.
Remarks
0.Default Value
0.0.Property Value
Throws
- Exception({ name: 'ArgumentError' })
- if the given top padding is negative
Sample Graphs
Methods
Compares this LayoutGridRow instance with a given other LayoutGridRow instance based on the indices of the two instances.
Parameters
A map of options to pass to the method.
- o - any
- The LayoutGridRow to compare to.
Returns
- ↪number
-1,0, or1if this LayoutGridRow is less than, equal to, or greater than the given other LayoutGridRow.