This class represents a row of a partition grid structure.
Remarks
Default Values of Properties
| bottomInset | 0.0 | |
| computedHeight | 0.0 | |
| computedPosition | 0.0 | |
| indexFixed | true | The index of the row is fixed. |
| minimumHeight | 0.0 | |
| originalHeight | 0.0 | |
| originalPosition | 0.0 | |
| tightness | 0.0 | The row will not be compressed. |
| topInset | 0.0 |
Type Details
- yfiles module
- layout-core
- yfiles-umd modules
- All layout modules, view-layout-bridge
- Legacy UMD name
- yfiles.layout.RowDescriptor
See Also
Properties
Gets or sets the bottom inset in which no element will lie in the resulting layout.
Remarks
0.Default Value
0.0.Throws
- Exception({ name: 'ArgumentError' })
- if the given bottom inset is negative
See Also
Sample Graphs
Gets or sets the computed height of the row after the layout has been calculated.
Remarks
The computed height needs to be greater than or equal to 0.
Note that the result is zero unless a layout has been applied. Also note that the result will not automatically be copied back or be retrievable by originalHeight
Default Value
0.0.Throws
- Exception({ name: 'ArgumentError' })
- if the computed height is negative
Gets or sets the computed position (smallest y-coordinate) of the row after the layout has been calculated.
Remarks
Default Value
0.0.Gets the index of the row within the partition grid.
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.
Gets or sets the minimum height of the row.
Remarks
0.Default Value
0.0.Throws
- Exception({ name: 'ArgumentError' })
- if the minimum height is negative
See Also
Sample Graphs
Gets or sets the original height of the row.
Remarks
The original height needs to be greater than or equal to 0.
Note that running a layout algorithm will affect the computed height only and the original height may be outdated.
Default Value
0.0.Throws
- Exception({ name: 'ArgumentError' })
- if the original height is negative
Gets or sets the original position (smallest y-coordinate) of the row.
Remarks
Default Value
0.0.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 minimum height.
Default Value
0.0.The row will not be compressed.
Throws
- Exception({ name: 'ArgumentError' })
- if the tightness value is outside the interval
[0,1]
Gets or sets the top inset in which no element will lie in the resulting layout.
Remarks
0.Default Value
0.0.Throws
- Exception({ name: 'ArgumentError' })
- if the given top inset is negative
See Also
Sample Graphs
Methods
Compares this RowDescriptor instance with a given other RowDescriptor instance based on the indices of the two instances.
Parameters
A map of options to pass to the method.
- o - Object
- the RowDescriptor to compare to
Returns
- ↪number
-1,0or1if this RowDescriptor is less than, equal to, or greater than the given other RowDescriptor