The update() methods updates the control after changing the properties. Refreshes the scheduler control, including headers, background cells, and events. It is also possible to update the scheduler configuration using the optional options
parameter.
DayPilot.Scheduler.update([options])
options
- object with properties and events to be updated (object)
Even if the options parameter is not specified, all changes made directly to the DayPilot.Scheduler object properties will be applied during the update.
It is possible to update Scheduler properties and events using the options
parameter.
dp.update({ separators: [{color:"red", location: new DayPilot.Date()}] });
Supported since version 2018.1.3169.
The options
object can specify any of the top-level properties. In addition to the standard properties, the following special properties are supported:
scrollTo
- scrolls to the specified date/time after update (see also scrollTo() method)
scrollX
- scrolls to the specified x position (in pixels) after update
scrollY
- scrolls to the specified y position (in pixels) after update
scrollToPosition
- the target position (as defined in scrollTo() method "position" parameter)
scrollToAnimation
- the scrolling animation (as defined in scrollTo() method "animated" parameter)
events
- the value (array of events) will be saved to events.list before update
links
- the value (array of links) will be saved to links.list before update
zoom
- index of the zoom level to be set (since 2019.2.3860)
dp.update({scrollTo: "2023-10-01"});
corresponds to
dp.update();
dp.scrollTo("2023-10-01");
dp.update({resources: [ {id: 1, name: ..... }, ... ]});
corresponds to
dp.resources = [ {id: 1, name: ..... }, ... ];
dp.update();
An optimized update is performed if the only property in the options
object is one of these properties:
separators
events
links
(since version 2023.2.5579)
rowHeaderColumns
dp.update({events: [ { id: 1, start: ... }, ... ];
This call invokes an optimized update (only the events will be reloaded and rendered).
dp.update({ separators: [{color:"red", location: new DayPilot.Date()}] });