This class represents a column of a LayoutGrid structure.
Remarks
The results of the calculation of the geometry of the column will be placed into the instances of this class after the layout.
This class cannot be instantiated
Default Values of Properties
| indexFixed | true | The index of the column is fixed. |
| leftPadding | 0.0 | |
| minimumWidth | 0.0 | |
| position | 0.0 | |
| rightPadding | 0.0 | |
| tightness | 0.0 | The column will not be compressed. |
| width | 0.0 |
Type Details
- yFiles module
- algorithms
See Also
Properties
Gets the index of the column within the LayoutGrid.
Property Value
Gets or sets whether the index of the column is fixed or it should be chosen automatically in order to minimize edge lengths.
Remarks
Default Value
true.The index of the column is fixed.
Property Value
true if the column index should be fixed, false if it may be chosen automaticallyGets or sets the left column 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 left padding is negative
Sample Graphs
Gets or sets the minimum width of the column.
Remarks
0.Default Value
0.0.Property Value
Throws
- Exception({ name: 'ArgumentError' })
- if the minimum width is negative
Sample Graphs
Gets or sets the right column 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 right padding is negative
Sample Graphs
Gets or sets the tightness factor of this column.
Remarks
This value must lie within the interval [0,1].
The larger the value, the more the column will be forced to obtain its minimum width:
- a value of
0.0dwill disable the compression of the column. - a value of
1.0dwill try to force the column to obtain its specified minimumWidth.
Default Value
0.0.The column 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 width of the column.
Remarks
The width 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 width is negative
Methods
Compares this LayoutGridColumn instance with a given other LayoutGridColumn instance based on the indices of the two instances.
Parameters
A map of options to pass to the method.
- o - any
- the LayoutGridColumn to compare to
Returns
- ↪number
-1,0, or1if this LayoutGridColumn is less than, equal to, or greater than the given other LayoutGridColumn