Interface TextAtom

Something that can be drawn inline with text.

interface TextAtom {
    measure(drawer: Drawer, style: FontStyle): Size;
    draw(position: Point, drawer: Drawer, style: FontStyle): void;
    tryClip(maxWidth: number, style: FontStyle): ClipResult<TextAtom> | null;
    trimFromEnd(): boolean;
}

Implemented by

Index

Methods

measure draw tryClip trimFromEnd

Methods

measure

measure(drawer: Drawer, style: FontStyle): Size
Measures the size of this atom's bounds.
Parameters
- drawer: Drawer
- style: FontStyle
Returns Size
- Defined in src/gfx/TextWrapper.ts:9

draw

draw(position: Point, drawer: Drawer, style: FontStyle): void
Draws this atom.
Parameters
- position: Point
- drawer: Drawer
- style: FontStyle
Returns void
- Defined in src/gfx/TextWrapper.ts:11

tryClip

tryClip(maxWidth: number, style: FontStyle): ClipResult<TextAtom> | null
Tries to clip this atom so that the clipped part is no wider than maxWidth, or returns null if such clipping is not possible.
Parameters
- maxWidth: number
- style: FontStyle
Returns ClipResult<TextAtom> | null
- Defined in src/gfx/TextWrapper.ts:13

trimFromEnd

trimFromEnd(): boolean
Whether this atom should be trimmed from the ends of lines, like whitespace.

Returns boolean
- Defined in src/gfx/TextWrapper.ts:15