Interface ExportRequest

interface ExportRequest {
    alsoPublic?: boolean;
    columns: ExportColumn[];
    configHeader?: boolean;
    filesLayout?: ExportFilesLayout;
    format: ExportFormat;
    labels?: { count?: string; empty?: string; total?: string };
    query: Record<string, unknown>;
    separator?: string;
    timezone?: string;
    valueLabels?: Record<string, Record<string, string>>;
}

Properties

alsoPublic? columns configHeader? filesLayout? format labels? query separator? timezone? valueLabels?

Properties

OptionalalsoPublic

alsoPublic?: boolean

columns

columns: ExportColumn[]

OptionalconfigHeader

configHeader?: boolean

Write a first header row describing each column (key, field, pick, links), above the labels.

OptionalfilesLayout

filesLayout?: ExportFilesLayout

format

format: ExportFormat

Optionallabels

labels?: { count?: string; empty?: string; total?: string }

Words written into the file, in the user's language.

query

query: Record<string, unknown>

The listing query, in the same shape the listing itself sends.

Optionalseparator

separator?: string

Joins multiple values in one cell. Defaults to ', '.

Optionaltimezone

timezone?: string

IANA name, e.g. 'Europe/Prague'. Dates are formatted in it.

OptionalvalueLabels

valueLabels?: Record<string, Record<string, string>>

attribute -> stored value -> label, for dropdown columns.

Settings

Member Visibility

On This Page

Properties