DomainFacetSpec<TColumn, TId, TKind>
Defined in: js-api/src/domains.ts:366
One facet request of DomainFacetsSpec; id keys its result in the response.
Type Parameters
| Type Parameter | Default type |
|---|---|
TColumn extends string | string |
TId extends string | string |
TKind extends DomainFacetKind | DomainFacetKind |
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
bins? | number | 'histogram' only: bucket count (default 20, clamped to 1..200). | js-api/src/domains.ts:386 |
column? | DomainColumnRef<TColumn> | Column name; 'categories' also accepts a dotted FK path (e.g. 'category_id.name', up to 3 hops — the counts respect the referenced table's row predicate) and a declared many-to-many path ('labels.name', or 'labels.id' for the id + display-name form a checkbox list wants): those count DISTINCT OWNERS, so an owner with two labels counts once under each, and only owners with no VISIBLE link fall in the null bucket. Not used by 'count'/'plan'. | js-api/src/domains.ts:377 |
columns? | TColumn[] | 'plan' only: columns to profile (capped distinct count plus numeric/datetime min/max). | js-api/src/domains.ts:379 |
id | TId | Response key for this facet's result. | js-api/src/domains.ts:369 |
kind | TKind | - | js-api/src/domains.ts:370 |
limit? | number | 'categories' only: category cap (default 100, clamped to 1..1000); the result carries hasMore when more remain — narrow with search instead of raising the cap. | js-api/src/domains.ts:382 |
max? | string | number | 'histogram' only: pinned upper bound (see min). | js-api/src/domains.ts:391 |
min? | string | number | 'histogram' only: pinned lower bound (a number, or an ISO-8601 string for datetime columns) so zooming does not re-derive the axis; omit to bucket over the data bounds. | js-api/src/domains.ts:389 |
search? | string | 'categories' only: server-side substring narrowing (compiled as a bound ILIKE). | js-api/src/domains.ts:384 |