View Objects

Views define how table data is visualized and organized. Each view has a unique identifier and a specific type that determines its layout.

Supported View Types

Type	Description
`grid`	Standard spreadsheet-like table view.
`kanban`	Board view for tracking items through stages.
`gallery`	Card-based visual gallery view.

Common View Properties

All view types share these core properties in the IView object:

Property	Type	Description
`id`	`string`	Unique identifier (UUIDv7 without dashes).
`name`	`string`	Display name of the view.
`type`	`string`	View type identifier.
`query`	`string`	The SQL query defining the data subset for this view.
`fieldIds`	`string[]`	Ordered list of field IDs (equivalent to `columnName` in the database).
`hidden_fields`	`string[]`	List of field IDs (equivalent to `columnName` in the database) to be hidden.
`filter`	`object`	Structured filter configuration.
`order_map`	`object`	Sorting configuration (mapping field IDs/columnNames to order).
`properties`	`object`	Type-specific configuration (see below).

Grid View Properties

Specific settings for the grid type:

Property	Type	Description
`fieldWidthMap`	`Record<string, number>`	Mapping of field IDs (`columnName`) to their column widths in pixels.
`freezeColumns`	`number`	Number of columns to freeze from the left side.
`columnStats`	`Record<string, ColumnStatConfig>`	Column statistics configuration (see below).

Column Statistics Configuration

The columnStats property allows you to display summary statistics at the bottom of each column. Each key is a field ID (columnName), and the value is a ColumnStatConfig object:

Property	Type	Description
`type`	`ColumnStatType`	The type of statistic to display.
`precision`	`number`	Number of decimal places for numeric results (default: 2).

Supported Statistic Types

Type	Description	Applicable Field Types
`countAll`	Count all rows	All types except `checkbox`
`countValues`	Count values (for multi-value fields, counts array elements)	All types except `checkbox`
`countUnique`	Count unique values	All types except `checkbox`
`countEmpty`	Count empty values	All types except `checkbox`
`countNotEmpty`	Count non-empty values	All types except `checkbox`
`checked`	Count checked (true) values	`checkbox`
`unchecked`	Count unchecked (false) values	`checkbox`
`percentEmpty`	Percentage of empty values	All types except `checkbox`
`percentNotEmpty`	Percentage of non-empty values	All types except `checkbox`
`percentChecked`	Percentage of checked values	`checkbox`
`percentUnchecked`	Percentage of unchecked values	`checkbox`
`sum`	Sum of numeric values	`number`, `rating`
`avg`	Average of numeric values	`number`, `rating`, `checkbox`
`min`	Minimum value	`number`, `rating`, `date`
`max`	Maximum value	`number`, `rating`, `date`
`median`	Median value	`number`, `rating`
`stdDev`	Standard deviation	`number`, `rating`
`range`	Date range (days)	`date`

Example

{
  "columnStats": {
    "price": { "type": "sum", "precision": 2 },
    "quantity": { "type": "avg" },
    "completed": { "type": "percentChecked" }
  }
}

Gallery View Properties

Specific settings for the gallery type:

Property	Type	Description
`hideEmptyFields`	`boolean`	If true, fields with no value won’t be displayed on the card.
`coverPreview`	`string \| null`	Field ID (`columnName`) to use for the card cover, or `"content"`, `"cover"`.
`fitContent`	`boolean`	If true, the cover image will be scaled to fit within the card.

Kanban View Properties

Specific settings for the kanban type:

Property	Type	Description
`groupByField`	`string`	The ID of the field (`columnName`) used to group cards into columns.
`cardSize`	`string`	Size of the cards: `"small"`, `"medium"`, or `"large"`.