Skip to content

renderTable

renderTable(frame, options?): string

Defined in: render-table.ts:21

Renders a DataFrame as aligned monospace text: an optional title, a header row, an optional rule line, the body rows, and any footnotes.

Column widths are the max of the header and every body cell’s visible (grapheme-aware) width, so styleCell/styleHeader can add ANSI codes without breaking alignment — padding is always computed from the unstyled text first. Alignment comes from each field’s measurement scale unless options.align overrides it.

DataFrame

Readonly<RenderTableOptions>

string