assignResourceToTask(resourceKey, taskKey)
- var gantt = $("#ganttContainer").dxGantt("instance");
- gantt.assignResourceToTask("resource_key","task_key");
See Also
beginUpdate()
Prevents the UI component from refreshing until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods prevent the UI component from excessive updates when you are changing multiple UI component settings at once. After the beginUpdate() method is called, the UI component does not update its UI until the endUpdate() method is called.
See Also
defaultOptions(rule)
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
- }
- });
deleteDependency(key)
- var gantt = $("#ganttContainer").dxGantt("instance");
- gantt.deleteDependency("dependency_key");
See Also
deleteResource(key)
- var gantt = $("#ganttContainer").dxGantt("instance");
- gantt.deleteResource("resource_key");
See Also
deleteTask(key)
- var gantt = $("#ganttContainer").dxGantt("instance");
- gantt.deleteTask("task_key");
See Also
dispose()
After calling this method, remove the DOM element associated with the UI component:
- $("#myGantt").dxGantt("dispose");
- $("#myGantt").remove();
Use this method only if the UI component was created with jQuery or pure JavaScript. In Angular, Vue, and React, use conditional rendering:
See Also
exportToPdf(options) CTP
A Promise that is resolved after the Gantt chart is exported. It is a native Promise or a jQuery.Promise when you use jQuery.
The exportToPdf method allows you to save information about the Gantt chart's layout, appearance, and tasks. This method supports the following options:
- format {string | width?: number, height?: number } - Specifies the document size.
- landscape {boolean} - Specifies whether to use horizontal orientation for the document.
- fileName {string} - Specifies the file name.
- exportMode {"all", "treeList", "chart"} - Specifies which part of the component to export (chart area, tree list area, or the entire component).
- dateRange: {"all" | "visible" | startDate? : Date, endDate? : Date, startIndex? : number, endIndex? : number } - Specifies the date range for which to export tasks.
- margins { left?: number, top?: number, right?: number, bottom?: number } - Specifies the outer indents of the exported area.
Note that you should link the jspdf.js and jspdf-autotable.js libraries to your project.
Use the following settings to export the Gantt chart to a PDF document:
- var gantt = $("#ganttContainer").dxGantt("instance");
- gantt.exportToPdf({
- format: "A4",
- landscape: true,
- exportMode: "chart",
- dateRange: "visible"
- });
Use the following settings to process the PDF document when the export is complete:
- var gantt = $("#ganttContainer").dxGantt("instance");
- gantt.exportToPdf({
- format: "A4",
- landscape: true,
- exportMode: "chart",
- dateRange: "visible"
- }).then(function(doc) {
- doc.addPage();
- // your code
- doc.save('customDoc.pdf');
- });
Use the following settings to print the exported PDF document:
- var gantt = $("#ganttContainer").dxGantt("instance");
- gantt.exportToPdf({
- format: "A4",
- landscape: true,
- exportMode: "chart",
- dateRange: "visible"
- }).then(function(doc) {
- doc.autoPrint();
- window.open(doc.output('your_url'), '_blank');
- });
- var gantt = $("#ganttContainer").dxGantt("instance");
- gantt.exportToPdf({
- format: "A4",
- landscape: true,
- exportMode: "chart",
- dateRange: "visible"
- });
getDependencyData(key)
- var gantt = $("#ganttContainer").dxGantt("instance");
- gantt.getDependencyData("dependency_key");
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
getResourceAssignmentData(key)
- var gantt = $("#ganttContainer").dxGantt("instance");
- gantt.getResourceAssignmentData("res_assignment_key");
See Also
getResourceData(key)
- var gantt = $("#ganttContainer").dxGantt("instance");
- gantt.getResourceData("resource_key");
See Also
getTaskData(key)
- var gantt = $("#ganttContainer").dxGantt("instance");
- gantt.getTaskData("task_key");
See Also
getTaskResources(key)
- var gantt = $("#ganttContainer").dxGantt("instance");
- //...
- gantt.getTaskResources("task_key");
See Also
getVisibleDependencyKeys()
- var gantt = $("#ganttContainer").dxGantt("instance");
- //...
- var keys = gantt.getVisibleDependencyKeys();
See Also
getVisibleResourceAssignmentKeys()
- var gantt = $("#ganttContainer").dxGantt("instance");
- //...
- var keys = gantt.getVisibleResourceAssignmentKeys();
See Also
getVisibleResourceKeys()
- var gantt = $("#ganttContainer").dxGantt("instance");
- //...
- var keys = gantt.getVisibleResourceKeys();
See Also
getVisibleTaskKeys()
- var gantt = $("#ganttContainer").dxGantt("instance");
- //...
- var keys = gantt.getVisibleTaskKeys();
See Also
insertDependency(data)
- var gantt = $("#ganttContainer").dxGantt("instance");
- gantt.insertDependency({ predecessorId: 1, successorId: 3, type: 3 });
See Also
insertResource(data, taskKeys)
- var gantt = $("#ganttContainer").dxGantt("instance");
- // Inserts a new resource
- gantt.insertResource({ text: "New Resource" });
- // Inserts a new resource and assigns it to an individual task
- gantt.insertResource({ text: "New Resource" }, [6]);
- // Inserts a new resource and assigns it to multiple tasks
- gantt.insertResource({ text: "New Resource" }, [6,8]);
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.
- var gantt = $("#ganttContainer").dxGantt("instance");
- // Inserts a new task with the specified subject at the end of the other tasks.
- gantt.insertTask({ title: "New Task" });
- // Inserts a child task with the specified subject as a child of the task with ID = 2
- gantt.insertTask({ title: "New Task" , parentId: 2});
See Also
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
scrollToDate(date)
You can pass the date to the scrollToDate method in the following formats:
-
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).
var gantt = $("#ganttContainer").dxGantt("instance"); gantt.scrollToDate(1876800000000);
String - Specifies a date as a string value.
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.
- var gantt = $("#ganttContainer").dxGantt("instance");
- gantt.scrollToDate(new Date("December 17, 2020"));
See Also
showResourceManagerDialog()
- var gantt = $("#ganttContainer").dxGantt("instance");
- gantt.showResourceManagerDialog();
See Also
unassignResourceFromTask(resourceKey, taskKey)
- var gantt = $("#ganttContainer").dxGantt("instance");
- gantt.unassignResourceFromTask(3, 10);
See Also
updateTask(key, data)
Note that the updateTask method does not allow you to change a task's parent task.
- var gantt = $("#ganttContainer").dxGantt("instance");
- gantt.updateTask(3, {title: "New Title"});
See Also
If you have technical questions, please create a support ticket in the DevExpress Support Center.