DayPilot.Calendar.events.filter

The events.filter() method applies a filter to the events displayed in the JavaScript Calendar component.

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

Declaration

DayPilot.Calendar.events.filter(filter)

Parameters

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

Notes

The filtering logic is defined by DayPilot.Calendar.onEventFilter, which decides which events remain visible for the supplied filter parameter.

Example

calendar.events.filter({ text: "meeting" });

See Also

DayPilot.Calendar.onEventFilter

Event Filtering [doc.daypilot.org]

DayPilot.Calendar Class

Availability

Availability of this API item in DayPilot editions:

LitePro
DayPilot for JavaScript