C

LayoutGridColumn

Show Usages
This class represents a column of a LayoutGrid structure.
ImplementsInheritance Hierarchy

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

NameDefaultDescription
indexFixedtrue
The index of the column is fixed.
leftPadding0.0
minimumWidth0.0
position0.0
rightPadding0.0
tightness0.0
The column will not be compressed.
width0.0

See Also

Developer's Guide

API

LayoutGrid

Members

No filters for this type

Properties

index

: number
readonly
Gets the index of the column within the LayoutGrid.
readonlyfinal

Property Value

the index of the column

indexFixed

: boolean
Gets or sets whether the index of the column is fixed or it should be chosen automatically in order to minimize edge lengths.
For all columns where this property is enabled, the relative ordering given by the indices is preserved. The remaining columns may be sorted again so that the overall edge lengths are minimized.
final

Property Value

true if the column index should be fixed, false if it may be chosen automatically

Default Value

The default value is: true
The index of the column is fixed.

leftPadding

: number
Gets or sets the left column padding in which no element will lie in the resulting layout.
The column padding must be greater than or equal to 0.
final

Property Value

the left column padding

Throws

Exception ({ name: 'ArgumentError' })
if the left padding is negative

Default Value

The default value is: 0.0

Sample Graphs

ShownSetting: All paddings 10

See Also

Developer's Guide

minimumWidth

: number
Gets or sets the minimum width of the column.
The minimum width is defined to be at least 0.
final

Property Value

the minimum column width

Throws

Exception ({ name: 'ArgumentError' })
if the minimum width is negative

Default Value

The default value is: 0.0

Sample Graphs

ShownSetting: Minimum column width 0

See Also

Developer's Guide

position

: number
Gets or sets the position (smallest x-coordinate) of the column.
Note that the result is zero unless a layout or manual adjustment has been applied.
final

Property Value

the position (smallest x-coordinate)

Default Value

The default value is: 0.0

rightPadding

: number
Gets or sets the right column padding in which no element will lie in the resulting layout.
The column padding must be greater than or equal to 0.
final

Property Value

the right column padding

Throws

Exception ({ name: 'ArgumentError' })
if the right padding is negative

Default Value

The default value is: 0.0

Sample Graphs

ShownSetting: All paddings 10

See Also

Developer's Guide

tightness

: number
Gets or sets the tightness factor of this column.

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.0d will disable the compression of the column.
  • a value of 1.0d will try to force the column to obtain its specified minimumWidth.
final

Property Value

a tightness value from the interval [0,1]

Throws

Exception ({ name: 'ArgumentError' })
if the tightness value is outside the interval [0,1]

Default Value

The default value is: 0.0
The column will not be compressed.

width

: number
Gets or sets the width of the column.

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.

final

Property Value

the width

Throws

Exception ({ name: 'ArgumentError' })
if the width is negative

Default Value

The default value is: 0.0

Methods

compareTo

(o: any): number
Compares this LayoutGridColumn instance with a given other LayoutGridColumn instance based on the indices of the two instances.
final

Parameters

o: any
the LayoutGridColumn to compare to

Return Value

number
-1, 0, or 1 if this LayoutGridColumn is less than, equal to, or greater than the given other LayoutGridColumn