Interface DateFilter

The DateFilter controller makes it possible to create a date filter.

Example: date-filter.fn.tsx

interface DateFilter {
    state: DateFilterState;
    clear(): void;
    disable(): void;
    enable(): void;
    setRange(range: DateFilterRange): boolean;
    subscribe(listener: () => void): Unsubscribe;
}

Hierarchy (View Summary)

Methods

clear disable enable setRange subscribe

Properties

state

Methods

clear

  • clear(): void

    Clears the current filter.

    Returns void

disable

  • disable(): void

    Disables the filter. I.e., prevents it from filtering results.

    Returns void

enable

  • enable(): void

    Enables the filter. I.e., undoes the effects of disable.

    Returns void

setRange

  • setRange(range: DateFilterRange): boolean

    Updates the selected range.

    You can use the buildDateRange utility method in order to format the range values correctly.

    Parameters

    Returns boolean

    Whether the range is valid.

subscribe

  • subscribe(listener: () => void): Unsubscribe

    Adds a callback that's invoked on state change.

    Parameters

    • listener: () => void

      A callback that's invoked on state change.

    Returns Unsubscribe

    A function to remove the listener.

Properties

state

state: DateFilterState

The state of the DateFilter controller.

Settings

Member Visibility

On This Page

Methods
Properties