assignResourceToTask(resourceKey, taskKey)
- import React from 'react';
- import 'devextreme/dist/css/dx.light.css';
- import Gantt from 'devextreme-react/gantt';
- class App extends React.Component {
- constructor(props) {
- super(props);
- this.ganttRef = React.createRef();
- this.yourCustomMethod = () => {
- this.gantt.assignResourceToTask("resource_key","task_key");
- // ...
- }
- }
- get gantt() {
- return this.ganttRef.current.instance();
- }
- render() {
- return (
- <Gantt ...
- ref={this.ganttRef}>
- </Gantt>
- );
- }
- }
- export default App;
See Also
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
collapseAll()
- import React from 'react';
- import 'devextreme/dist/css/dx.light.css';
- import Gantt from 'devextreme-react/gantt';
- class App extends React.Component {
- constructor(props) {
- super(props);
- this.ganttRef = React.createRef();
- this.yourCustomMethod = () => {
- this.gantt.collapseAll();
- // ...
- }
- }
- get gantt() {
- return this.ganttRef.current.instance();
- }
- render() {
- return (
- <Gantt ...
- ref={this.ganttRef}>
- </Gantt>
- );
- }
- }
- export default App;
See Also
collapseTask(key)
- import React from 'react';
- import 'devextreme/dist/css/dx.light.css';
- import Gantt from 'devextreme-react/gantt';
- class App extends React.Component {
- constructor(props) {
- super(props);
- this.ganttRef = React.createRef();
- this.yourCustomMethod = () => {
- this.gantt.collapseTask("task_key");
- // ...
- }
- }
- get gantt() {
- return this.ganttRef.current.instance();
- }
- render() {
- return (
- <Gantt ...
- ref={this.ganttRef}>
- </Gantt>
- );
- }
- }
- export default App;
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.
- import dxGantt from "devextreme/ui/gantt";
- import Gantt from "devextreme-react/gantt";
- dxGantt.defaultOptions({
- device: { deviceType: "desktop" },
- options: {
- // Here go the Gantt properties
- }
- });
- export default function App() {
- return (
- <div>
- <Gantt id="gantt1" />
- <Gantt id="gantt2" />
- </div>
- )
- }
You can also set rules for multiple device types:
- import dxGantt from "devextreme/ui/gantt";
- import Gantt from "devextreme-react/gantt";
- const devicesConfig = [
- { deviceType: 'desktop' },
- { deviceType: 'tablet' },
- { deviceType: 'phone' },
- ];
- devicesConfig.forEach(deviceConfig => {
- dxGantt.defaultOptions({
- device: deviceConfig,
- options: {
- // Here go the Gantt properties
- }
- });
- });
- export default function App() {
- return (
- <div>
- <Gantt />
- </div>
- )
- }
deleteDependency(key)
- import React from 'react';
- import 'devextreme/dist/css/dx.light.css';
- import Gantt from 'devextreme-react/gantt';
- class App extends React.Component {
- constructor(props) {
- super(props);
- this.ganttRef = React.createRef();
- this.yourCustomMethod = () => {
- this.gantt.deleteDependency("dependency_key");
- // ...
- }
- }
- get gantt() {
- return this.ganttRef.current.instance();
- }
- render() {
- return (
- <Gantt ...
- ref={this.ganttRef}>
- </Gantt>
- );
- }
- }
- export default App;
See Also
deleteResource(key)
- import React from 'react';
- import 'devextreme/dist/css/dx.light.css';
- import Gantt from 'devextreme-react/gantt';
- class App extends React.Component {
- constructor(props) {
- super(props);
- this.ganttRef = React.createRef();
- this.yourCustomMethod = () => {
- this.gantt.deleteResource("resource_key");
- // ...
- }
- }
- get gantt() {
- return this.ganttRef.current.instance();
- }
- render() {
- return (
- <Gantt ...
- ref={this.ganttRef}>
- </Gantt>
- );
- }
- }
- export default App;
See Also
deleteTask(key)
- import React from 'react';
- import 'devextreme/dist/css/dx.light.css';
- import Gantt from 'devextreme-react/gantt';
- class App extends React.Component {
- constructor(props) {
- super(props);
- this.ganttRef = React.createRef();
- this.yourCustomMethod = () => {
- this.gantt.deleteTask("task_key");
- // ...
- }
- }
- get gantt() {
- return this.ganttRef.current.instance();
- }
- render() {
- return (
- <Gantt ...
- ref={this.ganttRef}>
- </Gantt>
- );
- }
- }
- export default App;
See Also
dispose()
Use conditional rendering instead of this method:
- import React from 'react';
- import Gantt from 'devextreme-react/gantt';
- function DxGantt(props) {
- if (!props.shouldRender) {
- return null;
- }
- return (
- <Gantt ... >
- </Gantt>
- );
- }
- class App extends React.Component {
- render() {
- return (
- <DxGantt shouldRender="condition" />
- );
- }
- }
- export default App;
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
expandAll()
- import React from 'react';
- import 'devextreme/dist/css/dx.light.css';
- import Gantt from 'devextreme-react/gantt';
- class App extends React.Component {
- constructor(props) {
- super(props);
- this.ganttRef = React.createRef();
- this.yourCustomMethod = () => {
- this.gantt.expandAll();
- // ...
- }
- }
- get gantt() {
- return this.ganttRef.current.instance();
- }
- render() {
- return (
- <Gantt ...
- ref={this.ganttRef}>
- </Gantt>
- );
- }
- }
- export default App;
See Also
expandAllToLevel(level)
The expandAllToLevel method first collapses all expanded tasks and then expands them to the specified hierarchical level.
- import React from 'react';
- import 'devextreme/dist/css/dx.light.css';
- import Gantt from 'devextreme-react/gantt';
- class App extends React.Component {
- constructor(props) {
- super(props);
- this.ganttRef = React.createRef();
- this.yourCustomMethod = () => {
- this.gantt.expandAllToLevel(3);
- // ...
- }
- }
- get gantt() {
- return this.ganttRef.current.instance();
- }
- render() {
- return (
- <Gantt ...
- ref={this.ganttRef}>
- </Gantt>
- );
- }
- }
- export default App;
See Also
expandTask(key)
The expandTask method expands a task's parent tasks and the task itself.
- import React from 'react';
- import 'devextreme/dist/css/dx.light.css';
- import Gantt from 'devextreme-react/gantt';
- class App extends React.Component {
- constructor(props) {
- super(props);
- this.ganttRef = React.createRef();
- this.yourCustomMethod = () => {
- this.gantt.expandTask("task_key");
- // ...
- }
- }
- get gantt() {
- return this.ganttRef.current.instance();
- }
- render() {
- return (
- <Gantt ...
- ref={this.ganttRef}>
- </Gantt>
- );
- }
- }
- export default App;
See Also
expandToTask(key)
The expandToTask method expands a task's parent tasks and does not expand the task itself.
- import React from 'react';
- import 'devextreme/dist/css/dx.light.css';
- import Gantt from 'devextreme-react/gantt';
- class App extends React.Component {
- constructor(props) {
- super(props);
- this.ganttRef = React.createRef();
- this.yourCustomMethod = () => {
- this.gantt.expandToTask("task_key");
- // ...
- }
- }
- get gantt() {
- return this.ganttRef.current.instance();
- }
- render() {
- return (
- <Gantt ...
- ref={this.ganttRef}>
- </Gantt>
- );
- }
- }
- export default App;
See Also
getDependencyData(key)
- import React from 'react';
- import 'devextreme/dist/css/dx.light.css';
- import Gantt from 'devextreme-react/gantt';
- class App extends React.Component {
- constructor(props) {
- super(props);
- this.ganttRef = React.createRef();
- this.yourCustomMethod = () => {
- this.gantt.getDependencyData("dependency_key");
- // ...
- }
- }
- get gantt() {
- return this.ganttRef.current.instance();
- }
- render() {
- return (
- <Gantt ...
- ref={this.ganttRef}>
- </Gantt>
- );
- }
- }
- export default App;
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)
- import React from 'react';
- import 'devextreme/dist/css/dx.light.css';
- import Gantt from 'devextreme-react/gantt';
- class App extends React.Component {
- constructor(props) {
- super(props);
- this.ganttRef = React.createRef();
- this.yourCustomMethod = () => {
- this.gantt.getResourceAssignmentData("res_assignment_key");
- // ...
- }
- }
- get gantt() {
- return this.ganttRef.current.instance();
- }
- render() {
- return (
- <Gantt ...
- ref={this.ganttRef}>
- </Gantt>
- );
- }
- }
- export default App;
See Also
getResourceData(key)
- import React from 'react';
- import 'devextreme/dist/css/dx.light.css';
- import Gantt from 'devextreme-react/gantt';
- class App extends React.Component {
- constructor(props) {
- super(props);
- this.ganttRef = React.createRef();
- this.yourCustomMethod = () => {
- this.gantt.getResourceData("resource_key");
- // ...
- }
- }
- get gantt() {
- return this.ganttRef.current.instance();
- }
- render() {
- return (
- <Gantt ...
- ref={this.ganttRef}>
- </Gantt>
- );
- }
- }
- export default App;
See Also
getTaskData(key)
- import React from 'react';
- import 'devextreme/dist/css/dx.light.css';
- import Gantt from 'devextreme-react/gantt';
- class App extends React.Component {
- constructor(props) {
- super(props);
- this.ganttRef = React.createRef();
- this.yourCustomMethod = () => {
- this.gantt.getTaskData("task_key");
- // ...
- }
- }
- get gantt() {
- return this.ganttRef.current.instance();
- }
- render() {
- return (
- <Gantt ...
- ref={this.ganttRef}>
- </Gantt>
- );
- }
- }
- export default App;
See Also
getTaskResources(key)
- import React from 'react';
- import 'devextreme/dist/css/dx.light.css';
- import Gantt from 'devextreme-react/gantt';
- class App extends React.Component {
- constructor(props) {
- super(props);
- this.ganttRef = React.createRef();
- this.yourCustomMethod = () => {
- this.gantt.getTaskResources("task_key");
- // ...
- }
- }
- get gantt() {
- return this.ganttRef.current.instance();
- }
- render() {
- return (
- <Gantt ...
- ref={this.ganttRef}>
- </Gantt>
- );
- }
- }
- export default App;
See Also
getVisibleDependencyKeys()
- import React from 'react';
- import 'devextreme/dist/css/dx.light.css';
- import Gantt from 'devextreme-react/gantt';
- class App extends React.Component {
- constructor(props) {
- super(props);
- this.ganttRef = React.createRef();
- this.yourCustomMethod = () => {
- this.gantt.getVisibleDependencyKeys();
- // ...
- }
- }
- get gantt() {
- return this.ganttRef.current.instance();
- }
- render() {
- return (
- <Gantt ...
- ref={this.ganttRef}>
- </Gantt>
- );
- }
- }
- export default App;
See Also
getVisibleResourceAssignmentKeys()
- import React from 'react';
- import 'devextreme/dist/css/dx.light.css';
- import Gantt from 'devextreme-react/gantt';
- class App extends React.Component {
- constructor(props) {
- super(props);
- this.ganttRef = React.createRef();
- this.yourCustomMethod = () => {
- this.gantt.getVisibleResourceAssignmentKeys();
- // ...
- }
- }
- get gantt() {
- return this.ganttRef.current.instance();
- }
- render() {
- return (
- <Gantt ...
- ref={this.ganttRef}>
- </Gantt>
- );
- }
- }
- export default App;
See Also
getVisibleResourceKeys()
- import React from 'react';
- import 'devextreme/dist/css/dx.light.css';
- import Gantt from 'devextreme-react/gantt';
- class App extends React.Component {
- constructor(props) {
- super(props);
- this.ganttRef = React.createRef();
- this.yourCustomMethod = () => {
- this.gantt.getVisibleResourceKeys();
- // ...
- }
- }
- get gantt() {
- return this.ganttRef.current.instance();
- }
- render() {
- return (
- <Gantt ...
- ref={this.ganttRef}>
- </Gantt>
- );
- }
- }
- export default App;
See Also
getVisibleTaskKeys()
- import React from 'react';
- import 'devextreme/dist/css/dx.light.css';
- import Gantt from 'devextreme-react/gantt';
- class App extends React.Component {
- constructor(props) {
- super(props);
- this.ganttRef = React.createRef();
- this.yourCustomMethod = () => {
- this.gantt.getVisibleTaskKeys();
- // ...
- }
- }
- get gantt() {
- return this.ganttRef.current.instance();
- }
- render() {
- return (
- <Gantt ...
- ref={this.ganttRef}>
- </Gantt>
- );
- }
- }
- export default App;
See Also
insertDependency(data)
- import React from 'react';
- import 'devextreme/dist/css/dx.light.css';
- import Gantt from 'devextreme-react/gantt';
- class App extends React.Component {
- constructor(props) {
- super(props);
- this.ganttRef = React.createRef();
- this.yourCustomMethod = () => {
- this.gantt.insertDependency({ predecessorId: 1, successorId: 3, type: 3 });
- // ...
- }
- }
- get gantt() {
- return this.ganttRef.current.instance();
- }
- render() {
- return (
- <Gantt ...
- ref={this.ganttRef}>
- </Gantt>
- );
- }
- }
- export default App;
See Also
insertResource(data, taskKeys)
- import React from 'react';
- import 'devextreme/dist/css/dx.light.css';
- import Gantt from 'devextreme-react/gantt';
- class App extends React.Component {
- constructor(props) {
- super(props);
- this.ganttRef = React.createRef();
- this.yourCustomMethod = () => {
- // Inserts a new resource
- this.gantt.insertResource({ text: "New Resource" });
- // Inserts a new resource and assigns it to an individual task
- this.gantt.insertResource({ text: "New Resource" }, [6]);
- // Inserts a new resource and assigns it to multiple tasks
- this.gantt.insertResource({ text: "New Resource" }, [6,8]);
- }
- }
- get gantt() {
- return this.ganttRef.current.instance();
- }
- render() {
- return (
- <Gantt ...
- ref={this.ganttRef}>
- </Gantt>
- );
- }
- }
- export default App;
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.
- import React from 'react';
- import 'devextreme/dist/css/dx.light.css';
- import Gantt from 'devextreme-react/gantt';
- class App extends React.Component {
- constructor(props) {
- super(props);
- this.ganttRef = React.createRef();
- this.yourCustomMethod = () => {
- // Inserts a new task with the specified subject at the end of the other tasks.
- this.gantt.insertTask({ title: "New Task" });
- // Inserts a child task with the specified subject as a child of the task with ID = 2
- this.gantt.insertTask({ title: "New Task" , parentId: 2});
- }
- }
- get gantt() {
- return this.ganttRef.current.instance();
- }
- render() {
- return (
- <Gantt ...
- ref={this.ganttRef}>
- </Gantt>
- );
- }
- }
- export default App;
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.
- import React from 'react';
- import 'devextreme/dist/css/dx.light.css';
- import Gantt from 'devextreme-react/gantt';
- class App extends React.Component {
- constructor(props) {
- super(props);
- this.ganttRef = React.createRef();
- this.yourCustomMethod = () => {
- this.gantt.refresh();
- // ...
- }
- }
- get gantt() {
- return this.ganttRef.current.instance();
- }
- render() {
- return (
- <Gantt ...
- ref={this.ganttRef}>
- </Gantt>
- );
- }
- }
- export default App;
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.
- import React from 'react';
- import 'devextreme/dist/css/dx.light.css';
- import Gantt from 'devextreme-react/gantt';
- class App extends React.Component {
- constructor(props) {
- super(props);
- this.ganttRef = React.createRef();
- this.yourCustomMethod = () => {
- this.gantt.scrollToDate(new Date("December 17, 2020"));
- // ...
- }
- }
- get gantt() {
- return this.ganttRef.current.instance();
- }
- render() {
- return (
- <Gantt ...
- ref={this.ganttRef}>
- </Gantt>
- );
- }
- }
- export default App;
See Also
showDependencies(value)
Shows or hides dependencies between tasks.
- import React from 'react';
- import 'devextreme/dist/css/dx.light.css';
- import Gantt from 'devextreme-react/gantt';
- class App extends React.Component {
- constructor(props) {
- super(props);
- this.ganttRef = React.createRef();
- this.yourCustomMethod = () => {
- this.gantt.showDependencies(false);
- // ...
- }
- }
- get gantt() {
- return this.ganttRef.current.instance();
- }
- render() {
- return (
- <Gantt ...
- ref={this.ganttRef}>
- </Gantt>
- );
- }
- }
- export default App;
See Also
- showDependencies property
- toolbar
- Gantt Elements
showResourceManagerDialog()
- import React from 'react';
- import 'devextreme/dist/css/dx.light.css';
- import Gantt from 'devextreme-react/gantt';
- const App = () => {
- const showDialog = () => {
- myGantt.current.instance().showResourceManagerDialog();
- }
- return (
- <Gantt ref={myGantt} />
- );
- }
- export default App;
See Also
showResources(value)
Shows or hides task resources.
- import React from 'react';
- import 'devextreme/dist/css/dx.light.css';
- import Gantt from 'devextreme-react/gantt';
- class App extends React.Component {
- constructor(props) {
- super(props);
- this.ganttRef = React.createRef();
- this.yourCustomMethod = () => {
- this.gantt.showResources(false);
- // ...
- }
- }
- get gantt() {
- return this.ganttRef.current.instance();
- }
- render() {
- return (
- <Gantt ...
- ref={this.ganttRef}>
- </Gantt>
- );
- }
- }
- export default App;
See Also
- showResources property
- toolbar
- Gantt Elements
showTaskDetailsDialog(taskKey)
- import React from 'react';
- import 'devextreme/dist/css/dx.light.css';
- import Gantt from 'devextreme-react/gantt';
- class App extends React.Component {
- constructor(props) {
- super(props);
- this.ganttRef = React.createRef();
- this.yourCustomMethod = () => {
- this.gantt.showTaskDetailsDialog("task_key");
- // ...
- }
- }
- get gantt() {
- return this.ganttRef.current.instance();
- }
- render() {
- return (
- <Gantt ...
- ref={this.ganttRef}>
- </Gantt>
- );
- }
- }
- export default App;
See Also
unassignAllResourcesFromTask(taskKey)
- import React from 'react';
- import 'devextreme/dist/css/dx.light.css';
- import Gantt from 'devextreme-react/gantt';
- class App extends React.Component {
- constructor(props) {
- super(props);
- this.ganttRef = React.createRef();
- this.yourCustomMethod = () => {
- this.gantt.unassignAllResourcesFromTask("task_key");
- // ...
- }
- }
- get gantt() {
- return this.ganttRef.current.instance();
- }
- render() {
- return (
- <Gantt ...
- ref={this.ganttRef}>
- </Gantt>
- );
- }
- }
- export default App;
See Also
unassignResourceFromTask(resourceKey, taskKey)
- import React from 'react';
- import 'devextreme/dist/css/dx.light.css';
- import Gantt from 'devextreme-react/gantt';
- class App extends React.Component {
- constructor(props) {
- super(props);
- this.ganttRef = React.createRef();
- this.yourCustomMethod = () => {
- this.gantt.unassignResourceFromTask(3, 10);
- // ...
- }
- }
- get gantt() {
- return this.ganttRef.current.instance();
- }
- render() {
- return (
- <Gantt ...
- ref={this.ganttRef}>
- </Gantt>
- );
- }
- }
- export default App;
See Also
updateTask(key, data)
Note that the updateTask method does not allow you to change a task's parent task.
- import React from 'react';
- import 'devextreme/dist/css/dx.light.css';
- import Gantt from 'devextreme-react/gantt';
- class App extends React.Component {
- constructor(props) {
- super(props);
- this.ganttRef = React.createRef();
- this.yourCustomMethod = () => {
- this.gantt.updateTask(3, {title: "New Title"});
- // ...
- }
- }
- get gantt() {
- return this.ganttRef.current.instance();
- }
- render() {
- return (
- <Gantt ...
- ref={this.ganttRef}>
- </Gantt>
- );
- }
- }
- export default App;
See Also
zoomIn()
- import React from 'react';
- import 'devextreme/dist/css/dx.light.css';
- import Gantt from 'devextreme-react/gantt';
- class App extends React.Component {
- constructor(props) {
- super(props);
- this.ganttRef = React.createRef();
- this.yourCustomMethod = () => {
- this.gantt.zoomIn();
- // ...
- }
- }
- get gantt() {
- return this.ganttRef.current.instance();
- }
- render() {
- return (
- <Gantt ...
- ref={this.ganttRef}>
- </Gantt>
- );
- }
- }
- export default App;
See Also
zoomOut()
- import React from 'react';
- import 'devextreme/dist/css/dx.light.css';
- import Gantt from 'devextreme-react/gantt';
- class App extends React.Component {
- constructor(props) {
- super(props);
- this.ganttRef = React.createRef();
- this.yourCustomMethod = () => {
- this.gantt.zoomOut();
- // ...
- }
- }
- get gantt() {
- return this.ganttRef.current.instance();
- }
- render() {
- return (
- <Gantt ...
- ref={this.ganttRef}>
- </Gantt>
- );
- }
- }
- export default App;
See Also
If you have technical questions, please create a support ticket in the DevExpress Support Center.