DateFilter  type: date#

class lumen.filters.base.DateFilter(*, mode, multi, default, disabled, throttled, visible, field, label, schema, shared, sync_with_url, table, value, name)#

DateFilter is a WidgetFilter specialized to select calendar dates.

Depending on whether multi selection is enabled a single date or range of dates can be selected with a DatePicker or DateRangeSlider respectively.


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.

mode

type: Any
default: 'slider'
Possible values: 'slider' | 'picker'
Whether to use a slider or a picker.

multi

type: bool
default: True
Whether to use a single-value or multi-value/range selection widget.

throttled

type: bool
default: True
Whether to throttle slider value changes.

visible

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


Methods#

DateFilter.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