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.

filter

filter?: Filter | null

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

parentFilters

parentFilters?: Filter[]

Parent filters for cascading behavior. Out of scope for phase 1.

filterType

filterType?: FilterWidgetFilterType

How the filter is rendered. Defaults to 'members' (searchable member-select dropdown). Additional types will be added as they are implemented.

Default Value

'members'

isMultiselect

isMultiselect?: boolean

If true, the dropdown allows selecting multiple members.

Default Value

true

styleOptions

styleOptions?: WidgetContainerStyleOptions

Style options for the widget container (look & feel, border, shadow, etc.).

Note: the default header toolbar (info button with datasource/refresh) is always hidden for this widget — those actions do not apply to a filter control. A custom header.renderToolbar is still invoked, but receives an empty default toolbar.

title

title?: string

Widget title. Auto-populated from attribute.name if not set.