DayPilot.Calendar.loadingStart

The loadingStart() method displays the loading label in the upper-left corner of the JavaScript Calendar.

Declaration

DayPilot.Calendar.loadingStart(options);

Parameters

The options parameter is available since 2023.4.5820.

  • options.delay (number) - the label is displayed only if loadingStop() is not called within the specified number of milliseconds

  • options.text (string) - label text; if not specified, the value of loadingLabelText is used, but only when loadingLabelVisible is true

  • options.block (boolean) - whether to block the UI using an overlay <div>; if not specified, the blockOnCallBack value is used

Notes

You can use this method to indicate that an HTTP call is in progress. To hide the message again, call loadingStop(), usually when the HTTP response arrives.

Example

dp.loadingStart();

const { data } = await DayPilot.Http.get("/events");
dp.update({ events: data });

dp.loadingStop();

See Also

DayPilot.Calendar.loadingLabelVisible

DayPilot.Calendar.loadingStop()

Loading Label [doc.daypilot.org]

DayPilot.Calendar Class

Availability

Availability of this API item in DayPilot editions:

LitePro
DayPilot for JavaScript