Class

LineHeightStyle.Alignment

Defines how to align the line in the space provided by the line height.

Common
value class Alignment constructor(internal val topRatio: Float)

Defines how to align the line in the space provided by the line height.

Parameters

topRatio the ratio of ascent to ascent+descent in percentage. Valid values are between 0f (inclusive) and 1f (inclusive).

Companion Object

Properties

Common
val Top = Alignment(topRatio = 0f)

Align the line to the top of the space reserved for that line. This means that all extra space as a result of line height is applied to the bottom of the line. When the provided line height value is smaller than the actual line height, the line will still be aligned to the top, therefore the required difference will be subtracted from the bottom of the line.

For example, when line height is 3.em, the lines are aligned to the top of 3.em height:

+--------+ | Line1 | | | | | |--------| | Line2 | | | | | +--------+

Common
val Center = Alignment(topRatio = 0.5f)

Align the line to the center of the space reserved for the line. This configuration distributes additional space evenly between top and bottom of the line.

For example, when line height is 3.em, the lines are aligned to the center of 3.em height:

+--------+ | | | Line1 | | | |--------| | | | Line2 | | | +--------+

Common
val Proportional = Alignment(topRatio = -1f)

Align the line proportional to the ascent and descent values of the line. For example if ascent is 8 units of length, and descent is 2 units; an additional space of 10 units will be distributed as 8 units to top, and 2 units to the bottom of the line. This is the default behavior.

Common
val Bottom = Alignment(topRatio = 1f)

Align the line to the bottom of the space reserved for that line. This means that all extra space as a result of line height is applied to the top of the line. When the provided line height value is smaller than the actual line height, the line will still be aligned to the bottom, therefore the required difference will be subtracted from the top of the line.

For example, when line height is 3.em, the lines are aligned to the bottom of 3.em height:

+--------+ | | | | | Line1 | |--------| | | | | | Line2 | +--------+