Skip to content

RelatedColumnModel

RelatedColumnModel = object

Defined in: packages/schema/src/model.ts:590

A list column of the records of another resource that point at each row, directly or through a join resource, as a dot per record in its status’s colour, each opening the record (c.related(...)). See Related records in a list.

field: string

Defined in: packages/schema/src/model.ts:598

The filterable field of resource matched against the row’s key, or with through against the join records’ keys.


optional filter?: string

Defined in: packages/schema/src/model.ts:602

An AIP-160 filter on the shown records.


optional label?: string

Defined in: packages/schema/src/model.ts:594

The column’s header; the name in words when omitted.


name: string

Defined in: packages/schema/src/model.ts:592

The column’s name in the list’s columns, which no field of the resource has.


resource: string

Defined in: packages/schema/src/model.ts:596

The resource whose records it shows.


optional sort?: string

Defined in: packages/schema/src/model.ts:604

An AIP-132 order of the dots.


status: string

Defined in: packages/schema/src/model.ts:606

The enum field of resource whose value colours each dot, by its view’s valueColors.


optional through?: RelatedModel["through"]

Defined in: packages/schema/src/model.ts:600

The join records between the row and the shown ones, as a related section’s.