Skip to main content

Class: TableBuilder<Row>

Defined in: packages/sdvtables/src/define.ts:248

Type Parameters​

Row​

Row

Constructors​

Constructor​

new TableBuilder<Row>(s): TableBuilder<Row>

Defined in: packages/sdvtables/src/define.ts:249

Parameters​

s​

TableSpec<Row>

Returns​

TableBuilder<Row>

Methods​

boldRows()​

boldRows(rows, o?): TableBuilder<Row>

Defined in: packages/sdvtables/src/define.ts:311

Parameters​

rows​

RowSelector<Row>

o?​

Partial<Omit<D<Row, "boldRows">, "type" | "rows">> = {}

Returns​

TableBuilder<Row>

borderBars()​

borderBars(side, colors, o?): TableBuilder<Row>

Defined in: packages/sdvtables/src/define.ts:342

Parameters​

side​

"top" | "bottom"

colors​

readonly string[]

o?​

Partial<Omit<D<Row, "borderBars">, "type" | "side" | "colors">> = {}

Returns​

TableBuilder<Row>

borderGrid()​

borderGrid(o?): TableBuilder<Row>

Defined in: packages/sdvtables/src/define.ts:339

Parameters​

o?​

Partial<Omit<D<Row, "borderGrid">, "type">> = {}

Returns​

TableBuilder<Row>

build()​

build(): TableSpec<Row>

Defined in: packages/sdvtables/src/define.ts:483

Returns​

TableSpec<Row>

caption538()​

caption538(o?): TableBuilder<Row>

Defined in: packages/sdvtables/src/define.ts:288

Parameters​

o?​

Partial<Omit<D<Row, "caption538">, "type">> = {}

Returns​

TableBuilder<Row>

columns()​

columns(fn): TableBuilder<Row>

Defined in: packages/sdvtables/src/define.ts:260

Parameters​

fn​

(c) => readonly ColumnSpec<Row>[]

Returns​

TableBuilder<Row>

cutline()​

cutline(after, o?): TableBuilder<Row>

Defined in: packages/sdvtables/src/define.ts:323

Parameters​

after​

number | readonly number[]

o?​

Partial<Omit<D<Row, "cutline">, "type" | "after">> = {}

Returns​

TableBuilder<Row>

font()​

font(family, o?): TableBuilder<Row>

Defined in: packages/sdvtables/src/define.ts:480

Parameters​

family​

string

o?​

Partial<Omit<D<Row, "font">, "type" | "family">> = {}

Returns​

TableBuilder<Row>

groupBy()​

groupBy(key): TableBuilder<Row>

Defined in: packages/sdvtables/src/define.ts:291

Parameters​

key​

keyof Row & string

Returns​

TableBuilder<Row>

groupStripes()​

groupStripes(o?): TableBuilder<Row>

Defined in: packages/sdvtables/src/define.ts:294

Parameters​

o?​

Partial<Omit<D<Row, "groupStripes">, "type">> = {}

Returns​

TableBuilder<Row>

id()​

id(id): TableBuilder<Row>

Defined in: packages/sdvtables/src/define.ts:253

Parameters​

id​

string

Returns​

TableBuilder<Row>

legendContinuous()​

legendContinuous(o?): TableBuilder<Row>

Defined in: packages/sdvtables/src/define.ts:367

Parameters​

o?​

Partial<Omit<D<Row, "legendContinuous">, "type">> = {}

Returns​

TableBuilder<Row>

legendDiscrete()​

legendDiscrete(key, o?): TableBuilder<Row>

Defined in: packages/sdvtables/src/define.ts:379

Parameters​

key​

Readonly<Record<string, string>> | "recorded"

o?​

Partial<Omit<D<Row, "legendDiscrete">, "type" | "key">> = {}

Returns​

TableBuilder<Row>

marginalia()​

marginalia(columns, o?): TableBuilder<Row>

Defined in: packages/sdvtables/src/define.ts:453

Parameters​

columns​

readonly keyof Row & string[]

o?​

Partial<Omit<D<Row, "marginalia">, "type" | "columns">> = {}

Returns​

TableBuilder<Row>

outliers()​

outliers(columns, o?): TableBuilder<Row>

Defined in: packages/sdvtables/src/define.ts:412

Parameters​

columns​

readonly keyof Row & string[]

o?​

Partial<Omit<D<Row, "outliers">, "type" | "columns">> = {}

Returns​

TableBuilder<Row>

rowAccent()​

rowAccent(key, o?): TableBuilder<Row>

Defined in: packages/sdvtables/src/define.ts:297

Parameters​

key​

keyof Row & string

o?​

Partial<Omit<D<Row, "rowAccent">, "type" | "key">> = {}

Returns​

TableBuilder<Row>

rowKey()​

rowKey(key): TableBuilder<Row>

Defined in: packages/sdvtables/src/define.ts:257

J31: the link id column (see TableSpec.rowKey).

Parameters​

key​

keyof Row & string

Returns​

TableBuilder<Row>

scaleNote()​

scaleNote(columns, o?): TableBuilder<Row>

Defined in: packages/sdvtables/src/define.ts:418

Parameters​

columns​

readonly keyof Row & string[]

o?​

Partial<Omit<D<Row, "scaleNote">, "type" | "columns">> = {}

Returns​

TableBuilder<Row>

significance()​

significance(pairs, o?): TableBuilder<Row>

Defined in: packages/sdvtables/src/define.ts:397

Parameters​

pairs​

readonly object[]

o?​

Partial<Omit<D<Row, "significance">, "type" | "pairs">> = {}

Returns​

TableBuilder<Row>

snake()​

snake(o?): TableBuilder<Row>

Defined in: packages/sdvtables/src/define.ts:469

Parameters​

o?​

Partial<Omit<D<Row, "snake">, "type">> = {}

Returns​

TableBuilder<Row>

socialTag()​

socialTag(accounts, o?): TableBuilder<Row>

Defined in: packages/sdvtables/src/define.ts:424

Parameters​

accounts​

Readonly<Record<string, string>>

o?​

Partial<Omit<D<Row, "socialTag">, "type" | "accounts">> = {}

Returns​

TableBuilder<Row>

sourceNote()​

sourceNote(html, o?): TableBuilder<Row>

Defined in: packages/sdvtables/src/define.ts:285

Parameters​

html​

string

o?​
unsafe?​

boolean

Returns​

TableBuilder<Row>

spotlight()​

spotlight(rows, o?): TableBuilder<Row>

Defined in: packages/sdvtables/src/define.ts:317

Parameters​

rows​

RowSelector<Row>

o?​

Partial<Omit<D<Row, "spotlight">, "type" | "rows">> = {}

Returns​

TableBuilder<Row>

subtitle()​

subtitle(text): TableBuilder<Row>

Defined in: packages/sdvtables/src/define.ts:279

Parameters​

text​

string

Returns​

TableBuilder<Row>

theme()​

theme(name, o?): TableBuilder<Row>

Defined in: packages/sdvtables/src/define.ts:263

Parameters​

name​

string

o?​
density?​

Density

options?​

Readonly<Record<string, string>>

Returns​

TableBuilder<Row>

tiers()​

tiers(levels, tierKey, imageColumns, o?): TableBuilder<Row>

Defined in: packages/sdvtables/src/define.ts:472

Parameters​

levels​

readonly string[]

tierKey​

keyof Row & string

imageColumns​

readonly keyof Row & string[]

o?​

Partial<Omit<D<Row, "tiers">, "type" | "levels" | "tierKey" | "imageColumns">> = {}

Returns​

TableBuilder<Row>

title()​

title(text): TableBuilder<Row>

Defined in: packages/sdvtables/src/define.ts:276

Parameters​

text​

string

Returns​

TableBuilder<Row>

titleHeader()​

titleHeader(title, o?): TableBuilder<Row>

Defined in: packages/sdvtables/src/define.ts:282

Parameters​

title​

string

o?​

Omit<D<Row, "titleHeader">, "type" | "title"> = {}

Returns​

TableBuilder<Row>

watermark()​

watermark(o?): TableBuilder<Row>

Defined in: packages/sdvtables/src/define.ts:438

Parameters​

o?​

Partial<Omit<D<Row, "watermark">, "type">> = {}

Returns​

TableBuilder<Row>

wrapLabels()​

wrapLabels(o?): TableBuilder<Row>

Defined in: packages/sdvtables/src/define.ts:450

Parameters​

o?​

Partial<Omit<D<Row, "wrapLabels">, "type">> = {}

Returns​

TableBuilder<Row>