DayPilot.Scheduler.events.remove

The remove() method removes an event from the Scheduler event collection and returns an action object that can be queued or sent to the server.

Declaration

DayPilot.Scheduler.events.remove(e, data)

Parameters

  • e (DayPilot.Event) - instance to be removed

  • data (object) - custom data to be sent to the server with the Notify event

The e object has to be acquired using DayPilot.Scheduler.events.find().

Return Value

Returns a DayPilot.Action object that stores the action details.

Example

Remove an event with id "123":

const e = dp.events.find("123");
dp.events.remove(e);

See Also

DayPilot.Scheduler.events.find()

DayPilot.Scheduler Class

Client-Side Event API [doc.daypilot.org]

Availability

Availability of this API item in DayPilot editions:

LitePro
DayPilot for JavaScript