DayPilot.Scheduler.loadingStart

The loadingStart() method displays a loading label in the upper-left corner of the JavaScript Scheduler. Optionally, you can block the whole Scheduler UI.

You can use this method to indicate that an HTTP call is in progress.

• Loading label text: To display the loading label, the loadingLabelVisible property must be set to true or you must provide the text using options.text.

• Blocking the UI: If blockOnCallBack property is set to true (the default value is false) the loadingStart() method will display an overlay <div> element over the Scheduler to prevent access to the UI.

To hide the message and unblock the UI, call the loadingStop() method. Usually, this is done when the HTTP response arrives.

Declaration

DayPilot.Scheduler.loadingStart(options);

Parameters

The options parameter is available since 2020.2.4337.

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

• options.text (string) - label text; if not specified, loadingLabelText will be used (but only if loadingLabelVisible is set to true)

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

See Also

• blockOnCallBack

• loadingLabelVisible

• loadingStop()

Example

dp.loadingStart({ delay: 100, text: "Please wait...", block: true});

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