VerticalTextScope

fun combineUpright(text: CharSequence): Unit

Appends text and wraps it in a TextOrientationSpan.CombineUpright span: all of the appended characters are combined horizontally and laid out within a single vertical slot (tate-chu-yoko).

fun sideways(text: CharSequence): Unit

Appends text and wraps it in a TextOrientationSpan.Sideways span: every glyph is rotated 90° clockwise regardless of its script.

fun text(text: CharSequence, rubyMap: Map<String, String> = emptyMap()): Unit

Appends text. For each (key, reading) in rubyMap, every occurrence of key inside the just-appended text is annotated with a RubySpan carrying reading.

fun upright(text: CharSequence): Unit

Appends text and wraps it in a TextOrientationSpan.Upright span: every glyph is drawn upright regardless of its script.

fun <R : Any> withEmphasis(
    style: EmphasisStyle = EmphasisStyle.Dot,
    filled: Boolean = true,
    scale: Float = 0.5f,
    block: VerticalTextScope.() -> R
): R

Runs block and wraps the range it appends with an EmphasisSpan that renders emphasis marks (傍点) alongside each character.

fun <R : Any> withRuby(
    ruby: CharSequence,
    position: AnnotationPosition = RubySpan.DEFAULT_POSITION,
    orientation: TextOrientation = RubySpan.DEFAULT_ORIENTATION,
    textScale: Float = RubySpan.DEFAULT_TEXT_SCALE,
    block: VerticalTextScope.() -> R
): R

Runs block and wraps the range it appends with a RubySpan annotating it with withRuby, with the given position, orientation and textScale.

Ruby text is small annotation text (such as furigana) placed alongside the base text, commonly used to indicate pronunciation or provide a brief description.

fun <R : Any> withStyle(
    fontSize: TextUnit = TextUnit.Unspecified,
    textColor: Color = Color.Unspecified,
    backgroundColor: Color = Color.Unspecified,
    fontShear: Float = Float.NaN,
    block: VerticalTextScope.() -> R
): R

Runs block and wraps the range it appends with a MetricAffectingSpan applying the given fontSize, textColor, and/or backgroundColor to the paint used for that range. If fontShear is provided, it also wraps the range in a FontShearSpan.

Sp values in fontSize are resolved using Density; em values scale the inherited paint size.