Module "text"

Index

Functions

Functions

Const textBox

textBox(canvas: Canvas, x: number, y: number, width: number, height: number, txt: string, opts?: Partial<TextBoxOpts>): number

- Defined in text-canvas/src/text.ts:88
Parameters
- canvas: Canvas
- x: number
- y: number
- width: number
- height: number
- txt: string
- Optional opts: Partial<TextBoxOpts>
Returns number

Const textColumn

textColumn(canvas: Canvas, x: number, y: number, width: number, txt: string, format?: number): number

- Defined in text-canvas/src/text.ts:66
Writes multiline string at position x,y and using column width, also taking the current clip rect and format into account. Applies word wrapping.
Parameters
- canvas: Canvas
- x: number
- y: number
- width: number
- txt: string
- Default value format: number = canvas.format
Returns number

Const textLine

textLine(canvas: Canvas, x: number, y: number, line: string, format?: number): void

- Defined in text-canvas/src/text.ts:17
Writes given string at position x,y, taking the current clip rect and format into account. The string MUST not include linebreaks or other control chars.
Parameters
- canvas: Canvas
- x: number
- y: number
- line: string
- Default value format: number = canvas.format
Returns void

Const textLines

textLines(canvas: Canvas, x: number, y: number, lines: string[], format?: number): number

- Defined in text-canvas/src/text.ts:41
Parameters
- canvas: Canvas
- x: number
- y: number
- lines: string[]
- Default value format: number = canvas.format
Returns number

Const wordWrappedLines

wordWrappedLines(width: number, txt: string): string[]

- Defined in text-canvas/src/text.ts:129
Parameters
- width: number
- txt: string
Returns string[]

Generated using TypeDoc