Skip to main content

Function: getFilterControls()

getFilterControls(catalog): FilterControl[]

Defined in: filterControls.ts:118

Projects catalog.filters into render-ready descriptors, resolving each filter's source and its metric's display hints.

Call it on a catalog that already passed validateCatalog: on an unvalidated one, a reference that resolves to nothing falls back to the raw id rather than throwing, so a broken catalog degrades to a usable — if unlabelled — control instead of an empty screen.

Parameters

ParameterTypeDescription
catalog{ collections?: object[]; datasets: object[]; domain?: string; filters: object[]; geographies: object[]; joins: object[]; mapTypes: object[]; metrics: object[]; permissions?: Record<string, unknown>; series?: object[]; version: string; }The catalog whose filters should be rendered.
catalog.collections?object[]-
catalog.datasetsobject[]-
catalog.domain?string-
catalog.filtersobject[]-
catalog.geographiesobject[]-
catalog.joinsobject[]-
catalog.mapTypesobject[]-
catalog.metricsobject[]-
catalog.permissions?Record<string, unknown>-
catalog.series?object[]-
catalog.versionstring-

Returns

FilterControl[]

One descriptor per entry in catalog.filters, in declaration order.