Interface CollectionField

One column of a portfolio schema (a /CollectionField).

interface CollectionField {
    key: string;
    name?: string;
    subtype?: CollectionFieldSubtype;
    order?: number;
    visible?: boolean;
}

Properties

key: string

The schema key; per-file CollectionItem.values reference it.

name?: string

The displayed column header (/N). Defaults to key when omitted.

The column data type (/Subtype). Defaults to "text".

order?: number

The relative ordering (/O); columns are shown in ascending order.

visible?: boolean

/V — whether the column is initially visible (default true).