Skip to main content

Interface: FilterControl

Defined in: filterControls.ts:44

Everything a UI needs to render one filter, with catalog references already resolved — so a component maps over these instead of walking the catalog and cross-referencing datasets, geographies and metrics itself.

Properties​

control​

control: FilterControlKind

Defined in: filterControls.ts:51

Widget to render, derived from kind and whether multiple values are allowed.

description?​

optional description?: string

Defined in: filterControls.ts:47

domain​

domain: object

Defined in: filterControls.ts:56

mode​

mode: "runtime"

formatter?​

optional formatter?: "number" | "percent" | "currency" | "compact"

Defined in: filterControls.ts:60

Formatting hint for displaying bounds and values, inherited from metricId.

id​

id: string

Defined in: filterControls.ts:45

kind​

kind: "temporal" | "categorical" | "numeric"

Defined in: filterControls.ts:49

Data type of the filtered property.

label​

label: string

Defined in: filterControls.ts:46

operators​

operators: ("in" | "eq" | "neq" | "gt" | "gte" | "lt" | "lte" | "not-in")[]

Defined in: filterControls.ts:55

property​

property: string

Defined in: filterControls.ts:53

Feature property the emitted predicate reads.

requiresData​

requiresData: boolean

Defined in: filterControls.ts:65

true when domain.mode is 'runtime' — the control cannot render its options or bounds until computeFilterDomain is called with the data.

source​

source: FilterControlSource

Defined in: filterControls.ts:54

unit?​

optional unit?: string

Defined in: filterControls.ts:58

Unit of the filtered measure, inherited from metricId when declared.