C

LayoutGridRow

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

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

NameDefaultDescription
bottomPadding0.0
height0.0
indexFixedtrue
The index of the row is fixed.
minimumHeight0.0
position0.0
tightness0.0
The row will not be compressed.
topPadding0.0

See Also

Developer's Guide

API

LayoutGrid

Members

No filters for this type

Properties

bottomPadding

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

Property Value

the bottom padding

Throws

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

Default Value

The default value is: 0.0

Sample Graphs

ShownSetting: All paddings 10

See Also

Developer's Guide

height

: number
Gets or sets the height of the row.

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.

final

Property Value

the current height

Throws

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

Default Value

The default value is: 0.0

See Also

Developer's Guide

index

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

Property Value

the index of the row

indexFixed

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

Property Value

true if the row index is fixed, false if it may be chosen automatically

Default Value

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

minimumHeight

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

Property Value

the current row height

Throws

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

Default Value

The default value is: 0.0

Sample Graphs

ShownSetting: Minimum height 0

See Also

Developer's Guide

position

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

Property Value

the position (smallest y-coordinate)

Default Value

The default value is: 0.0

See Also

Developer's Guide

tightness

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

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.0d will disable the compression of the row.
  • a value of 1.0d will try to force the row to obtain its specified minimumHeight.
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 row will not be compressed.

topPadding

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

Property Value

the top padding

Throws

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

Default Value

The default value is: 0.0

Sample Graphs

ShownSetting: All paddings 10

See Also

Developer's Guide

Methods

compareTo

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

Parameters

o: any
The LayoutGridRow to compare to.

Return Value

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