This class represents a column of a partition grid structure.
Remarks
Default Values of Properties
| computedPosition | 0.0 | |
| computedWidth | 0.0 | |
| indexFixed | true | The index of the column is fixed. |
| leftInset | 0.0 | |
| minimumWidth | 0.0 | |
| originalPosition | 0.0 | |
| originalWidth | 0.0 | |
| rightInset | 0.0 | |
| tightness | 0.0 | The column will not be compressed. |
Type Details
- yfiles module
- layout-core
- yfiles-umd modules
- All layout modules, view-layout-bridge
- Legacy UMD name
- yfiles.layout.ColumnDescriptor
See Also
Properties
Gets or sets the computed position (smallest x-coordinate) of the column after the layout has been calculated.
Remarks
Default Value
0.0.Gets or sets the computed width of the column after the layout has been calculated.
Remarks
The computed width 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 originalWidth
Default Value
0.0.Throws
- Exception({ name: 'ArgumentError' })
- if the computed width is negative
Gets the index of the column within the partition grid.
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.
Gets or sets the left column inset in which no element will lie in the resulting layout.
Remarks
0.Default Value
0.0.Throws
- Exception({ name: 'ArgumentError' })
- if the left inset is negative
See Also
Sample Graphs
Gets or sets the minimum width of the column.
Remarks
0.Default Value
0.0.Throws
- Exception({ name: 'ArgumentError' })
- if the minimum width is negative
See Also
Sample Graphs
Gets or sets the original position (smallest x-coordinate) of the column.
Remarks
Default Value
0.0.Gets or sets the original width of the column.
Remarks
The original width should be greater than or equal to 0.
Note that running a layout algorithm will affect the computed width only and the original width may be outdated.
Default Value
0.0.Throws
- Exception({ name: 'ArgumentError' })
- if the original width is negative
Gets or sets the right column inset in which no element will lie in the resulting layout.
Remarks
0.Default Value
0.0.Throws
- Exception({ name: 'ArgumentError' })
- if the right inset is negative
See Also
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 minimum width.
Default Value
0.0.The column will not be compressed.
Throws
- Exception({ name: 'ArgumentError' })
- if the tightness value is outside the interval
[0,1]
Methods
Compares this ColumnDescriptor instance with a given other ColumnDescriptor instance based on the indices of the two instances.
Parameters
A map of options to pass to the method.
- o - Object
- the ColumnDescriptor to compare to
Returns
- ↪number
-1,0or1if this ColumnDescriptor is less than, equal to, or greater than the given other ColumnDescriptor