Interface TableEntry

A markdown entry for generating tables.

Hierarchy

Properties

append pipeReplacer prefixCellValues table

Properties

Optional append

append?: string

Option which will arbitrarily append a string immediately below the table, ignoring block-level settings.

Optional pipeReplacer

pipeReplacer?: ((content: string) => string)

Type declaration

    • (content: string): string

    • Function to replace pipes in a cell's content, which is necessary to avoid breaking the table layout.

      Default Value

      Function which replaces pipe characters with the entity "|".

      Parameters

      • content: string

      Returns string

Optional prefixCellValues

prefixCellValues?: boolean

Determines whether the "prefix" specified via RenderOptions is applied to cell values or not. If set to true, every data cell (excluding table headers and the separator row) will have the prefix prepended. If set to false, then the prefix will not be included in the cells.

In any case, the prefix will be prepended to every row of the table (including header and separator rows).

Default Value

true

table

table: { columns: (string | TableColumn)[]; rows: (TableRow | TableCell[])[] }

The table row and column data, and identifying property for the renderer.

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc