ListDisplayModel
ListDisplayModel = {
amount?:string[];badge?:string;card?:string;dots?:string[];favorite?:CardFavoriteModel;flags?:string[];footer?:string[];icon?:string;image?:string;kind:"cards";label?:string;meta?:string[];name:string;photos?:CardPhotosModel;subtitle?:string;title?:string; } | {approximate?:string;area?:string;cards?:string;defaultRadius?:number;exact?:string;icon?:string;kind:"map";label?:string;latitude:string;longitude:string;name:string;radius?:string; } | {badge?:string;by:string;icon?:string;kind:"board";label?:string;meta?:string[];name:string;subtitle?:string;title?:string; } | {end?:string;icon?:string;kind:"calendar";label?:string;name:string;start:string;title?:string; } | {component:string;fields:string[];icon?:string;kind:"custom";label:string;name:string;props?:Record<string,JsonValue>; }
Defined in: packages/schema/src/model.ts:342
A way to show a list besides its table: a card per record, its content the built-in one or a component’s (card),
a map of the records at their latitude and longitude, each opening the card of the cards display named cards
(map), or a project component (custom) drawing the rows the list page loads. A card’s amount is the first of its fields with
a value, footer its fields with a value joined by bullets, and flags boolean fields shown as small badges of their
labels when true. name is what the address names (?display=cards); label and icon are its switch’s. See
List displays.
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount?: string[]; badge?: string; card?: string; dots?: string[]; favorite?: CardFavoriteModel; flags?: string[]; footer?: string[]; icon?: string; image?: string; kind: "cards"; label?: string; meta?: string[]; name: string; photos?: CardPhotosModel; subtitle?: string; title?: string; }
amount?
Section titled “amount?”
optionalamount?:string[]
Fields of which the first with a value shows in bold, such as a price or a rent.
badge?
Section titled “badge?”
optionalbadge?:string
A field drawn as a badge with its value labels.
optionalcard?:string
The component that draws each card’s content instead of the built-in card.
optionaldots?:string[]
Related columns of the list (c.related) shown as lines of their dots at the card’s bottom, by their names.
favorite?
Section titled “favorite?”
optionalfavorite?:CardFavoriteModel
The button in the card’s top right corner that saves the record to the user’s own list, such as favorites.
flags?
Section titled “flags?”
optionalflags?:string[]
Boolean fields shown as small badges of their labels when true.
footer?
Section titled “footer?”
optionalfooter?:string[]
Fields joined by bullets on a line at the card’s bottom.
optionalicon?:string
The display’s icon in the switch.
image?
Section titled “image?”
optionalimage?:string
A file field shown as a picture across the card’s top.
kind:
"cards"
A card per record.
label?
Section titled “label?”
optionallabel?:string
The display’s name in the switch.
optionalmeta?:string[]
A few small fields, such as dates, each shown when it has a value.
name:
string
What the address names (?display=cards).
photos?
Section titled “photos?”
optionalphotos?:CardPhotosModel
Where the card’s further photos come from.
subtitle?
Section titled “subtitle?”
optionalsubtitle?:string
The line under the title.
title?
Section titled “title?”
optionaltitle?:string
The card’s title; the view’s title when omitted.
Type Literal
Section titled “Type Literal”{ approximate?: string; area?: string; cards?: string; defaultRadius?: number; exact?: string; icon?: string; kind: "map"; label?: string; latitude: string; longitude: string; name: string; radius?: string; }
approximate?
Section titled “approximate?”
optionalapproximate?:string
The boolean field that is true when the record’s position is approximate.
optionalarea?:string
The field holding the GeoJSON geometry around an approximate position: a polygon, or a line such as a street.
cards?
Section titled “cards?”
optionalcards?:string
The cards display whose card a chosen marker shows; the list’s first cards display when omitted.
defaultRadius?
Section titled “defaultRadius?”
optionaldefaultRadius?:number
The radius, in metres, of the circle around an approximate position whose record states no area or radius.
exact?
Section titled “exact?”
optionalexact?:string
The boolean field that is false when the record’s position is approximate.
optionalicon?:string
The display’s icon in the switch.
kind:
"map"
A map of the records at their position.
label?
Section titled “label?”
optionallabel?:string
The display’s name in the switch.
latitude
Section titled “latitude”latitude:
string
The filterable number field holding each record’s latitude, in decimal degrees.
longitude
Section titled “longitude”longitude:
string
The filterable number field holding each record’s longitude, in decimal degrees.
name:
string
What the address names (?display=map).
radius?
Section titled “radius?”
optionalradius?:string
The number field holding the radius, in metres, of the circle around an approximate position.
Type Literal
Section titled “Type Literal”{ badge?: string; by: string; icon?: string; kind: "board"; label?: string; meta?: string[]; name: string; subtitle?: string; title?: string; }
badge?
Section titled “badge?”
optionalbadge?:string
A field drawn as a badge with its value labels.
by:
string
The filterable enum field whose values are the columns, and which a card dragged to another column sets.
optionalicon?:string
The display’s icon in the switch.
kind:
"board"
A column per value of an enum field, a card per record in its value’s column, moved by dragging.
label?
Section titled “label?”
optionallabel?:string
The display’s name in the switch.
optionalmeta?:string[]
A few small fields, such as dates, each shown when it has a value.
name:
string
What the address names (?display=board).
subtitle?
Section titled “subtitle?”
optionalsubtitle?:string
The line under the title.
title?
Section titled “title?”
optionaltitle?:string
The card’s title; the view’s title when omitted.
Type Literal
Section titled “Type Literal”{ end?: string; icon?: string; kind: "calendar"; label?: string; name: string; start: string; title?: string; }
optionalend?:string
The filterable field of start’s type a record ends on; a record is on its start day alone when omitted.
optionalicon?:string
The display’s icon in the switch.
kind:
"calendar"
The records on the days they cover, in a month grid or a week grid, moved to another day by dragging.
label?
Section titled “label?”
optionallabel?:string
The display’s name in the switch.
name:
string
What the address names (?display=calendar).
start:
string
The filterable date or timestamp field a record starts on.
title?
Section titled “title?”
optionaltitle?:string
The event’s text; the view’s title when omitted.
Type Literal
Section titled “Type Literal”{ component: string; fields: string[]; icon?: string; kind: "custom"; label: string; name: string; props?: Record<string, JsonValue>; }
component
Section titled “component”component:
string
The component’s name, as protobase.ui.tsx registers it.
fields
Section titled “fields”fields:
string[]
The fields it shows, loaded with the names of the records relations point at.
optionalicon?:string
The display’s icon in the switch.
kind:
"custom"
The rows drawn by a project component.
label:
string
The display’s name in the switch.
name:
string
What the address names (?display=board).
props?
Section titled “props?”
optionalprops?:Record<string,JsonValue>
The plain data the component gets, with field references where it takes a field.