The type of text truncation to be used when the text’s width exceeds the amount of available space. By default, text is truncated at the end, and an ellipsis (…) is used.

lineCount

var lineCount: Int

The maximum number of lines for the text. For performance reasons, during the measurement phase, it is presumed that the actual number of lines is equal to this value.

margins

var margins: Dimensions

The margins around the background. This is applied even if background is null.

minWidth

var minWidth: TextComponent.MinWidth

Defines the minimum width.

padding

var padding: Dimensions

The padding between the text and the background. This is applied even if background is null.

textAlignment

var textAlignment: Layout.Alignment

The text alignment.

textSizeSp

var textSizeSp: Float

The font size (in sp).

typeface

var typeface: Typeface?

The Typeface for the text.

Functions

drawText

fun drawText(context: DrawContext, text: CharSequence, textX: Float, textY: Float, horizontalPosition: HorizontalPosition = HorizontalPosition.Center, verticalPosition: VerticalPosition = VerticalPosition.Center, maxTextWidth: Int = DEF_LAYOUT_SIZE, maxTextHeight: Int = DEF_LAYOUT_SIZE, rotationDegrees: Float = 0.0f)

Uses Canvas to draw this TextComponent.

getHeight

fun getHeight(context: MeasureContext, text: CharSequence? = null, width: Int = DEF_LAYOUT_SIZE, height: Int = DEF_LAYOUT_SIZE, rotationDegrees: Float = 0.0f, pad: Boolean = text == null): Float

Returns the height of this TextComponent for the given text and the available width and height. pad defines whether to extend text by such a number of blank lines that it has lineCount lines.

getTextBounds

fun getTextBounds(context: MeasureContext, text: CharSequence? = null, width: Int = DEF_LAYOUT_SIZE, height: Int = DEF_LAYOUT_SIZE, outRect: RectF = tempMeasureBounds, includePaddingAndMargins: Boolean = true, rotationDegrees: Float = 0.0f, pad: Boolean = text == null): RectF

Returns the bounds (RectF) of this TextComponent for the given text and the available width and height. pad defines whether to extend text by such a number of blank lines that it has lineCount lines.

getWidth

fun getWidth(context: MeasureContext, text: CharSequence? = null, width: Int = DEF_LAYOUT_SIZE, height: Int = DEF_LAYOUT_SIZE, rotationDegrees: Float = 0.0f, pad: Boolean = text == null): Float

Returns the width of this TextComponent for the given text and the available width and height. pad defines whether to extend text by such a number of blank lines that it has lineCount lines.