beginUpdate()
Postpones rendering that can negatively affect performance until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
See Also
defaultOptions(rule)
Name | Type | Description |
---|---|---|
device | | |
Device parameters. |
options |
Options to be applied. |
defaultOptions is a static method that the UI component class supports. The following code demonstrates how to specify default properties for all instances of the Gantt UI component in an application executed on the desktop.
- DevExpress.ui.dxGantt.defaultOptions({
- device: { deviceType: "desktop" },
- options: {
- // Here go the Gantt properties
- }
- });
You can also set rules for multiple device types:
- const devicesConfig = [
- { deviceType: 'desktop' },
- { deviceType: 'tablet' },
- { deviceType: 'phone' },
- ];
- devicesConfig.forEach(deviceConfig => {
- DevExpress.ui.dxGantt.defaultOptions({
- device: deviceConfig,
- options: {
- // Here go the Gantt properties
- }
- });
- });
endUpdate()
Refreshes the UI component after a call of the beginUpdate() method.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
See Also
expandAllToLevel(level)
The expandAllToLevel method first collapses all expanded tasks and then expands them to the specified hierarchical level.
See Also
expandToTask(key)
The expandToTask method expands a task's parent tasks and does not expand the task itself.
See Also
getInstance(element)
getInstance is a static method that the UI component class supports. The following code demonstrates how to get the Gantt instance found in an element with the myGantt
ID:
- // Modular approach
- import Gantt from "devextreme/ui/gantt";
- ...
- let element = document.getElementById("myGantt");
- let instance = Gantt.getInstance(element) as Gantt;
- // Non-modular approach
- let element = document.getElementById("myGantt");
- let instance = DevExpress.ui.dxGantt.getInstance(element);
See Also
insertTask(data)
The insertTask method does not update the following data fields in the data source:
Key value fields.
Fields that are not assigned to the Gantt's columns.
See Also
on(eventName, eventHandler)
Use this method to subscribe to one of the events listed in the Events section.
See Also
on(events)
Use this method to subscribe to several events with one method call. Available events are listed in the Events section.
See Also
refresh()
A Promise that is resolved after data is loaded. It is a native Promise or a jQuery.Promise when you use jQuery.
registerKeyHandler(key, handler)
A handler. Accepts the keydown event as the argument. It is a EventObject or a jQuery.Event when you use jQuery.
The key argument accepts one of the following values:
- "backspace"
- "tab"
- "enter"
- "escape"
- "pageUp"
- "pageDown"
- "end"
- "home"
- "leftArrow"
- "upArrow"
- "rightArrow"
- "downArrow"
- "del"
- "space"
- "F"
- "A"
- "asterisk"
- "minus"
A custom handler for a key cancels the default handler for this key.
See Also
repaint()
Renders the component again without reloading data. Use the method to update the component's markup and appearance dynamically.
The repaint()
method re-initializes the component with new settings, resetting its state and history.
See Also
- reload() in DataSource | List
- refresh() in DataGrid | TreeList
scrollToDate(date)
You can pass the date to the scrollToDate method in the following formats:
-
JavaScript
- var gantt = $("#ganttContainer").dxGantt("instance");
- gantt.scrollToDate(new Date("December 17, 2020"));
Number - Specifies a date as a timestamp (total milliseconds since 1970/01/01).
JavaScript- var gantt = $("#ganttContainer").dxGantt("instance");
- gantt.scrollToDate(1876800000000);
String - Specifies a date as a string value.
JavaScript- var gantt = $("#ganttContainer").dxGantt("instance");
- gantt.scrollToDate("2020/01/01");
Note that the scrollToDate method scrolls to a date inside the current scroll area. You can zoom the chart to resize the viewport.
See Also
updateTask(key, data)
Note that the updateTask method does not allow you to change a task's parent task.