WidgetFilter  type: widget

class lumen.filters.base.WidgetFilter(*, empty_select, max_options, multi, widget, default, disabled, throttled, visible, field, label, schema, shared, sync_with_url, table, value, name)

WidgetFilter generates a Widget from the table schema provided by a Source.

By default the widget type will be inferred from the data and depending on whether multi value selection is enabled.

---

Parameters

default

type: Any
default: None
The default value to use on the widget.

disabled

type: bool
default: False
Whether the filter should be disabled.

empty_select

type: bool
default: True
Add an option to Select widgets to indicate no filtering.

max_options

type: int
default: 500
bounds: None
Maximum number of options to render.

multi

type: bool
default: True
Whether to use a single-value or multi-value selection widget,e.g. for a numeric value this could be a regular slider or arange slider.

throttled

type: bool
default: True
If the widget has a value_throttled parameter use that instead,ensuring that no intermediate events are generated, e.g. whendragging a slider.

visible

type: bool
default: True
Whether the filter should be visible.

widget

type: panel.widgets.Widget
default: None
The widget instance. When declared in a specification a fullmodule path to a Panel widget class can be provided to overridethe default inferred widget.

---

Methods

WidgetFilter.to_spec(context: Dict[str, Any] | None = None) → Dict[str, Any]

Exports the full specification to reconstruct this component.

Return type:

Resolved and instantiated Component object