All docs
V20.2
20.2
20.1
19.2
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.
17.1
The page you are viewing does not exist in version 17.1. This link will take you to the root page.
16.2
The page you are viewing does not exist in version 16.2. This link will take you to the root page.
Box
Map
Vue

Methods

This section describes methods that control the Gantt widget.

assignResourceToTask(resourceKey, taskKey)

Assigns a resource to a task.

Parameters:
resourceKey:

Object

The resource key.

taskKey:

Object

The task key.

jQuery
index.js
var gantt = $("#ganttContainer").dxGantt("instance");
gantt.assignResourceToTask("resource_key","task_key");
See Also

beginUpdate()

Prevents the widget from refreshing until the endUpdate() method is called.

The beginUpdate() and endUpdate() methods prevent the widget from excessive updates when you are changing multiple widget settings at once. After the beginUpdate() method is called, the widget does not update its UI until the endUpdate() method is called.

See Also

defaultOptions(rule)

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

Parameters:
rule:

Object

The component's default device options.

Object structure:
Name Type Description
device

Device

|

Array<Device>

|

Function

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

options

Object

Options to be applied.

defaultOptions is a static method that the widget class supports. The following code demonstrates how to specify default options for all instances of the Gantt widget in an application executed on the desktop.

jQuery
JavaScript
DevExpress.ui.dxGantt.defaultOptions({ 
    device: { deviceType: "desktop" },
    options: {
        // Here go the Gantt options
    }
});
Angular
TypeScript
import Gantt from "devextreme/ui/gantt";
// ...
export class AppComponent {
    constructor () {
        Gantt.defaultOptions({
            device: { deviceType: "desktop" },
            options: {
                // Here go the Gantt options
            }
        });
    }
}
Vue
<template>
    <div>
        <DxGantt id="gantt1" />
        <DxGantt id="gantt2" />
    </div>
</template>
<script>
import DxGantt from "devextreme-vue/gantt";
import Gantt from "devextreme/ui/gantt";

Gantt.defaultOptions({
    device: { deviceType: "desktop" },
    options: {
        // Here go the Gantt options
    }
});

export default {
    components: {
        DxGantt
    }
}
</script>
React
import React from "react";
import dxGantt from "devextreme/ui/gantt";
import Gantt from "devextreme-react/gantt";

class App extends React.Component {
    render () {
        dxGantt.defaultOptions({
            device: { deviceType: "desktop" },
            options: {
                // Here go the Gantt options
            }
        })
        return (
            <div>
                <Gantt id="gantt1" />
                <Gantt id="gantt2" />
            </div>
        )
    }
}

export default App;

deleteDependency(key)

Deletes a dependency.

Parameters:
key:

Object

The dependency key.

jQuery
index.js
var gantt = $("#ganttContainer").dxGantt("instance");
gantt.deleteDependency("dependency_key");
See Also

deleteResource(key)

Deletes a resource.

Parameters:
key:

Object

The resource key.

jQuery
index.js
var gantt = $("#ganttContainer").dxGantt("instance");
gantt.deleteResource("resource_key");
See Also

deleteTask(key)

Deletes a task.

Parameters:
key:

Object

The task key.

jQuery
index.js
var gantt = $("#ganttContainer").dxGantt("instance");
gantt.deleteTask("task_key");
See Also

dispose()

Disposes of all the resources allocated to the Gantt instance.

After calling this method, remove the DOM element associated with the widget:

JavaScript
$("#myGantt").dxGantt("dispose");
$("#myGantt").remove();

Use this method only if the widget was created with jQuery or pure JavaScript. In Angular, Vue, and React, use conditional rendering:

Angular
app.component.html
<dx-gantt ...
    *ngIf="condition">
</dx-gantt>
Vue
App.vue
<template>
    <DxGantt ...
        v-if="condition">
    </DxGantt>
</template>

<script>
import DxGantt from 'devextreme-vue/gantt';

export default {
    components: {
        DxGantt
    }
}
</script>
React
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;
See Also

element()

Gets the root widget element.

Return Value:

HTMLElement or jQuery

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

See Also

endUpdate()

Refreshes the widget after a call of the beginUpdate() method.

Main article: beginUpdate()

See Also

focus()

Sets focus on the widget.

See Also

getDependencyData(key)

Gets the dependency data.

Parameters:
key:

Object

The dependency key.

Return Value:

Object

The dependency data.

jQuery
index.js
var gantt = $("#ganttContainer").dxGantt("instance");
gantt.getDependencyData("dependency_key");
See Also

getInstance(element)

Gets the instance of a widget found using its DOM node.

Parameters:
element:

Element

|

jQuery

The widget's container.

Return Value:

Object

The widget's instance.

getInstance is a static method that the widget 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.

jQuery
index.js
var gantt = $("#ganttContainer").dxGantt("instance");
gantt.getResourceAssignmentData("res_assignment_key");
See Also

getResourceData(key)

Gets the resource data.

Parameters:
key:

Object

The resource key.

Return Value:

Object

The resource data.

jQuery
index.js
var gantt = $("#ganttContainer").dxGantt("instance");
gantt.getResourceData("resource_key");
See Also

getTaskData(key)

Gets the task data.

Parameters:
key:

Object

The task key.

Return Value:

Object

The task data.

jQuery
index.js
var gantt = $("#ganttContainer").dxGantt("instance");
gantt.getTaskData("task_key");
See Also

getTaskResources(key)

Gets resources assigned to a task.

Parameters:
key:

Object

The task's key.

Return Value:

Array<Object>

The resources.

jQuery
index.js
var gantt = $("#ganttContainer").dxGantt("instance");
//...
gantt.getTaskResources("task_key");
See Also

getVisibleDependencyKeys()

Gets the keys of the visible dependencies.

Return Value:

Array<Object>

The keys.

jQuery
index.js
var gantt = $("#ganttContainer").dxGantt("instance");
//...
var keys = gantt.getVisibleDependencyKeys();
See Also

getVisibleResourceAssignmentKeys()

Gets the keys of the visible resource assignments.

Return Value:

Array<Object>

The keys.

jQuery
index.js
var gantt = $("#ganttContainer").dxGantt("instance");
//...
var keys = gantt.getVisibleResourceAssignmentKeys();
See Also

getVisibleResourceKeys()

Gets the keys of the visible resources.

Return Value:

Array<Object>

The keys.

jQuery
index.js
var gantt = $("#ganttContainer").dxGantt("instance");
//...
var keys = gantt.getVisibleResourceKeys();
See Also

getVisibleTaskKeys()

Gets the keys of the visible tasks.

Return Value:

Array<Object>

The keys.

jQuery
index.js
var gantt = $("#ganttContainer").dxGantt("instance");
//...
var keys = gantt.getVisibleTaskKeys();
See Also

insertDependency(data)

Inserts a new dependency.

Parameters:
data:

Object

The dependency data.

jQuery
index.js
var gantt = $("#ganttContainer").dxGantt("instance");
gantt.insertDependency({ predecessorId: 1, successorId: 3, type: 3 });
See Also

insertResource(data, taskKeys)

Inserts a new resource.

Parameters:
data:

Object

The resource data.

taskKeys?:

Array<Object>

An array of task keys.

jQuery
index.js
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)

Inserts a new task.

Parameters:
data:

Object

The task data.

jQuery
index.js
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

instance()

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

Return Value: Gantt

This widget'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()

Gets all widget options.

Return Value:

Object

The widget's options.

option(optionName)

Gets the value of a single option.

Parameters:
optionName:

String

The option's name or full path.

Return Value: any

This option's value.

option(optionName, optionValue)

Updates the value of a single option.

Parameters:
optionName:

String

The option's name or full path.

optionValue: any

This option's new value.

option(options)

Updates the values of several options.

Parameters:
options:

Object

Options with their new values.

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

Repaints the widget without reloading data. Call it to update the widget's markup.

See Also

resetOption(optionName)

Resets an option to its default value.

Parameters:
optionName:

String

An option's name.

See Also

unassignResourceFromTask(resourceKey, taskKey)

Removes a resource from the task.

Parameters:
resourceKey:

Object

The resource key.

taskKey:

Object

The task key.

jQuery
index.js
var gantt = $("#ganttContainer").dxGantt("instance");
gantt.unassignResourceFromTask(3, 10);
See Also

updateDimensions()

updateTask(key, data)

Updates the task data.

Parameters:
key:

Object

The task key.

data:

Object

The task data.

jQuery
index.js
var gantt = $("#ganttContainer").dxGantt("instance");
gantt.updateTask(3, {title: "New Title"});
See Also