Interface FilterWidgetProps Beta

FilterWidgetProps configures a filter widget — a compact, dashboard-embeddable control that lets users filter a dashboard by selecting values for a single dimension, without opening the full filter panel.

Properties

Data

attribute

attribute: Attribute

Attribute (dimension) to filter on. A query fetches all members for selection.

dataSource

dataSource?: DataSource

Data source the query runs against.

If not specified, the query will use the defaultDataSource specified in the parent Sisense Context.

dimensionFilters

dimensionFilters?: Filter[]

The widget's own dimension filters — the permanent restriction on which members this widget may select, as opposed to the transient dashboard state also present in parentFilters.

The published filter encodes them, so that selecting all values filters the dashboard by the allowed members rather than by every member of the dimension. Pass the same filters here and in parentFilters.

filter

filter?: Filter | null

Current filter state. Injected automatically when placed inside a Dashboard. For standalone use, pass explicitly.

parentFilters

parentFilters?: Filter[]

Everything that narrows the member list: the widget's own dimension filters, plus any dashboard filters the widget opted in to. Scopes the member query only.

config

config?: FilterWidgetConfig

Configuration of the widget.

filterType

filterType?: FilterWidgetFilterType

How the filter is rendered. Defaults to 'members' (searchable member-select dropdown). 'condition' renders a string condition control for text attributes, and 'calendar' a calendar for datetime attributes. Additional types will be added as they are implemented.