Stay organized with collections
Save and categorize content based on your preferences.
class VerticalTextLayout
Represents the result of laying out text vertically.
This class encapsulates the result of a vertical text layout process. It stores the layout's properties and provides methods to draw the layout on a Canvas.
Summary
Public functions |
Unit |
Draws this text layout onto the specified Canvas.
|
Public functions
fun draw(canvas: Canvas, x: @Px Float, y: @Px Float): Unit
Draws this text layout onto the specified Canvas.
| Parameters |
canvas: Canvas |
The Canvas to draw onto.
|
x: @Px Float |
The horizontal offset in pixels. The drawing origin is the top-right corner.
|
y: @Px Float |
The vertical offset in pixels. The drawing origin is the top-right corner.
|
Public properties
val orientation: Int
The text orientation used for building this vertical layout.
val width: Float
The width constraint of the vertical text in pixels.
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-08-27 UTC.
[null,null,["Last updated 2025-08-27 UTC."],[],[],null,["VerticalTextLayout \nArtifact: [androidx.text:text-vertical](/jetpack/androidx/releases/text) \n[View Source](https://cs.android.com/search?q=file:androidx/text/vertical/VerticalTextLayout.kt+class:androidx.text.vertical.VerticalTextLayout) \nAdded in [1.0.0-alpha01](/jetpack/androidx/releases/text#1.0.0-alpha01)\n\n*** ** * ** ***\n\nKotlin \\|[Java](/reference/androidx/text/vertical/VerticalTextLayout \"View this page in Java\")\n\n\n```\nclass VerticalTextLayout\n```\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nRepresents the result of laying out text vertically.\n\nThis class encapsulates the result of a vertical text layout process. It stores the layout's properties and provides methods to draw the layout on a [Canvas](https://developer.android.com/reference/android/graphics/Canvas.html).\n\nSummary \n\n| Nested types |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `class `[VerticalTextLayout.Builder](/reference/kotlin/androidx/text/vertical/VerticalTextLayout.Builder) Builder class for creating instances of [VerticalTextLayout](/reference/kotlin/androidx/text/vertical/VerticalTextLayout). |\n\n| Public functions |\n|-------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | [draw](/reference/kotlin/androidx/text/vertical/VerticalTextLayout#draw(android.graphics.Canvas,kotlin.Float,kotlin.Float))`(canvas: `[Canvas](https://developer.android.com/reference/android/graphics/Canvas.html)`, x: @`[Px](/reference/kotlin/androidx/annotation/Px)` `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`, y: @`[Px](/reference/kotlin/androidx/annotation/Px)` `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`)` Draws this text layout onto the specified [Canvas](https://developer.android.com/reference/android/graphics/Canvas.html). |\n\n| Public properties |\n|------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) | [end](/reference/kotlin/androidx/text/vertical/VerticalTextLayout#end()) |\n| [Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) | [height](/reference/kotlin/androidx/text/vertical/VerticalTextLayout#height()) |\n| [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) | [orientation](/reference/kotlin/androidx/text/vertical/VerticalTextLayout#orientation()) The text orientation used for building this vertical layout. |\n| [TextPaint](https://developer.android.com/reference/android/text/TextPaint.html) | [paint](/reference/kotlin/androidx/text/vertical/VerticalTextLayout#paint()) The [TextPaint](https://developer.android.com/reference/android/text/TextPaint.html) used for building this vertical layout. |\n| [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) | [start](/reference/kotlin/androidx/text/vertical/VerticalTextLayout#start()) |\n| [CharSequence](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html) | [text](/reference/kotlin/androidx/text/vertical/VerticalTextLayout#text()) |\n| [Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) | [width](/reference/kotlin/androidx/text/vertical/VerticalTextLayout#width()) The width constraint of the vertical text in pixels. |\n\nPublic functions \n\ndraw \nAdded in [1.0.0-alpha01](/jetpack/androidx/releases/text#1.0.0-alpha01) \n\n```\nfun draw(canvas: Canvas, x: @Px Float, y: @Px Float): Unit\n```\n\nDraws this text layout onto the specified [Canvas](https://developer.android.com/reference/android/graphics/Canvas.html). \n\n| Parameters |\n|----------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|\n| `canvas: `[Canvas](https://developer.android.com/reference/android/graphics/Canvas.html) | The [Canvas](https://developer.android.com/reference/android/graphics/Canvas.html) to draw onto. |\n| `x: @`[Px](/reference/kotlin/androidx/annotation/Px)` `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) | The horizontal offset in pixels. The drawing origin is the top-right corner. |\n| `y: @`[Px](/reference/kotlin/androidx/annotation/Px)` `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) | The vertical offset in pixels. The drawing origin is the top-right corner. |\n\nPublic properties \n\nend \nAdded in [1.0.0-alpha01](/jetpack/androidx/releases/text#1.0.0-alpha01) \n\n```\nval end: Int\n``` \n\nheight \nAdded in [1.0.0-alpha01](/jetpack/androidx/releases/text#1.0.0-alpha01) \n\n```\nval height: Float\n``` \n\norientation \nAdded in [1.0.0-alpha01](/jetpack/androidx/releases/text#1.0.0-alpha01) \n\n```\nval orientation: Int\n```\n\nThe text orientation used for building this vertical layout. \n\npaint \nAdded in [1.0.0-alpha01](/jetpack/androidx/releases/text#1.0.0-alpha01) \n\n```\nval paint: TextPaint\n```\n\nThe [TextPaint](https://developer.android.com/reference/android/text/TextPaint.html) used for building this vertical layout. Do not mutate this paint instance. \n\nstart \nAdded in [1.0.0-alpha01](/jetpack/androidx/releases/text#1.0.0-alpha01) \n\n```\nval start: Int\n``` \n\ntext \nAdded in [1.0.0-alpha01](/jetpack/androidx/releases/text#1.0.0-alpha01) \n\n```\nval text: CharSequence\n``` \n\nwidth \nAdded in [1.0.0-alpha01](/jetpack/androidx/releases/text#1.0.0-alpha01) \n\n```\nval width: Float\n```\n\nThe width constraint of the vertical text in pixels."]]
