DayPilot.Scheduler.events.filter

The events.filter() method applies a filter to the events in the JavaScript Scheduler.

After the filter is applied, the Scheduler updates the event list and selectively hides events according to the criteria implemented in DayPilot.Scheduler.onEventFilter.

Declaration

DayPilot.Scheduler.events.filter(filter)

Parameters

  • filter (object | null) - custom filter object passed to DayPilot.Scheduler.onEventFilter as args.filterParam; use null to clear the filter and display all events

Notes

The structure of the filter object is up to your application. The DayPilot.Scheduler.onEventFilter event handler receives it for each event and decides whether the event remains visible.

Example

dp.events.filter({ hide: true });

See Also

DayPilot.Scheduler.onEventFilter

Event Filtering [doc.daypilot.org]

DayPilot.Scheduler Class

Availability

Availability of this API item in DayPilot editions:

LitePro
DayPilot for JavaScript