React Gantt Methods

This section describes methods that control the Gantt UI component.

assignResourceToTask(resourceKey, taskKey)

Assigns a resource to a task.

Parameters:
resourceKey:

Object

The resource key.

taskKey:

Object

The task key.

App.js
  • 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()

Collapses all tasks.

App.js
  • 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)

Collapses a task.

Parameters:
key:

Object

The task key.

App.js
  • 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)

Specifies the device-dependent default configuration properties for this component.

Parameters:
rule:

Object

The component's default device properties.

Object structure:
Name Type Description
device

Device

|

Function

Device parameters.
When you specify a function, get information about the current device from the argument. Return true if the properties should be applied to the device.

options

Object

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)

Deletes a dependency.

Parameters:
key:

Object

The dependency key.

App.js
  • 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)

Deletes a resource.

Parameters:
key:

Object

The resource key.

App.js
  • 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)

Deletes a task.

Parameters:
key:

Object

The task key.

App.js
  • 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()

Disposes of all the resources allocated to the Gantt instance.

Use conditional rendering instead of this method:

App.js
  • 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;

element()

Gets the root UI component element.

Return Value:

HTMLElement | jQuery

An HTML element or a jQuery element when you use jQuery.

See Also

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()

Expands all tasks.

App.js
  • 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)

Expands all tasks down to the specified hierarchical level.

Parameters:
level:

Number

The hierarchical level.

The expandAllToLevel method first collapses all expanded tasks and then expands them to the specified hierarchical level.

App.js
  • 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)

Expands a task.

Parameters:
key:

Object

The task key.

The expandTask method expands a task's parent tasks and the task itself.

App.js
  • 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)

Expands a task's parent tasks.

Parameters:
key:

Object

The task key.

The expandToTask method expands a task's parent tasks and does not expand the task itself.

App.js
  • 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

focus()

Sets focus on the UI component.

See Also

getDependencyData(key)

Gets the dependency data.

Parameters:
key:

Object

The dependency key.

Return Value:

Object

The dependency data.

App.js
  • 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)

Gets the instance of a UI component found using its DOM node.

Parameters:
element:

Element

|

jQuery

The UI component's container.

Return Value:

Object

The UI component's instance.

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)

Gets the resource assignment data.

Parameters:
key:

Object

The resource assignment key.

Return Value:

Object

The resource assignment data.

App.js
  • 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)

Gets the resource data.

Parameters:
key:

Object

The resource key.

Return Value:

Object

The resource data.

App.js
  • 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)

Gets the task data.

Parameters:
key:

Object

The task key.

Return Value:

Object

The task data.

App.js
  • 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)

Gets resources assigned to a task.

Parameters:
key:

Object

The task's key.

Return Value:

Array<Object>

The resources.

App.js
  • 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()

Gets the keys of the visible dependencies.

Return Value:

Array<Object>

The keys.

App.js
  • 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()

Gets the keys of the visible resource assignments.

Return Value:

Array<Object>

The keys.

App.js
  • 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()

Gets the keys of the visible resources.

Return Value:

Array<Object>

The keys.

App.js
  • 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()

Gets the keys of the visible tasks.

Return Value:

Array<Object>

The keys.

App.js
  • 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)

Inserts a new dependency.

Parameters:
data:

Object

The dependency data.

App.js
  • 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)

Inserts a new resource.

Parameters:
data:

Object

The resource data.

taskKeys?:

Array<Object>

An array of task keys.

App.js
  • 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)

Inserts a new task.

Parameters:
data:

Object

The task 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.

App.js
  • 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

instance()

Gets the UI component's instance. Use it to access other methods of the UI component.

Return Value:

Gantt

This UI component's instance.

See Also

off(eventName)

Detaches all event handlers from a single event.

Parameters:
eventName:

String

The event's name.

Return Value:

Gantt

The object for which this method is called.

See Also

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

Parameters:
eventName:

String

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

Gantt

The object for which this method is called.

See Also

on(eventName, eventHandler)

Subscribes to an event.

Parameters:
eventName:

String

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

Gantt

The object for which this method is called.

Use this method to subscribe to one of the events listed in the Events section.

See Also

on(events)

Subscribes to events.

Parameters:
events:

Object

Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}

Return Value:

Gantt

The object for which this method is called.

Use this method to subscribe to several events with one method call. Available events are listed in the Events section.

See Also

option()

Return Value:

Object

The UI component's properties.

option(optionName)

Gets the value of a single property.

Parameters:
optionName:

String

The property's name or full path.

Return Value: any

This property's value.

option(optionName, optionValue)

Updates the value of a single property.

Parameters:
optionName:

String

The property's name or full path.

optionValue: any

This property's new value.

option(options)

Updates the values of several properties.

Parameters:
options:

Object

Options with their new values.

refresh()

Reloads data and repaints the Gantt component.

Return Value:

Promise<void> (jQuery or native)

A Promise that is resolved after data is loaded. It is a native Promise or a jQuery.Promise when you use jQuery.

App.js
  • 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)

Registers a handler to be executed when a user presses a specific key.

Parameters:
key:

String

A key.

handler:

Function

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.

View on GitHub

See Also

resetOption(optionName)

Resets a property to its default value.

Parameters:
optionName:

String

A property's name.

See Also

scrollToDate(date)

Scrolls the Gantt chart to the specified date.

Parameters:
date:

Date

|

Number

|

String

The date.

You can pass the date to the scrollToDate method in the following formats:

  • Date

    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.

NOTE
Specify a timeout if you call the scrollToDate method in the contentReady event.
App.js
  • 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.

Parameters:
value:

Boolean

Specifies whether to show or hide dependencies.

DevExtreme Gantt Chart - Dependencies

App.js
  • 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

showResourceManagerDialog()

Invokes the "Resource Manager" dialog.

DevExtreme Gantt - Invoke Resource Manager

App.js
  • 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.

Parameters:
value:

Boolean

Specifies whether to show or hide task resources.

DevExtreme Gantt Chart - Resources

App.js
  • 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

showTaskDetailsDialog(taskKey)

Invokes the "Task Details" dialog.

Parameters:
taskKey:

Object

A task key.

DevExtreme Gantt Chart - Task Edit Dialog

App.js
  • 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)

Removes all resources from the task.

Parameters:
taskKey:

Object

The task key.

DevExtreme Gantt Chart - Resources

App.js
  • 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)

Removes a resource from the task.

Parameters:
resourceKey:

Object

The resource key.

taskKey:

Object

The task key.

DevExtreme Gantt Chart - Resources

App.js
  • 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

updateDimensions()

Updates the dimensions of the UI component contents.

See Also

updateTask(key, data)

Updates the task data.

Parameters:
key:

Object

The task key.

data:

Object

The task data.

Note that the updateTask method does not allow you to change a task's parent task.

App.js
  • 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()

Zooms in the Gantt chart.

App.js
  • 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()

Zooms out the Gantt chart.

App.js
  • 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