Skip to content

pivotick v3.0.0


pivotick / Pivot / PivotFacet

Interface: PivotFacet ​

Defined in: interfaces/Pivot.ts:328

One narrowing control, declared by the provider and rendered by the library — the same facet vocabulary the filter panel speaks.

Properties ​

default? ​

optional default: string | boolean | string[]

Defined in: interfaces/Pivot.ts:342

What the provider does when this key is absent from the narrowing, drawn as the facet's starting value and the value Clear narrowing returns to. A multiselect takes the picked option values, a select one value, a boolean true or false. The key is still left out of the narrowing while the facet holds its default, so the provider must treat "absent" as this value. An emptied multiselect with a default is sent as [], meaning none.


key ​

key: string

Defined in: interfaces/Pivot.ts:329


label ​

label: string

Defined in: interfaces/Pivot.ts:330


options? ​

optional options: object[]

Defined in: interfaces/Pivot.ts:333

For select / multiselect. A count is shown beside the option when given.

count? ​

optional count: number

label ​

label: string

value ​

value: string


type ​

type: NarrowingFacetType

Defined in: interfaces/Pivot.ts:331