ListModel

ListModel = object

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

A view’s list page (.list(...)).

Properties

columns

columns: string[]

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

The table’s columns, in order.

---

default?

optional default?: string

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

The display the list opens in when the address names none; the table when omitted.

---

displays?

optional displays?: ListDisplayModel[]

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

Other ways to show the list besides its table, in the order the switch shows them after it.

---

editable?

optional editable?: string[]

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

The fields among columns edited in their cell, by a user who may change the record and the field; see Editing in the list.

---

filter?

optional filter?: string

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

An AIP-160 filter the list opens with when its address names none; the person can clear or change it, and a link’s own filter replaces it.

---

relatedColumns?

optional relatedColumns?: RelatedColumnModel[]

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

The columns of related records among columns, each named there by its name.

---

search?

optional search?: string[]

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

Defaults for the UI’s search box. ResourceModel.search is authoritative for what search(...) matches on the server.

---

sort?

optional sort?: SortSpec

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

The order the list starts in.