Interface Column

A table column.

interface Column {
    align?: ColumnAlign;
    dataSetFields: readonly string[];
    formatterId: string;
    formatterOptions?: Record<string, any>;
    name: string;
    renderType?: "text" | "mail" | "link";
    sortable: boolean;
    sortFormattedValue?: "string" | "string-with-number";
    title: string;
}

Properties

align? dataSetFields formatterId formatterOptions? name renderType? sortable sortFormattedValue? title

Properties

Optional Readonlyalign

align?: ColumnAlign

Column alignment

ReadonlydataSetFields

dataSetFields: readonly string[]

Referenced data set fields.

ReadonlyformatterId

formatterId: string

Id of a formatter.

Optional ReadonlyformatterOptions

formatterOptions?: Record<string, any>

Options for the formatter identified by formatterId;

Readonlyname

name: string

Name of the column.

Optional ReadonlyrenderType

renderType?: "text" | "mail" | "link"

Column special names for UI rendering

Readonlysortable

sortable: boolean

Specifies if this column is sortable.

Optional ReadonlysortFormattedValue

sortFormattedValue?: "string" | "string-with-number"

Specifies if this column should be sorted by its original value or by its formatted display value. The following values are allowed:

  • undefined (default): The column is sorted by its original value.
  • string: The column is sorted by its formatted display value as a string.
  • string-with-number: The column is sorted by its formatted display value, whereby numeric parts are sorted as numbers. Example: "a1" < "a2" < "a10".

Readonlytitle

title: string

Title of the column.

Settings

Member Visibility

On This Page

Properties