Interface ExportColumn

interface ExportColumn {
    dateFormat?: string;
    field?: ExportField;
    includeFiles?: boolean;
    key: string;
    label?: string;
    links?: ExportLinks;
    pick?: ExportPick;
    refAttribute?: string;
    separator?: string;
    splitBy?: number;
    sum?: boolean;
    summary?: boolean;
}

Properties

dateFormat?: string

For pick 'custom': day.js style tokens, e.g. 'D.M.YYYY H:mm'.

field?: ExportField

Defaults to 'value'.

includeFiles?: boolean

For a file column: put its files into the export, which then downloads as a ZIP of the table plus one folder per such column (up to 2 GB of files). The cells link to the files in the ZIP.

key: string

Projected attribute, or an element field such as hash, author, timestamp.

label?: string

Column header. Defaults to the key.

links?: ExportLinks

Reference and file columns. Files in the ZIP link to their path in it.

pick?: ExportPick
refAttribute?: string

For a reference (ATE) column: project this attribute out of every referenced element, e.g. room_code on a room_ate column. Each referenced element is then rendered as "identifier - value", or as the value alone with pick 'refValue'.

separator?: string

Overrides the export wide separator for this column only.

splitBy?: number

With summary: split the counts by the column at this index (pivot).

sum?: boolean

Numbers: add the column's total under the last row.

summary?: boolean

XLSX: add a sheet counting the rows per value of this column.