Configuration

An object that defines the Gantt UI component's configuration properties.

See Also

accessKey

Specifies the shortcut key that sets focus on the UI component.

Type:

String

Default Value: undefined

The value of this property will be passed to the accesskey attribute of the HTML element that underlies the UI component.

activeStateEnabled

Specifies whether or not the UI component changes its state when interacting with a user.

Type:

Boolean

Default Value: false

This property is used when the UI component is displayed on a platform whose guidelines include the active state change for UI components.

allowSelection

Specifies whether users can select tasks in the Gantt.

Type:

Boolean

Default Value: true

View Demo

jQuery
JavaScript
$(function() {
    $("#gantt").dxGantt({
        allowSelection: false,
        // ...
    });
});
Angular
app.component.html
app.component.ts
app.module.ts
<dx-gantt
    [allowSelection]="false">
    <!-- ... -->
</dx-gantt>
import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})

export class AppComponent {
    // ...      
}
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';
import { DxGanttModule } from 'devextreme-angular';

@NgModule({
    imports: [
        BrowserModule,
        DxGanttModule
    ],        
    declarations: [AppComponent],
    bootstrap: [AppComponent]
})
export class AppModule { }
Vue
App.vue
<template>
    <DxGantt
        :allow-selection="false" >
        <!-- ... -->
    </DxGantt>
</template>
<script>
    import 'devextreme/dist/css/dx.light.css';
    import 'devexpress-gantt/dist/dx-gantt.css'; 

    import { 
        DxGantt
        // ... 
    } from 'devextreme-vue/gantt';

    export default {
        components: { 
            DxGantt
            // ... 
        }
    };
</script>
React
App.js
import React from 'react';

import 'devextreme/dist/css/dx.light.css';
import 'devexpress-gantt/dist/dx-gantt.css'; 

import Gantt, { 
    // ... 
} from 'devextreme-react/gantt';

const App = () => {
    return (
        <Gantt
            allowSelection={false} >
            {/* ... */}
        </Gantt>
    );
};

export default App;
ASP.NET MVC Controls
Razor C#
@(Html.DevExtreme().Gantt()
    .AllowSelection(false)
    // ...
)
See Also

columns

An array of columns in the Gantt.

Default Value: undefined

The columns property accepts an array of columns. To configure a column, use a dxTreeListColumn object or specify a data source field (as a string value) to which the column is bound.

NOTE

The Gantt UI component does not support:

  • data sorting

  • column templates

View Demo

jQuery
JavaScript
$(function() {
    $("#gantt").dxGantt({
        columns: [{
            dataField: "title",
            caption: "Subject",
            width: 300
        }, {
            dataField: "start",
            caption: "Start Date"
        }, "end"
        ],
        // ...
    });
});

contextMenu

Configures the context menu settings.

Type:

Object

dependencies

Configures dependencies.

Type:

Object

Default Value: null

View Demo

Dependencies specify the relationships between tasks. The following image illustrates how the Gantt displays dependencies in the chart:

DevExtreme Gantt Chart - Dependencies

The Gantt UI component supports the following dependency types:

  • Finish to Start (FS) - The predecessor task's endpoint specifies the successor task's start point.

  • Start to Start (SS) - The predecessor task's start point specifies the successor task's start point.

  • Finish to Finish (FF) - The predecessor task's end point specifies the successor task's end point.

  • Start to Finish (SF) - The predecessor task's start point specifies the successor task's end point.

In a database, you can use any of the following formats (digit or string) to store dependency types:

Dependency Type Supported Values
Finish to Start (FS) 0, "0", "FS", "fs"
Start to Start (SS) 1, "1", "SS", "ss"
Finish to Finish (FF) 2, "2", "FF", "ff"
Start to Finish (SF) 3, "3", "SF", "sf"

Use the dataSource property to bind the UI component to a data source, which contains information about dependency types. If the field names in your data source differ from the 'id', 'type', 'predecessorId' and 'successorId' default names, use the keyExpr, typeExpr properties to map data fields.

See Also
jQuery
index.js
data.js
$(function() {
    $("#gantt").dxGantt({
        dependencies: {
            dataSource: dependencies,
            keyExpr: "dependencyId",
            typeExpr: "dependencyType",
            predecessorIdExpr: "taskPredecessorId",
            successorIdExpr: "taskSuccessorId"
        },
        //...
    });
});
var dependencies = [{
    'dependencyId': 0,
    'taskPredecessorId': 1,
    'taskSuccessorId': 2,
    'dependencyType': 0
},    
// ...
];    
Angular
app.component.html
app.component.ts
app.module.ts
app.service.ts
angular.json
<dx-gantt ... >
    <dxo-dependencies
        [dataSource]="dependencies" 
        keyExpr="dependencyId"
        typeExpr="dependencyType"
        predecessorIdExpr="taskPredecessorId"
        successorIdExpr="taskSuccessorId" >
    </dxo-dependencies>
    <!-- ... -->
</dx-gantt>
import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})

export class AppComponent {
    dependencies: Dependency[];
    // ...

    constructor(service: Service) {
        this.dependencies = service.getDependencies();
        // ...
    }        
}
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';
import { DxGanttModule } from 'devextreme-angular';
import { Service, Dependency, ... } from './app.service';

@NgModule({
    imports: [
        BrowserModule,
        DxGanttModule
    ],        
    declarations: [AppComponent],
    providers: [Service],
    bootstrap: [AppComponent]
})
export class AppModule { }
import { Injectable } from '@angular/core';

export class Dependency {
    dependencyId: number;
    taskPredecessorId: number;
    taskSuccessorId: number;
    dependencyType: number;
} 

let dependencies: Dependency[] = [{
    'dependencyId': 0,
    'taskPredecessorId': 1,
    'taskSuccessorId': 2,
    'dependencyType': 0 
},
// ...   
]; 
@Injectable()
export class Service {
    getDependencies(): Dependency[] {
        return dependencies;
    }
}
{
  "projects": {
    "ProjectName": {
      "architect": {
        "build": {
          "options": {
            "styles": [
              "node_modules/devextreme/dist/css/dx.light.css",
              "node_modules/devexpress-gantt/dist/dx-gantt.css",
              "src/styles.css"
            ],
            ...
          },
          ...
        },
        ...
      }
    },
    ...
  },
  ...
}
Vue
App.vue
data.js
<template>
    <DxGantt ... >
        <DxDependencies
            :data-source="dependencies"
            key-expr="dependencyId"
            type-expr="dependencyType"
            predecessor-id-expr="taskPredecessorId"
            successor-id-expr="taskSuccessorId" />
        <!-- ... -->
    </DxGantt>
</template>
<script>
    import 'devextreme/dist/css/dx.light.css';
    import 'devexpress-gantt/dist/dx-gantt.css'; 

    import { 
        DxGantt, 
        DxDependencies, 
        // ... 
    } from 'devextreme-vue/gantt';
    import { 
        dependencies, 
        // ... 
    } from './data.js';

    export default {
        components: { 
            DxGantt, 
            DxDependencies, 
            // ... 
        },
        data() {
            return { 
                dependencies, 
                // ... 
            };
        }
    };
</script>
export const dependencies = [{
    'dependencyId': 0,
    'taskPredecessorId': 1,
    'taskSuccessorId': 2,
    'dependencyType': 0
},
// ...
];  
React
App.js
data.js
import React from 'react';

import 'devextreme/dist/css/dx.light.css';
import 'devexpress-gantt/dist/dx-gantt.css'; 

import Gantt, { 
    Dependencies, 
    // ... 
} from 'devextreme-react/gantt';
import { 
    dependencies, 
    // ... 
} from './data.js';

const App = () => {
    return (
        <Gantt ... >
            <Dependencies 
                dataSource={dependencies}
                keyExpr="dependencyId"
                typeExpr="dependencyType"
                predecessorIdExpr="taskPredecessorId"
                successorIdExpr="taskSuccessorId" />
            {/* ... */}
        </Gantt>
    );
};

export default App;
export const dependencies = [{
    'dependencyId': 0,
    'taskPredecessorId': 1,
    'taskSuccessorId': 2,
    'dependencyType': 0
},
// ...
];

disabled

Specifies whether the UI component responds to user interaction.

Type:

Boolean

Default Value: false

editing

Configures edit properties.

Type:

Object

The UI component allows users to add, modify and delete tasks, resources and dependencies. Set the enabled property to true to enable edit functionality.

NOTE
Make sure that your data sources (tasks, resources and dependencies) support edit actions.

View Demo

jQuery
index.js
$(function() {
    $("#gantt").dxGantt({
        editing: {
            enabled: true,
            allowDependencyAdding: false, 
            allowDependencyDeleting: false, 
            allowResourceAdding: false, 
            allowResourceDeleting: false, 
            allowTaskAdding: false, 
            allowTaskDeleting: false, 
            allowTaskResourceUpdating: false, 
            allowTaskUpdating: false
        }
    });
}); 
Angular
app.component.html
app.component.ts
app.module.ts
<dx-gantt ... >
    <dxo-editing
        [enabled]="true" 
        [allowDependencyAdding]="false" 
        [allowDependencyDeleting]="false" 
        [allowResourceAdding]="false"
        [allowResourceDeleting]="false"
        [allowTaskAdding]="false"
        [allowTaskDeleting]="false"
        [allowTaskResourceUpdating]="false"
        [allowTaskUpdating]="false">
    </dxo-editing>
    <!-- ... -->
</dx-gantt>
import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})

export class AppComponent {
    // ...      
}
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';
import { DxGanttModule } from 'devextreme-angular';

@NgModule({
    imports: [
        BrowserModule,
        DxGanttModule
    ],        
    declarations: [AppComponent],
    bootstrap: [AppComponent]
})
export class AppModule { }
Vue
App.vue
<template>
    <DxGantt ... >
        <DxEditing
            :enabled="true"
            :allow-dependency-adding="false" 
            :allow-dependency-deleting="false" 
            :allow-resource-adding="false"
            :allow-resource-deleting="false"
            :allow-task-adding="false"
            :allow-task-deleting="false"
            :allow-task-resource-updating="false"
            :allow-task-updating="false"
         />
        <!-- ... -->
    </DxGantt>
</template>
<script>
    import 'devextreme/dist/css/dx.light.css';
    import 'devexpress-gantt/dist/dx-gantt.css'; 

    import { 
        DxGantt, 
        DxEditing, 
        // ... 
    } from 'devextreme-vue/gantt';

    export default {
        components: { 
            DxGantt, 
            DxEditing, 
            // ... 
        }
    };
</script>
React
App.js
import React from 'react';

import 'devextreme/dist/css/dx.light.css';
import 'devexpress-gantt/dist/dx-gantt.css'; 

import Gantt, { 
    Editing, 
    // ... 
} from 'devextreme-react/gantt';

const App = () => {
    return (
        <Gantt ... >
            <Editing 
                enabled={true}
                allowDependencyAdding={false}
                allowDependencyDeleting={false}
                allowResourceAdding={false}
                allowResourceDeleting={false}
                allowTaskAdding={false}
                allowTaskDeleting={false}
                allowTaskResourceUpdating={false}
                allowTaskUpdating={false} />
            {/* ... */}
        </Gantt>
    );
};

export default App;
ASP.NET MVC Controls
Razor C#
@(Html.DevExtreme().Gantt()
    .Editing(e => {
        e.Enabled(true)
        e.AllowDependencyAdding(false)
        e.AllowDependencyDeleting(false)
        e.AllowResourceAdding(false)
        e.AllowResourceDeleting(false)
        e.AllowTaskAdding(false)
        e.AllowTaskDeleting(false)
        e.AllowTaskResourceUpdating(false)
        e.AllowTaskUpdating(false)
    })
    // ...
)
See Also

elementAttr

Specifies the global attributes to be attached to the UI component's container element.

Type: any
Default Value: {}

jQuery
$(function(){
    $("#ganttContainer").dxGantt({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});
Angular
HTML
TypeScript
<dx-gantt ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-gantt>
import { DxGanttModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxGanttModule
    ],
    // ...
})
Vue
App.vue
<template>
    <DxGantt ...
        :element-attr="ganttAttributes">
    </DxGantt>
</template>

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

export default {
    components: {
        DxGantt
    },
    data() {
        return {
            ganttAttributes: {
                id: 'elementId',
                class: 'class-name'
            }
        }
    }
}
</script>
React
App.js
import React from 'react';

import Gantt from 'devextreme-react/gantt';

class App extends React.Component {
    ganttAttributes = {
        id: 'elementId',
        class: 'class-name'
    }

    render() {
        return (
            <Gantt ...
                elementAttr={this.ganttAttributes}>
            </Gantt>
        );
    }
}
export default App;

firstDayOfWeek

Specifies the first day of a week.

Type:

Number

Default Value: undefined
Accepted Values: 0 | 1 | 2 | 3 | 4 | 5 | 6

The property's value can be from 0 to 6.

  • 0 - Sunday
  • 1 - Monday
  • 2 - Tuesday
  • 3 - Wednesday
  • 4 - Thursday
  • 5 - Friday
  • 6 - Saturday

The culture settings specify the property's default value.

Use the FirstDayOfWeek enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday.

focusStateEnabled

Specifies whether the UI component can be focused using keyboard navigation.

Type:

Boolean

Default Value: false

height

Specifies the UI component's height.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The UI component's height.

Default Value: undefined

This property accepts a value of one of the following types:

  • Number
    The height in pixels.

  • String
    A CSS-accepted measurement of height. For example, "55px", "80%", "inherit".

  • Function
    A function returning either of the above. For example:

    JavaScript
    height: function() {
        return window.innerHeight / 1.5;
    }

hint

Specifies text for a hint that appears when a user pauses on the UI component.

Type:

String

Default Value: undefined

hoverStateEnabled

Specifies whether the UI component changes its state when a user pauses on it.

Type:

Boolean

Default Value: false

onContentReady

A function that is executed when the UI component's content is ready and each time the content is changed.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Gantt

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

model any

Model data. Available only when using Knockout.

Default Value: null

onContextMenuPreparing

A function that is executed before the context menu is rendered.

Type:

Function

Function parameters:
e:

Object

Information about the event that caused the function's execution.

Object structure:
Name Type Description
cancel

Boolean

Allows you to cancel showing the context menu.

component

Gantt

The UI component's instance.

data any

Data of the right-clicked task or dependency.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery.

items

Array<Object>

Items to be displayed in the context menu.

targetKey any

The key of the right-clicked task or dependency.

targetType

String

The type of right-clicked task or dependency.

Default Value: null

jQuery
index.js
$(function() {
    $("#gantt").dxGantt({
        // ...
        onContextMenuPreparing: function (e) {
            // your code
            e.cancel = true;
        }
    });
}); 
Angular
TypeScript
HTML
import { DxGanttModule } from "devextreme-angular";
// ...
export class AppComponent {
    onContextMenuPreparing(e) {
        // your code
        e.cancel = true;
    }
}
@NgModule({
    imports: [
        // ...
        DxGanttModule
    ],
    // ...
})
<dx-gantt ...
    (onContextMenuPreparing)="onContextMenuPreparing($event)">
</dx-gantt>
Vue
App.vue
<template>
    <DxGantt
        ...
        @context-menu-preparing="onContextMenuPreparing"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxGantt from 'devextreme-vue/gantt';

export default {
    components: {
        DxGantt
    },
    methods: {
        onContextMenuPreparing(e) {
            // your code
            e.cancel = true;
        }
    }
}
</script>
React
App.js
import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import Gantt from 'devextreme-react/gantt';

class App extends React.Component {
    // ...
    render() {
        return (
            <Gantt
                 //...
                 onContextMenuPreparing={this.onContextMenuPreparing}
            />
        );
    }
    onContextMenuPreparing = (e) => {
        // your code
        e.cancel = true;
    }
}
export default App;
ASP.NET MVC Controls
Razor C#
@(Html.DevExtreme().Gantt()
    .ID("gantt")
    // ...
    .onContextMenuPreparing("gantt_contextMenuPreparing_handler")
)
<script>
    function gantt_contextMenuPreparing_handler(e) {
        // your code
        e.cancel = true;
    }
</script>

View Demo

See Also

onCustomCommand

A function that is executed after a custom command item was clicked. Allows you to implement a custom command's functionality.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Gantt

The UI component instance's name.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

name

String

The name of the clicked item.

Default Value: null

jQuery
index.js
$(function() {
    $("#gantt").dxGantt({
        // ...
        onCustomCommand: function (e) {
            // your code
        }
    });
}); 
Angular
TypeScript
HTML
import { DxGanttModule } from "devextreme-angular";
// ...
export class AppComponent {
    onCustomCommand(e) {
        // your code
    }
}
@NgModule({
    imports: [
        // ...
        DxGanttModule
    ],
    // ...
})
<dx-gantt ...
    (onCustomCommand)="onCustomCommand($event)">
</dx-gantt>
Vue
App.vue
<template>
    <DxGantt
        ...
        @custom-command="onCustomCommand"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxGantt from 'devextreme-vue/gantt';

export default {
    components: {
        DxGantt
    },
    methods: {
        onCustomCommand(e) {
            // your code
        }
    }
}
</script>
React
App.js
import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import Gantt from 'devextreme-react/gantt';

class App extends React.Component {
    // ...
    render() {
        return (
            <Gantt
                 //...
                 onCustomCommand={this.onCustomCommand}
            />
        );
    }
    onCustomCommand = (e) => {
        // your code
    }
}
export default App;
ASP.NET MVC Controls
Razor C#
@(Html.DevExtreme().Gantt()
    .ID("gantt")
    // ...
    .onCustomCommand("gantt_customCommand_handler")
)
<script>
    function gantt_customCommand_handler(e) {
        // your code
    }
</script>
See Also

onDependencyDeleted

A function that is executed when a dependency is deleted.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Gantt

The UI component's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

key any

The key of the deleted dependency.

model any

Model data. Available only if you use Knockout.

values any

The values of the deleted dependency.

Default Value: null

DevExtreme Gantt - Dependency

jQuery
JavaScript
$(function() {
    $("#gantt").dxGantt({
        // ...
        onDependencyDeleted: function (e) {
            if (e.key != 1) 
                // your code
        }            
    })
})
Angular
TypeScript
HTML
import { DxGanttModule } from "devextreme-angular";
// ...
export class AppComponent {
    onDependencyDeleted(e) {
        if (e.key != 1) 
            // your code
    }
}
@NgModule({
    imports: [
        // ...
        DxGanttModule
    ],
    // ...
})
<dx-gantt ...
    (onDependencyDeleted)="onDependencyDeleted($event)">
</dx-gantt>
Vue
App.vue
<template>
    <DxGantt
        ...
        @dependency-deleted="onDependencyDeleted"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxGantt from 'devextreme-vue/gantt';

export default {
    components: {
        DxGantt
    },
    methods: {
        onDependencyDeleted(e) {
            if (e.key != 1) 
                // your code  
        }
    }
}
</script>
React
App.js
import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import Gantt from 'devextreme-react/gantt';

class App extends React.Component {
    // ...
    render() {
        return (
            <Gantt
                 //...
                 onDependencyDeleted={this.onDependencyDeleted}
            />
        );
    }
    onDependencyDeleted = (e) => {
        if (e.key != 1) 
            // your code
    }
}
export default App;
ASP.NET MVC Controls
Razor C#
@(Html.DevExtreme().Gantt()
    .ID("gantt")
    // ...
    .onDependencyDeleted("gantt_dependencyDeleted_handler")
)
<script>
    function gantt_dependencyDeleted_handler(e) {
        if (e.key != 1) 
            // your code
    }
</script>
See Also

onDependencyDeleting

A function that is executed before a dependency is deleted.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
cancel

Boolean

Allows you to cancel the dependency's deletion.

component

Gantt

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

key any

The key of the deleted dependency.

model any

Model data. Available only if you use Knockout.

values any

The values of the deleted dependency.

Default Value: null

DevExtreme Gantt - Dependency

jQuery
index.js
$(function() {
    $("#gantt").dxGantt({
        // ...
        onDependencyDeleting: function (e) {
            if (e.key != 1) {
                // your code
                e.cancel = true;
            }
        }
    });
}); 
Angular
TypeScript
HTML
import { DxGanttModule } from "devextreme-angular";
// ...
export class AppComponent {
    onDependencyDeleting(e) {
        if (e.key != 1) {
            // your code
            e.cancel = true;
        }
    }
}
@NgModule({
    imports: [
        // ...
        DxGanttModule
    ],
    // ...
})
<dx-gantt ...
    (onDependencyDeleting)="onDependencyDeleting($event)">
</dx-gantt>
Vue
App.vue
<template>
    <DxGantt
        ...
        @dependency-deleting="onDependencyDeleting"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxGantt from 'devextreme-vue/gantt';

export default {
    components: {
        DxGantt
    },
    methods: {
        onDependencyDeleting(e) {
            if (e.key != 1) {
                // your code 
                e.cancel = true;
            } 
        }
    }
}
</script>
React
App.js
import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import Gantt from 'devextreme-react/gantt';

class App extends React.Component {
    // ...
    render() {
        return (
            <Gantt
                 //...
                 onDependencyDeleting={this.onDependencyDeleting}
            />
        );
    }
    onDependencyDeleting = (e) => {
        if (e.key != 1) {
            // your code
            e.cancel = true;
        }
    }
}
export default App;
ASP.NET MVC Controls
Razor C#
@(Html.DevExtreme().Gantt()
    .ID("gantt")
    // ...
    .onDependencyDeleting("gantt_dependencyDeleting_handler")
)
<script>
    function gantt_dependencyDeleting_handler(e) {
        if (e.key != 1) {
            // your code
            e.cancel = true;
        }
    }
</script>
See Also

onDependencyInserted

A function that is executed when a dependency is inserted.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Gantt

The UI component's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

key any

The key of the inserted dependency.

model any

Model data. Available only if you use Knockout.

values any

The values of the inserted dependency.

Default Value: null

DevExtreme Gantt - Dependency

jQuery
index.js
$(function() {
    $("#gantt").dxGantt({
        // ...
        onDependencyInserted: function (e) {
            if (e.values.type == 3) {
                // your code
            }
        }
    });
}); 
Angular
TypeScript
HTML
import { DxGanttModule } from "devextreme-angular";
// ...
export class AppComponent {
    onDependencyInserted(e) {
        if (e.values.type == 3) {
            // your code
        }
    }
}
@NgModule({
    imports: [
        // ...
        DxGanttModule
    ],
    // ...
})
<dx-gantt ...
    (onDependencyInserted)="onDependencyInserted($event)">
</dx-gantt>
Vue
App.vue
<template>
    <DxGantt
        ...
        @dependency-inserted="onDependencyInserted"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxGantt from 'devextreme-vue/gantt';

export default {
    components: {
        DxGantt
    },
    methods: {
        onDependencyInserted(e) {
            if (e.values.type == 3) {
                // your code
            }
        }
    }
}
</script>
React
App.js
import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import Gantt from 'devextreme-react/gantt';

class App extends React.Component {
    // ...
    render() {
        return (
            <Gantt
                 //...
                 onDependencyInserted={this.onDependencyInserted}
            />
        );
    }
    onDependencyInserted = (e) => {
        if (e.values.type == 3) {
            // your code
        }
    }
}
export default App;
ASP.NET MVC Controls
Razor C#
@(Html.DevExtreme().Gantt()
    .ID("gantt")
    // ...
    .onDependencyInserted("gantt_dependencyInserted_handler")
)
<script>
    function gantt_dependencyInserted_handler(e) {
        if (e.key != 1) {
            // your code
            e.cancel = true;
        }
    }
</script>
See Also

onDependencyInserting

A function that is executed before a dependency is inserted.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
cancel

Boolean

Allows you to cancel the dependency's insertion.

component

Gantt

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

model any

Model data. Available only if you use Knockout.

values any

The values of the inserted dependency.

Default Value: null

DevExtreme Gantt - Dependency

jQuery
index.js
$(function() {
    $("#gantt").dxGantt({
        // ...
        onDependencyInserting: function (e) {
            if (e.values.type == 3) {
                // your code
                e.cancel = true;
            }
        }
    });
}); 
Angular
TypeScript
HTML
import { DxGanttModule } from "devextreme-angular";
// ...
export class AppComponent {
    onDependencyInserting(e) {
        if (e.values.type == 3) {
            // your code
            e.cancel = true;
        }
    }
}
@NgModule({
    imports: [
        // ...
        DxGanttModule
    ],
    // ...
})
<dx-gantt ...
    (onDependencyInserting)="onDependencyInserting($event)">
</dx-gantt>
Vue
App.vue
<template>
    <DxGantt
        ...
        @dependency-inserting="onDependencyInserting"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxGantt from 'devextreme-vue/gantt';

export default {
    components: {
        DxGantt
    },
    methods: {
        onDependencyInserting(e) {
            if (e.values.type == 3) {
                // your code
                e.cancel = true;
            }
        }
    }
}
</script>
React
App.js
import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import Gantt from 'devextreme-react/gantt';

class App extends React.Component {
    // ...
    render() {
        return (
            <Gantt
                 //...
                 onDependencyInserting={this.onDependencyInserting}
            />
        );
    }
    onDependencyInserting = (e) => {
        if (e.values.type == 3) {
            // your code
            e.cancel = true;
        }
    }
}
export default App;
ASP.NET MVC Controls
Razor C#
@(Html.DevExtreme().Gantt()
    .ID("gantt")
    // ...
    .onDependencyInserting("gantt_dependencyInserting_handler")
)
<script>
    function gantt_dependencyInserting_handler(e) {
        if (e.key != 1) {
            // your code
            e.cancel = true;
        }
    }
</script>
See Also

onDisposing

A function that is executed before the UI component is disposed of.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Gantt

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

model any

Model data. Available only if you use Knockout.

Default Value: null

onInitialized

A function used in JavaScript frameworks to save the UI component instance.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Gantt

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

Default Value: null

See Also

onOptionChanged

A function that is executed after a UI component property is changed.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Gantt

The UI component's instance.

fullName

String

The path to the modified property that includes all parent properties.

name

String

The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into.

value any

The modified property's new value.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

model any

Model data. Available only if you use Knockout.

Default Value: null

The following example shows how to subscribe to component property changes:

jQuery
index.js
$(function() {
    $("#ganttContainer").dxGantt({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});
Angular
app.component.html
app.component.ts
app.module.ts
<dx-gantt ...
    (onOptionChanged)="handlePropertyChange($event)"> 
</dx-gantt>
import { Component } from '@angular/core'; 

@Component({ 
    selector: 'app-root', 
    templateUrl: './app.component.html', 
    styleUrls: ['./app.component.css'] 
}) 

export class AppComponent { 
    // ...
    handlePropertyChange(e) {
        if(e.name === "changedProperty") { 
            // handle the property change here
        }
    }
}
import { BrowserModule } from '@angular/platform-browser'; 
import { NgModule } from '@angular/core'; 
import { AppComponent } from './app.component'; 
import { DxGanttModule } from 'devextreme-angular'; 

@NgModule({ 
    declarations: [ 
        AppComponent 
    ], 
    imports: [ 
        BrowserModule, 
        DxGanttModule 
    ], 
    providers: [ ], 
    bootstrap: [AppComponent] 
}) 

export class AppModule { }  
Vue
App.vue
<template> 
    <DxGantt ...
        @option-changed="handlePropertyChange"
    />            
</template> 

<script>  
import 'devextreme/dist/css/dx.light.css'; 
import DxGantt from 'devextreme-vue/gantt'; 

export default { 
    components: { 
        DxGantt
    }, 
    // ...
    methods: { 
        handlePropertyChange: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    } 
} 
</script> 
React
App.js
import React from 'react';  
import 'devextreme/dist/css/dx.light.css'; 

import Gantt from 'devextreme-react/gantt'; 

const handlePropertyChange = (e) => {
    if(e.name === "changedProperty") {
        // handle the property change here
    }
}

export default function App() { 
    return ( 
        <Gantt ...
            onOptionChanged={handlePropertyChange}
        />        
    ); 
} 

onResourceAssigned

A function that is executed when a resource is assigned to a task.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Gantt

The UI component's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

key any

The key of the inserted resource assignment.

model any

Model data. Available only if you use Knockout.

values any

The values of the processed resource and task.

Default Value: null

DevExtreme Gantt Chart - Resources

jQuery
index.js
$(function() {
    $("#gantt").dxGantt({
        // ...
        onResourceAssigned: function (e) {
            if (e.values.taskID != 0) {
                // your code
            }
        }
    });
}); 
Angular
TypeScript
HTML
import { DxGanttModule } from "devextreme-angular";
// ...
export class AppComponent {
    onResourceAssigned(e) {
        if (e.values.taskID != 0) {
            // your code
        }
    }
}
@NgModule({
    imports: [
        // ...
        DxGanttModule
    ],
    // ...
})
<dx-gantt ...
    (onResourceAssigned)="onResourceAssigned($event)">
</dx-gantt>
Vue
App.vue
<template>
    <DxGantt
        ...
        @resource-assigned="onResourceAssigned"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxGantt from 'devextreme-vue/gantt';

export default {
    components: {
        DxGantt
    },
    methods: {
        onResourceAssigned(e) {
            if (e.values.taskID != 0) {
                // your code
            }                                                                                  
        }
    }
}
</script>
React
App.js
import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import Gantt from 'devextreme-react/gantt';

class App extends React.Component {
    // ...
    render() {
        return (
            <Gantt
                 //...
                 onResourceAssigned={this.onResourceAssigned}
            />
        );
    }
    onResourceAssigned = (e) => {
        if (e.values.taskID != 0) {
            // your code
        }
    }
}
export default App;
ASP.NET MVC Controls
Razor C#
@(Html.DevExtreme().Gantt()
    .ID("gantt")
    // ...
    .onResourceAssigned("gantt_resourceAssigned_handler")
)
<script>
    function gantt_resourceAssigned_handler(e) {
        if (e.values.taskID != 0) {
            // your code
        }
    }
</script>
See Also

onResourceAssigning

A function that is executed before a resource is assigned to a task.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
cancel

Boolean

Allows you to cancel the resource assignment.

component

Gantt

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

model any

Model data. Available only if you use Knockout.

values any

The values of the processed resource and task.

Default Value: null

DevExtreme Gantt Chart - Resources

jQuery
index.js
$(function() {
    $("#gantt").dxGantt({
        // ...
        onResourceAssigning: function (e) {
            if (e.values.taskID != 0) {
                // your code
                e.cancel = true;
            }
        }
    });
}); 
Angular
TypeScript
HTML
import { DxGanttModule } from "devextreme-angular";
// ...
export class AppComponent {
    onResourceAssigning(e) {
        if (e.values.taskID != 0) {
            // your code
            e.cancel = true;
        }
    }
}
@NgModule({
    imports: [
        // ...
        DxGanttModule
    ],
    // ...
})
<dx-gantt ...
    (onResourceAssigning)="onResourceAssigning($event)">
</dx-gantt>
Vue
App.vue
<template>
    <DxGantt
        ...
        @resource-assigning="onResourceAssigning"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxGantt from 'devextreme-vue/gantt';

export default {
    components: {
        DxGantt
    },
    methods: {
        onResourceAssigning(e) {
            if (e.values.taskID != 0) {
                // your code
                e.cancel = true;
            }                                                                                  
        }
    }
}
</script>
React
App.js
import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import Gantt from 'devextreme-react/gantt';

class App extends React.Component {
    // ...
    render() {
        return (
            <Gantt
                 //...
                 onResourceAssigning={this.onResourceAssigning}
            />
        );
    }
    onResourceAssigning = (e) => {
        if (e.values.taskID != 0) {
            // your code
            e.cancel = true;
        }
    }
}
export default App;
ASP.NET MVC Controls
Razor C#
@(Html.DevExtreme().Gantt()
    .ID("gantt")
    // ...
    .onResourceAssigning("gantt_resourceAssigning_handler")
)
<script>
    function gantt_resourceAssigning_handler(e) {
        if (e.values.taskID != 0) {
            // your code
            e.cancel = true;
        }
    }
</script>
See Also

onResourceDeleted

A function that is executed when a resource is deleted.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Gantt

The UI component's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

key any

The key of the deleted resource.

model any

Model data. Available only if you use Knockout.

values any

The values of the deleted resource.

Default Value: null

DevExtreme Gantt Chart - Resources

jQuery
index.js
$(function() {
    $("#gantt").dxGantt({
        // ...
        onResourceDeleted: function (e) {
            if (e.key == 0) {
                // your code
            }
        }
    });
}); 
Angular
TypeScript
HTML
import { DxGanttModule } from "devextreme-angular";
// ...
export class AppComponent {
    onResourceDeleted(e) {
        if (e.key == 0) {
            // your code
        }
    }
}
@NgModule({
    imports: [
        // ...
        DxGanttModule
    ],
    // ...
})
<dx-gantt ...
    (onResourceDeleted)="onResourceDeleted($event)">
</dx-gantt>
Vue
App.vue
<template>
    <DxGantt
        ...
        @resource-deleted="onResourceDeleted"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxGantt from 'devextreme-vue/gantt';

export default {
    components: {
        DxGantt
    },
    methods: {
        onResourceDeleted(e) {
            if (e.key == 0) {
                // your code 
            } 
        }
    }
}
</script>
React
App.js
import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import Gantt from 'devextreme-react/gantt';

class App extends React.Component {
    // ...
    render() {
        return (
            <Gantt
                 //...
                 onResourceDeleted={this.onResourceDeleted}
            />
        );
    }
    onResourceDeleted = (e) => {
        if (e.key == 0) {
            // your code
        }
    }
}
export default App;
ASP.NET MVC Controls
Razor C#
@(Html.DevExtreme().Gantt()
    .ID("gantt")
    // ...
    .onResourceDeleted("gantt_resourceDeleted_handler")
)
<script>
    function gantt_resourceDeleted_handler(e) {
        if (e.key == 0) {
            // your code
        }
    }
</script>
See Also

onResourceDeleting

A function that is executed before a resource is deleted.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
cancel

Boolean

Allows you to cancel the resource deletion.

component

Gantt

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

key any

The key of the deleted resource.

model any

Model data. Available only if you use Knockout.

values any

The values of the deleted resource.

Default Value: null

DevExtreme Gantt Chart - Resources

jQuery
index.js
$(function() {
    $("#gantt").dxGantt({
        // ...
        onResourceDeleting: function (e) {
            if (e.key == 0) {
                // your code
                e.cancel = true;
            }
        }
    });
}); 
Angular
TypeScript
HTML
import { DxGanttModule } from "devextreme-angular";
// ...
export class AppComponent {
    onResourceDeleting(e) {
        if (e.key == 0) {
            // your code
            e.cancel = true;
        }
    }
}
@NgModule({
    imports: [
        // ...
        DxGanttModule
    ],
    // ...
})
<dx-gantt ...
    (onResourceDeleting)="onResourceDeleting($event)">
</dx-gantt>
Vue
App.vue
<template>
    <DxGantt
        ...
        @resource-deleting="onResourceDeleting"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxGantt from 'devextreme-vue/gantt';

export default {
    components: {
        DxGantt
    },
    methods: {
        onResourceDeleting(e) {
            if (e.key == 0) {
                // your code 
                e.cancel = true;
            } 
        }
    }
}
</script>
React
App.js
import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import Gantt from 'devextreme-react/gantt';

class App extends React.Component {
    // ...
    render() {
        return (
            <Gantt
                 //...
                 onResourceDeleting={this.onResourceDeleting}
            />
        );
    }
    onResourceDeleting = (e) => {
        if (e.key == 0) {
            // your code
            e.cancel = true;
        }
    }
}
export default App;
ASP.NET MVC Controls
Razor C#
@(Html.DevExtreme().Gantt()
    .ID("gantt")
    // ...
    .onResourceDeleting("gantt_resourceDeleting_handler")
)
<script>
    function gantt_resourceDeleting_handler(e) {
        if (e.key == 0) {
            // your code
            e.cancel = true;
        }
    }
</script>
See Also

onResourceInserted

A function that is executed when a resource is inserted.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Gantt

The UI component's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

key any

The key of the inserted resource.

model any

Model data. Available only if you use Knockout.

values any

The values of the inserted resource.

Default Value: null

DevExtreme Gantt Chart - Resources

jQuery
index.js
$(function() {
    $("#gantt").dxGantt({
        // ...
        onResourceInserted: function (e) {
            if (e.values.text == " "){
                // your code
            }
        }
    });
}); 
Angular
TypeScript
HTML
import { DxGanttModule } from "devextreme-angular";
// ...
export class AppComponent {
    onResourceInserted(e) {
        if (e.values.text == " "){
            // your code
        }
    }
}
@NgModule({
    imports: [
        // ...
        DxGanttModule
    ],
    // ...
})
<dx-gantt ...
    (onResourceInserted)="onResourceInserted($event)">
</dx-gantt>
Vue
App.vue
<template>
    <DxGantt
        ...
        @resource-inserted="onResourceInserted"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxGantt from 'devextreme-vue/gantt';

export default {
    components: {
        DxGantt
    },
    methods: {
        onResourceInserted(e) {
            if (e.values.text == " "){
                // your code 
            } 
        }
    }
}
</script>
React
App.js
import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import Gantt from 'devextreme-react/gantt';

class App extends React.Component {
    // ...
    render() {
        return (
            <Gantt
                 //...
                 onResourceInserted={this.onResourceInserted}
            />
        );
    }
    onResourceInserted = (e) => {
        if (e.values.text == " "){
            // your code
        }
    }
}
export default App;
ASP.NET MVC Controls
Razor C#
@(Html.DevExtreme().Gantt()
    .ID("gantt")
    // ...
    .onResourceInserted("gantt_resourceInserted_handler")
)
<script>
    function gantt_resourceInserted_handler(e) {
        if (e.values.text == " "){
            // your code
        }
    }
</script>
See Also

onResourceInserting

A function that is executed before a resource is inserted.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
cancel

Boolean

Allows you to cancel the resource insertion.

component

Gantt

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

model any

Model data. Available only if you use Knockout.

values any

The values of the inserted resource.

Default Value: null

DevExtreme Gantt Chart - Resources

jQuery
index.js
$(function() {
    $("#gantt").dxGantt({
        // ...
        onResourceInserting: function (e) {
            if (e.values.text == " "){
                // your code
                e.cancel = true;
            }
        }
    });
}); 
Angular
TypeScript
HTML
import { DxGanttModule } from "devextreme-angular";
// ...
export class AppComponent {
    onResourceInserting(e) {
        if (e.values.text == " "){
            // your code
            e.cancel = true;
        }
    }
}
@NgModule({
    imports: [
        // ...
        DxGanttModule
    ],
    // ...
})
<dx-gantt ...
    (onResourceInserting)="onResourceInserting($event)">
</dx-gantt>
Vue
App.vue
<template>
    <DxGantt
        ...
        @resource-inserting="onResourceInserting"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxGantt from 'devextreme-vue/gantt';

export default {
    components: {
        DxGantt
    },
    methods: {
        onResourceInserting(e) {
            if (e.values.text == " "){
                // your code 
                e.cancel = true;
            } 
        }
    }
}
</script>
React
App.js
import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import Gantt from 'devextreme-react/gantt';

class App extends React.Component {
    // ...
    render() {
        return (
            <Gantt
                 //...
                 onResourceInserting={this.onResourceInserting}
            />
        );
    }
    onResourceInserting = (e) => {
        if (e.values.text == " "){
            // your code
            e.cancel = true;
        }
    }
}
export default App;
ASP.NET MVC Controls
Razor C#
@(Html.DevExtreme().Gantt()
    .ID("gantt")
    // ...
    .onResourceInserting("gantt_resourceInserting_handler")
)
<script>
    function gantt_resourceInserting_handler(e) {
        if (e.values.text == " "){
            // your code
            e.cancel = true;
        }
    }
</script>
See Also

onResourceManagerDialogShowing

A function that is executed before the Resource Manager dialog is shown.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
cancel

Boolean

Allows you to cancel the Resource Manager dialog showing.

component

Gantt

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

values

Array<any>

The resources' values.

Default Value: null

DevExtreme Gantt - Invoke Resource Manager

Use the onResourceManagerDialogShowing function to customize the Resource Manager dialog before it is invoked. You can also use the showResourceManagerDialog method or the "Resource Manager" toolbar item to invoke the Resource Manager.

The allowTaskResourceUpdating property allows you to hide the Resource Manager button in the Task Details dialog.

jQuery
index.js
$(function() {
    $("#gantt").dxGantt({
        // ...
        onResourceManagerDialogShowing: function (e) {
            // your code
            e.cancel = true;
        }
    });
}); 
Angular
TypeScript
HTML
import { DxGanttModule } from "devextreme-angular";
// ...
export class AppComponent {
    onResourceManagerDialogShowing(e) {
        // your code
        e.cancel = true;
    }
}
@NgModule({
    imports: [
        // ...
        DxGanttModule
    ],
    // ...
})
<dx-gantt ...
    (onResourceManagerDialogShowing)="onResourceManagerDialogShowing($event)">
</dx-gantt>
Vue
App.vue
<template>
    <DxGantt
        ...
        @resource-manager-dialog-showing="onResourceManagerDialogShowing"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxGantt from 'devextreme-vue/gantt';

export default {
    components: {
        DxGantt
    },
    methods: {
        onResourceManagerDialogShowing(e) {
            // your code
            e.cancel = true;
        }
    }
}
</script>
React
App.js
import React from 'react';

import 'devextreme/dist/css/dx.light.css';
import Gantt from 'devextreme-react/gantt';

const App = () => {
    const onResourceManagerDialogShowing = (e) => {
        // your code
        e.cancel = true;
    };

    return (
        <Gantt onResourceManagerDialogShowing={onResourceManagerDialogShowing} />
    );
}

export default App;
ASP.NET MVC Controls
Razor C#
@(Html.DevExtreme().Gantt()
    .ID("gantt")
    // ...
    .onResourceManagerDialogShowing("gantt_resourceManagerDialogShowing_handler")
)
<script>
    function gantt_resourceManagerDialogShowing_handler(e) {
        // your code
        e.cancel = true;
    }
</script>
See Also

onResourceUnassigned

A function that is executed when a resource is unassigned from a task.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Gantt

The UI component's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

key any

The key of the deleted resource assignment.

model any

Model data. Available only if you use Knockout.

values any

The values of the processed resource and task.

Default Value: null

DevExtreme Gantt Chart - Resources

jQuery
index.js
$(function() {
    $("#gantt").dxGantt({
        // ...
        onResourceUnassigned: function (e) {
            if (e.key != 0) {
                // your code
            }
        }
    });
}); 
Angular
TypeScript
HTML
import { DxGanttModule } from "devextreme-angular";
// ...
export class AppComponent {
    onResourceUnassigned(e) {
        if (e.key != 0) {
            // your code
        }
    }
}
@NgModule({
    imports: [
        // ...
        DxGanttModule
    ],
    // ...
})
<dx-gantt ...
    (onResourceUnassigned)="onResourceUnassigned($event)">
</dx-gantt>
Vue
App.vue
<template>
    <DxGantt
        ...
        @resource-unassigned="onResourceUnassigned"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxGantt from 'devextreme-vue/gantt';

export default {
    components: {
        DxGantt
    },
    methods: {
        onResourceUnassigned(e) {
            if (e.key != 0) {
                // your code
            }                                                                                  
        }
    }
}
</script>
React
App.js
import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import Gantt from 'devextreme-react/gantt';

class App extends React.Component {
    // ...
    render() {
        return (
            <Gantt
                 //...
                 onResourceUnassigned={this.onResourceUnassigned}
            />
        );
    }
    onResourceUnassigned = (e) => {
        if (e.key != 0) {
            // your code
        }
    }
}
export default App;
ASP.NET MVC Controls
Razor C#
@(Html.DevExtreme().Gantt()
    .ID("gantt")
    // ...
    .onResourceUnassigned("gantt_resourceUnassigned_handler")
)
<script>
    function gantt_resourceUnassigned_handler(e) {
        if (e.key != 0) {
            // your code
        }
    }
</script>
See Also

onResourceUnassigning

A function that is executed before a resource is unassigned from a task.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
cancel

Boolean

Allows you to cancel the resource unassignment.

component

Gantt

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

key any

The key of the resource.

model any

Model data. Available only if you use Knockout.

values any

The values of the processed resource and task.

Default Value: null

DevExtreme Gantt Chart - Resources

jQuery
index.js
$(function() {
    $("#gantt").dxGantt({
        // ...
        onResourceUnassigning: function (e) {
            if (e.key != 0) {
                // your code
                e.cancel = true;
            }
        }
    });
}); 
Angular
TypeScript
HTML
import { DxGanttModule } from "devextreme-angular";
// ...
export class AppComponent {
    onResourceUnassigning(e) {
        if (e.key != 0) {
            // your code
            e.cancel = true;
        }
    }
}
@NgModule({
    imports: [
        // ...
        DxGanttModule
    ],
    // ...
})
<dx-gantt ...
    (onResourceUnassigning)="onResourceUnassigning($event)">
</dx-gantt>
Vue
App.vue
<template>
    <DxGantt
        ...
        @resource-unassigning="onResourceUnassigning"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxGantt from 'devextreme-vue/gantt';

export default {
    components: {
        DxGantt
    },
    methods: {
        onResourceUnassigning(e) {
            if (e.key != 0) {
                // your code
                e.cancel = true;
            }                                                                                  
        }
    }
}
</script>
React
App.js
import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import Gantt from 'devextreme-react/gantt';

class App extends React.Component {
    // ...
    render() {
        return (
            <Gantt
                 //...
                 onResourceUnassigning={this.onResourceUnassigning}
            />
        );
    }
    onResourceUnassigning = (e) => {
        if (e.key != 0) {
            // your code
            e.cancel = true;
        }
    }
}
export default App;
ASP.NET MVC Controls
Razor C#
@(Html.DevExtreme().Gantt()
    .ID("gantt")
    // ...
    .onResourceUnassigning("gantt_resourceUnassigning_handler")
)
<script>
    function gantt_resourceUnassigning_handler(e) {
        if (e.key != 0) {
            // your code
            e.cancel = true;
        }
    }
</script>
See Also

onSelectionChanged

A function that is executed after users select a task or clear its selection.

Type:

Function

Function parameters:
e:

Object

Information about the event that caused the function's execution.

Object structure:
Name Type Description
component

Gantt

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

model any

Model data. Available only if you use Knockout.

selectedRowKey any

The key of the row whose selection state was changed.

Default Value: null

View Demo

jQuery
index.js
$(function() {
    $("#gantt").dxGantt({
        // ...
        onSelectionChanged: function (e) {
            if (e.selectedRowKey === 2) {
                // your code
            } else {
                // your code
            }
        }
    });
}); 
Angular
TypeScript
HTML
import { DxGanttModule } from "devextreme-angular";
// ...
export class AppComponent {
    onSelectionChanged(e) {
        if (e.selectedRowKey === 2) {
            // your code
        } else {
            // your code
        }
    }
}
@NgModule({
    imports: [
        // ...
        DxGanttModule
    ],
    // ...
})
<dx-gantt ...
    (onSelectionChanged)="onSelectionChanged($event)">
</dx-gantt>
Vue
App.vue
<template>
    <DxGantt
        ...
        @selection-changed="onSelectionChanged"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxGantt from 'devextreme-vue/gantt';

export default {
    components: {
        DxGantt
    },
    methods: {
        onSelectionChanged(e) {
            if (e.selectedRowKey === 2) {
                // your code
            } else {
                // your code
            }                                                                                
        }
    }
}
</script>
React
App.js
import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import Gantt from 'devextreme-react/gantt';

class App extends React.Component {
    // ...
    render() {
        return (
            <Gantt
                 //...
                 onSelectionChanged={this.onSelectionChanged}
            />
        );
    }
    onSelectionChanged = (e) => {
        if (e.selectedRowKey === 2) {
            // your code
        } else {
            // your code
        }
    }
}
export default App;
ASP.NET MVC Controls
Razor C#
@(Html.DevExtreme().Gantt()
    .ID("gantt")
    // ...
    .onSelectionChanged("gantt_selectionChanged_handler")
)
<script>
    function gantt_selectionChanged_handler(e) {
        if (e.selectedRowKey === 2) {
            // your code
        } else {
            // your code
        }
    }
</script>
See Also

onTaskClick

A function that is executed when a user clicks a task.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Gantt

The UI component's instance.

data any

The task data.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery.

key any

The task key.

model any

Model data. Available only if you use Knockout.

Default Value: null

DevExtreme Gantt Chart - Task Element

jQuery
index.js
$(function() {
    $("#gantt").dxGantt({
        // ...
        onTaskClick: function (e) {
            if (e.key != 0) {
                // your code
            }
        }
    });
}); 
Angular
TypeScript
HTML
import { DxGanttModule } from "devextreme-angular";
// ...
export class AppComponent {
    onTaskClick(e) {
        if (e.key != 0) {
            // your code
        }
    }
}
@NgModule({
    imports: [
        // ...
        DxGanttModule
    ],
    // ...
})
<dx-gantt ...
    (onTaskClick)="onTaskClick($event)">
</dx-gantt>
Vue
App.vue
<template>
    <DxGantt
        ...
        @task-click="onTaskClick"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxGantt from 'devextreme-vue/gantt';

export default {
    components: {
        DxGantt
    },
    methods: {
        onTaskClick(e) {
            if (e.key != 0) {
                // your code
            }
        }
    }
}
</script>
React
App.js
import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import Gantt from 'devextreme-react/gantt';

class App extends React.Component {
    // ...
    render() {
        return (
            <Gantt
                 //...
                 onTaskClick={this.onTaskClick}
            />
        );
    }
    onTaskClick = (e) => {
        if (e.key != 0) {
            // your code
        }
    }
}
export default App;
ASP.NET MVC Controls
Razor C#
@(Html.DevExtreme().Gantt()
    .ID("gantt")
    // ...
    .onTaskClick("gantt_taskClick_handler")
)
<script>
    function gantt_taskClick_handler(e) {
        if (e.key != 0) {
            // your code
        }
    }
</script>
See Also

onTaskDblClick

A function that is executed when a user double-clicks a task.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
cancel

Boolean

Allows you to cancel the resource unassignment.

component

Gantt

The UI component's instance.

data any

The task data.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery.

key any

The task key.

model any

Model data. Available only if you use Knockout.

Default Value: null

DevExtreme Gantt Chart - Task Element

jQuery
index.js
$(function() {
    $("#gantt").dxGantt({
        // ...
        onTaskDblClick: function (e) {
            if (e.key != 0) {
                // your code
                e.cancel = true;
            }
        }
    });
}); 
Angular
TypeScript
HTML
import { DxGanttModule } from "devextreme-angular";
// ...
export class AppComponent {
    onTaskDblClick(e) {
        if (e.key != 0) {
            // your code
            e.cancel = true;
        }
    }
}
@NgModule({
    imports: [
        // ...
        DxGanttModule
    ],
    // ...
})
<dx-gantt ...
    (onTaskDblClick)="onTaskDblClick($event)">
</dx-gantt>
Vue
App.vue
<template>
    <DxGantt
        ...
        @task-dbl-click="onTaskDblClick"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxGantt from 'devextreme-vue/gantt';

export default {
    components: {
        DxGantt
    },
    methods: {
        onTaskDblClick(e) {
            if (e.key != 0) {
                // your code
                e.cancel = true;
            }
        }
    }
}
</script>
React
App.js
import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import Gantt from 'devextreme-react/gantt';

class App extends React.Component {
    // ...
    render() {
        return (
            <Gantt
                 //...
                 onTaskDblClick={this.onTaskDblClick}
            />
        );
    }
    onTaskDblClick = (e) => {
        if (e.key != 0) {
            // your code
            e.cancel = true;
        }
    }
}
export default App;
ASP.NET MVC Controls
Razor C#
@(Html.DevExtreme().Gantt()
    .ID("gantt")
    // ...
    .onTaskDblClick("gantt_taskDblClick_handler")
)
<script>
    function gantt_taskDblClick_handler(e) {
        if (e.key != 0) {
            // your code
            e.cancel = true;
        }
    }
</script>
See Also

onTaskDeleted

A function that is executed when a task is deleted.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Gantt

The UI component's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

key any

The key of the deleted task.

model any

Model data. Available only if you use Knockout.

values any

The values of the deleted task.

Default Value: null

DevExtreme Gantt Chart - Task Element

jQuery
index.js
$(function() {
    $("#gantt").dxGantt({
        // ...
        onTaskDeleted: function (e) {
            if (e.key != 0) {
                // your code
            }
        }
    });
}); 
Angular
TypeScript
HTML
import { DxGanttModule } from "devextreme-angular";
// ...
export class AppComponent {
    onTaskDeleted(e) {
        if (e.key != 0) {
            // your code
        }
    }
}
@NgModule({
    imports: [
        // ...
        DxGanttModule
    ],
    // ...
})
<dx-gantt ...
    (onTaskDeleted)="onTaskDeleted($event)">
</dx-gantt>
Vue
App.vue
<template>
    <DxGantt
        ...
        @task-deleted="onTaskDeleted"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxGantt from 'devextreme-vue/gantt';

export default {
    components: {
        DxGantt
    },
    methods: {
        onTaskDeleted(e) {
            if (e.key != 0) {
                // your code
            }
        }
    }
}
</script>
React
App.js
import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import Gantt from 'devextreme-react/gantt';

class App extends React.Component {
    // ...
    render() {
        return (
            <Gantt
                 //...
                 onTaskDeleted={this.onTaskDeleted}
            />
        );
    }
    onTaskDeleted = (e) => {
        if (e.key != 0) {
            // your code
        }
    }
}
export default App;
ASP.NET MVC Controls
Razor C#
@(Html.DevExtreme().Gantt()
    .ID("gantt")
    // ...
    .onTaskDeleted("gantt_taskDeleted_handler")
)
<script>
    function gantt_taskDeleted_handler(e) {
        if (e.key != 0) {
            // your code
        }
    }
</script>
See Also

onTaskDeleting

A function that is executed before a task is deleted.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
cancel

Boolean

Allows you to cancel the task deletion.

component

Gantt

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

key any

The key of the deleted task.

model any

Model data. Available only if you use Knockout.

values any

The values of the deleted task.

Default Value: null

DevExtreme Gantt Chart - Task Element

jQuery
index.js
$(function() {
    $("#gantt").dxGantt({
        // ...
        onTaskDeleting: function (e) {
            if (e.key != 0) {
                // your code
                e.cancel = true;
            }
        }
    });
}); 
Angular
TypeScript
HTML
import { DxGanttModule } from "devextreme-angular";
// ...
export class AppComponent {
    onTaskDeleting(e) {
        if (e.key != 0) {
            // your code
            e.cancel = true;
        }
    }
}
@NgModule({
    imports: [
        // ...
        DxGanttModule
    ],
    // ...
})
<dx-gantt ...
    (onTaskDeleting)="onTaskDeleting($event)">
</dx-gantt>
Vue
App.vue
<template>
    <DxGantt
        ...
        @task-deleting="onTaskDeleting"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxGantt from 'devextreme-vue/gantt';

export default {
    components: {
        DxGantt
    },
    methods: {
        onTaskDeleting(e) {
            if (e.key != 0) {
                // your code
                e.cancel = true;
            }
        }
    }
}
</script>
React
App.js
import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import Gantt from 'devextreme-react/gantt';

class App extends React.Component {
    // ...
    render() {
        return (
            <Gantt
                 //...
                 onTaskDeleting={this.onTaskDeleting}
            />
        );
    }
    onTaskDeleting = (e) => {
        if (e.key != 0) {
            // your code
            e.cancel = true;
        }
    }
}
export default App;
ASP.NET MVC Controls
Razor C#
@(Html.DevExtreme().Gantt()
    .ID("gantt")
    // ...
    .onTaskDeleting("gantt_taskDeleting_handler")
)
<script>
    function gantt_taskDeleting_handler(e) {
        if (e.key != 0) {
            // your code
            e.cancel = true;
        }
    }
</script>
See Also

onTaskEditDialogShowing

A function that is executed before the edit dialog is shown.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
cancel

Boolean

Allows you to cancel the edit dialog showing.

component

Gantt

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

hiddenFields

Array<String>

An array of hidden fields.

key any

The task key.

model any

Model data. Available only if you use Knockout.

readOnlyFields

Array<String>

An array of read-only fields.

values any

The task values.

Default Value: null

Note that the hiddenFields and readOnlyFields parameters affect only task fields. Use the allowTaskResourceUpdating property to hide the Resource Manager in the Task Details dialog.

DevExtreme Gantt Chart - Task Edit Dialog

jQuery
index.js
$(function() {
    $("#gantt").dxGantt({
        // ...
        onTaskEditDialogShowing: function (e) {
            if (e.key != 0) {
                // your code
                e.cancel = true;
            }
        }
    });
}); 
Angular
TypeScript
HTML
import { DxGanttModule } from "devextreme-angular";
// ...
export class AppComponent {
    onTaskEditDialogShowing(e) {
        if (e.key != 0) {
            // your code
            e.cancel = true;
        }
    }
}
@NgModule({
    imports: [
        // ...
        DxGanttModule
    ],
    // ...
})
<dx-gantt ...
    (onTaskEditDialogShowing)="onTaskEditDialogShowing($event)">
</dx-gantt>
Vue
App.vue
<template>
    <DxGantt
        ...
        @task-edit-dialog-showing="onTaskEditDialogShowing"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxGantt from 'devextreme-vue/gantt';

export default {
    components: {
        DxGantt
    },
    methods: {
        onTaskEditDialogShowing(e) {
            if (e.key != 0) {
                // your code
                e.cancel = true;
            }
        }
    }
}
</script>
React
App.js
import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import Gantt from 'devextreme-react/gantt';

class App extends React.Component {
    // ...
    render() {
        return (
            <Gantt
                 //...
                 onTaskEditDialogShowing={this.onTaskEditDialogShowing}
            />
        );
    }
    onTaskEditDialogShowing = (e) => {
        if (e.key != 0) {
            // your code
            e.cancel = true;
        }
    }
}
export default App;
ASP.NET MVC Controls
Razor C#
@(Html.DevExtreme().Gantt()
    .ID("gantt")
    // ...
    .onTaskEditDialogShowing("gantt_taskEditDialogShowing_handler")
)
<script>
    function gantt_taskEditDialogShowing_handler(e) {
        if (e.key != 0) {
            // your code
            e.cancel = true;
        }
    }
</script>
See Also

onTaskInserted

A function that is executed when a task is inserted.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Gantt

The UI component's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

key any

The key of the inserted task.

model any

Model data. Available only if you use Knockout.

values any

The values of the inserted task.

Default Value: null

DevExtreme Gantt Chart - Task Element

jQuery
index.js
$(function() {
    $("#gantt").dxGantt({
        // ...
        onTaskInserted: function (e) {
            if (e.values.text == " ") {
                // your code
            }
        }
    });
}); 
Angular
TypeScript
HTML
import { DxGanttModule } from "devextreme-angular";
// ...
export class AppComponent {
    onTaskInserted(e) {
        if (e.values.text == " ") {
            // your code
        }
    }
}
@NgModule({
    imports: [
        // ...
        DxGanttModule
    ],
    // ...
})
<dx-gantt ...
    (onTaskInserted)="onTaskInserted($event)">
</dx-gantt>
Vue
App.vue
<template>
    <DxGantt
        ...
        @task-inserted="onTaskInserted"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxGantt from 'devextreme-vue/gantt';

export default {
    components: {
        DxGantt
    },
    methods: {
        onTaskInserted(e) {
            if (e.values.text == " ") {
                // your code
            }
        }
    }
}
</script>
React
App.js
import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import Gantt from 'devextreme-react/gantt';

class App extends React.Component {
    // ...
    render() {
        return (
            <Gantt
                 //...
                 onTaskInserted={this.onTaskInserted}
            />
        );
    }
    onTaskInserted = (e) => {
        if (e.values.text == " ") {
            // your code
        }
    }
}
export default App;
ASP.NET MVC Controls
Razor C#
@(Html.DevExtreme().Gantt()
    .ID("gantt")
    // ...
    .onTaskInserted("gantt_taskInserted_handler")
)
<script>
    function gantt_taskInserted_handler(e) {
        if (e.values.text == " ") {
            // your code
        }
    }
</script>
See Also

onTaskInserting

A function that is executed before a task is inserted.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
cancel

Boolean

Allows you to cancel the task insertion.

component

Gantt

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

model any

Model data. Available only if you use Knockout.

values any

The values of the inserted task.

Default Value: null

DevExtreme Gantt Chart - Task Element

jQuery
index.js
$(function() {
    $("#gantt").dxGantt({
        // ...
        onTaskInserting: function (e) {
            if (e.values.text == " ") {
                // your code
                e.cancel = true;
            }
        }
    });
}); 
Angular
TypeScript
HTML
import { DxGanttModule } from "devextreme-angular";
// ...
export class AppComponent {
    onTaskInserting(e) {
        if (e.values.text == " ") {
            // your code
            e.cancel = true;
        }
    }
}
@NgModule({
    imports: [
        // ...
        DxGanttModule
    ],
    // ...
})
<dx-gantt ...
    (onTaskInserting)="onTaskInserting($event)">
</dx-gantt>
Vue
App.vue
<template>
    <DxGantt
        ...
        @task-inserting="onTaskInserting"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxGantt from 'devextreme-vue/gantt';

export default {
    components: {
        DxGantt
    },
    methods: {
        onTaskInserting(e) {
            if (e.values.text == " ") {
                // your code
                e.cancel = true;
            }
        }
    }
}
</script>
React
App.js
import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import Gantt from 'devextreme-react/gantt';

class App extends React.Component {
    // ...
    render() {
        return (
            <Gantt
                 //...
                 onTaskInserting={this.onTaskInserting}
            />
        );
    }
    onTaskInserting = (e) => {
        if (e.values.text == " ") {
            // your code
            e.cancel = true;
        }
    }
}
export default App;
ASP.NET MVC Controls
Razor C#
@(Html.DevExtreme().Gantt()
    .ID("gantt")
    // ...
    .onTaskInserting("gantt_taskInserting_handler")
)
<script>
    function gantt_taskInserting_handler(e) {
        if (e.values.text == " ") {
            // your code
            e.cancel = true;
        }
    }
</script>
See Also

onTaskMoving

A function that is executed before a task is moved.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
cancel

Boolean

Allows you to cancel the task's movement.

component

Gantt

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

key any

The task key.

model any

Model data. Available only if you use Knockout.

newValues any

The task values after moving.

values any

The task values before moving.

Default Value: null

DevExtreme Gantt Chart - Task Element

jQuery
index.js
$(function() {
    $("#gantt").dxGantt({
        // ...
        onTaskMoving: function (e) {
            if (e.key != 0) {
                // your code
                e.cancel = true;
            }
        }
    });
}); 
Angular
TypeScript
HTML
import { DxGanttModule } from "devextreme-angular";
// ...
export class AppComponent {
    onTaskMoving(e) {
        if (e.key != 0) {
            // your code
            e.cancel = true;
        }
    }
}
@NgModule({
    imports: [
        // ...
        DxGanttModule
    ],
    // ...
})
<dx-gantt ...
    (onTaskMoving)="onTaskMoving($event)">
</dx-gantt>
Vue
App.vue
<template>
    <DxGantt
        ...
        @task-moving="onTaskMoving"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxGantt from 'devextreme-vue/gantt';

export default {
    components: {
        DxGantt
    },
    methods: {
        onTaskMoving(e) {
            if (e.key != 0) {
                // your code
                e.cancel = true;
            }
        }
    }
}
</script>
React
App.js
import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import Gantt from 'devextreme-react/gantt';

class App extends React.Component {
    // ...
    render() {
        return (
            <Gantt
                 //...
                 onTaskMoving={this.onTaskMoving}
            />
        );
    }
    onTaskMoving = (e) => {
        if (e.key != 0) {
            // your code
            e.cancel = true;
        }
    }
}
export default App;
ASP.NET MVC Controls
Razor C#
@(Html.DevExtreme().Gantt()
    .ID("gantt")
    // ...
    .onTaskMoving("gantt_taskMoving_handler")
)
<script>
    function gantt_taskMoving_handler(e) {
        if (e.key != 0) {
            // your code
            e.cancel = true;
        }
    }
</script>
See Also

onTaskUpdated

A function that is executed when a task is updated.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Gantt

The UI component's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

key any

The key of the updated task.

model any

Model data. Available only if you use Knockout.

values any

The task values after update.

Default Value: null

DevExtreme Gantt Chart - Task Element

jQuery
index.js
$(function() {
    $("#gantt").dxGantt({
        // ...
        onTaskUpdated: function (e) {
            if (e.key != 0) {
                // your code
            }
        }
    });
}); 
Angular
TypeScript
HTML
import { DxGanttModule } from "devextreme-angular";
// ...
export class AppComponent {
    onTaskUpdated(e) {
        if (e.key != 0) {
            // your code
        }
    }
}
@NgModule({
    imports: [
        // ...
        DxGanttModule
    ],
    // ...
})
<dx-gantt ...
    (onTaskUpdated)="onTaskUpdated($event)">
</dx-gantt>
Vue
App.vue
<template>
    <DxGantt
        ...
        @task-updated="onTaskUpdated"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxGantt from 'devextreme-vue/gantt';

export default {
    components: {
        DxGantt
    },
    methods: {
        onTaskUpdated(e) {
            if (e.key != 0) {
                // your code
            }
        }
    }
}
</script>
React
App.js
import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import Gantt from 'devextreme-react/gantt';

class App extends React.Component {
    // ...
    render() {
        return (
            <Gantt
                 //...
                 onTaskUpdated={this.onTaskUpdated}
            />
        );
    }
    onTaskUpdated = (e) => {
        if (e.key != 0) {
            // your code
        }
    }
}
export default App;
ASP.NET MVC Controls
Razor C#
@(Html.DevExtreme().Gantt()
    .ID("gantt")
    // ...
    .onTaskUpdated("gantt_taskUpdated_handler")
)
<script>
    function gantt_taskUpdated_handler(e) {
        if (e.key != 0) {
            // your code
        }
    }
</script>
See Also

onTaskUpdating

A function that is executed before a task is updated.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
cancel

Boolean

Allows you to cancel the task update.

component

Gantt

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

key any

The task key.

model any

Model data. Available only if you use Knockout.

newValues any

The task values after update.

values any

The task values before update.

Default Value: null

DevExtreme Gantt Chart - Task Element

jQuery
index.js
$(function() {
    $("#gantt").dxGantt({
        // ...
        onTaskUpdating: function (e) {
            if (e.key != 0) {
                // your code
                e.cancel = true;
            }
        }
    });
}); 
Angular
TypeScript
HTML
import { DxGanttModule } from "devextreme-angular";
// ...
export class AppComponent {
    onTaskUpdating(e) {
        if (e.key != 0) {
            // your code
            e.cancel = true;
        }
    }
}
@NgModule({
    imports: [
        // ...
        DxGanttModule
    ],
    // ...
})
<dx-gantt ...
    (onTaskUpdating)="onTaskUpdating($event)">
</dx-gantt>
Vue
App.vue
<template>
    <DxGantt
        ...
        @task-updating="onTaskUpdating"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxGantt from 'devextreme-vue/gantt';

export default {
    components: {
        DxGantt
    },
    methods: {
        onTaskUpdating(e) {
            if (e.key != 0) {
                // your code
                e.cancel = true;
            }
        }
    }
}
</script>
React
App.js
import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import Gantt from 'devextreme-react/gantt';

class App extends React.Component {
    // ...
    render() {
        return (
            <Gantt
                 //...
                 onTaskUpdating={this.onTaskUpdating}
            />
        );
    }
    onTaskUpdating = (e) => {
        if (e.key != 0) {
            // your code
            e.cancel = true;
        }
    }
}
export default App;
ASP.NET MVC Controls
Razor C#
@(Html.DevExtreme().Gantt()
    .ID("gantt")
    // ...
    .onTaskUpdating("gantt_taskUpdating_handler")
)
<script>
    function gantt_taskUpdating_handler(e) {
        if (e.key != 0) {
            // your code
            e.cancel = true;
        }
    }
</script>
See Also

resourceAssignments

Configures resource assignments.

Type:

Object

Default Value: null

View Demo

Resource assignments define relationship between tasks and resources.

Use the dataSource property to bind the UI component to a data source, which contains resource assignments. If the field names in your data source differ from the 'id', 'resourceId' and 'taskId' default names, use the keyExpr, resourceIdExpr and/or taskIdExpr properties to map data fields.

See Also
jQuery
index.js
data.js
$(function() {
    $("#gantt").dxGantt({
        resourceAssignments: {
            dataSource: resourceAssignments,
            keyExpr: "key",
            resourceIdExpr: "resourceKey",
            taskIdExpr: "taskKey"
        },
        //...
    });
});
var resourceAssignments = [{
    'key': 0,
    'taskKey': 3,
    'resourceKey': 1
},
// ...
];    
Angular
app.component.html
app.component.ts
app.module.ts
app.service.ts
angular.json
<dx-gantt ... >
    <dxo-resource-assignments 
        [dataSource]="resourceAssignments" 
        keyExpr="key"
        resourceIdExpr="resourceKey" 
        taskIdExpr="taskKey">
    </dxo-resource-assignments>
    <!-- ... -->
</dx-gantt>
import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})    

export class AppComponent {
    resourceAssignments: ResourceAssignment[];
    // ...

    constructor(service: Service) {
        this.resourceAssignments = service.getResourceAssignments();
        // ...
    }
}
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';
import { DxGanttModule } from 'devextreme-angular';
import { Service, ResourceAssignment, ... } from './app.service';

@NgModule({
    imports: [
        BrowserModule,
        DxGanttModule
    ],
    declarations: [AppComponent],
    bootstrap: [AppComponent]
})
export class AppModule { }
import { Injectable } from '@angular/core';

export class ResourceAssignment {
    id: number;
    taskId: number;
    resourceId: number;
}

const resourceAssignments: ResourceAssignment[] = [{
    'key': 0,
    'taskKey': 3,
    'resourceKey': 1
},
// ...   
]; 
@Injectable()
export class Service {
    getResourceAssignments(): ResourceAssignment[] {
        return resourceAssignments;
    }
}
{
  "projects": {
    "ProjectName": {
      "architect": {
        "build": {
          "options": {
            "styles": [
              "node_modules/devextreme/dist/css/dx.light.css",
              "node_modules/devexpress-gantt/dist/dx-gantt.css",
              "src/styles.css"
            ],
            ...
          },
          ...
        },
        ...
      }
    },
    ...
  },
  ...
}
Vue
App.vue
data.js
<template>
    <DxGantt ... >
        <DxResourceAssignments 
            :data-source="resourceAssignments"
            key-expr="key"
            resource-id-expr="resourceKey"
            task-id-expr="taskKey" />
        <!-- ... -->
    </DxGantt>
</template>
<script>
    import 'devextreme/dist/css/dx.light.css';
    import 'devexpress-gantt/dist/dx-gantt.css';  

    import { 
        DxGantt, 
        DxResourceAssignments, 
        //... 
    } from 'devextreme-vue/gantt';
    import { 
        resourceAssignments, 
        // ... 
    } from './data.js';

    export default {
        components: { 
            DxGantt, 
            DxResourceAssignments, 
            //... 
        },
        data() {
            return { 
                resourceAssignments, 
                //... 
            };
        }
    };
</script>
export const resourceAssignments = [{
    'key': 0,
    'taskKey': 3,
    'resourceKey': 1
},
// ...
];
React
App.js
data.js
import React from 'react';

import 'devextreme/dist/css/dx.light.css';
import 'devexpress-gantt/dist/dx-gantt.css'; 

import Gantt, { 
    ResourceAssignments, 
    //... 
} from 'devextreme-react/gantt';
import { 
    resourceAssignments, 
    //... 
} from './data.js';

const App = () => {
    return (
        <Gantt ... >  
            <ResourceAssignments 
                dataSource={resourceAssignments} 
                keyExpr="key"
                resourceIdExpr="resourceKey" 
                taskIdExpr="taskKey" />
        </Gantt>            
    );
};

export default App;
export const resourceAssignments = [{
    'key': 0,
    'taskKey': 3,
    'resourceKey': 1
},
// ...
];

resources

Configures task resources.

Type:

Object

Default Value: null

View Demo

You can add resources to a project and assign them to tasks. Resources can be people responsible for tasks, equipment, materials, etc. The Gantt displays resources as labels on the right of the tasks.

DevExtreme Gantt Chart - Resources

Use the dataSource property to bind the UI component to a data source, which contains resources. If the field names in your data source differ from the 'id', 'text' and 'color' default names, use the keyExpr, textExpr and/or colorExpr properties to map data fields.

See Also
jQuery
index.js
data.js
$(function() {
    $("#gantt").dxGantt({
        resources: {
            dataSource: resources,
            keyExpr: "resourceId",
            textExpr: "title",
            colorExpr: "resourceColor"
        },
        //...
    });
});
var resources = [{
    'resourceId': 1,
    'title': 'Management',
    'resourceColor': 'red'
}, 
// ...
];    
Angular
app.component.html
app.component.ts
app.module.ts
app.service.ts
angular.json
<dx-gantt ... >
    <dxo-resources 
        [dataSource]="resources" 
        keyExpr="resourceId"
        textExpr="title"
        colorExpr="resourceColor" >
    </dxo-resources>
    <!-- ... -->
</dx-gantt>
import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})

export class AppComponent {
    resources: Resource[];
    // ...
    constructor(service: Service) {
        this.resources = service.getResources();
        // ...
    }        
}
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';
import { DxGanttModule } from 'devextreme-angular';
import { Service, Resource, ... } from './app.service';

@NgModule({
    imports: [
        BrowserModule,
        DxGanttModule
    ],
    providers: [Service],
    declarations: [AppComponent],
    bootstrap: [AppComponent]
})
export class AppModule { }
import { Injectable } from '@angular/core';

export class Resource {
    resourceId: number;
    title: string;
    resourceColor: string;

}

const resources: Resource[] = [{
    'resourceId': 1,
    'title': 'Management',
    'resourceColor': 'red'
},
// ...   
]; 
@Injectable()
export class Service {
    getResources(): Resource[] {
        return resources;
    }
}
{
  "projects": {
    "ProjectName": {
      "architect": {
        "build": {
          "options": {
            "styles": [
              "node_modules/devextreme/dist/css/dx.light.css",
              "node_modules/devexpress-gantt/dist/dx-gantt.css",
              "src/styles.css"
            ],
            ...
          },
          ...
        },
        ...
      }
    },
    ...
  },
  ...
}
Vue
App.vue
data.js
<template>
    <DxGantt ... >
        <DxResources 
            :data-source="resources"
            key-expr="resourceId"
            text-expr="title"
            color-expr="resourceColor" />
        <!-- ... -->
    </DxGantt>
</template>
<script>
    import 'devextreme/dist/css/dx.light.css'; 
    import 'devexpress-gantt/dist/dx-gantt.css'; 

    import { 
        DxGantt, 
        DxResources, 
        // ... 
    } from 'devextreme-vue/gantt';
    import { 
        resources, 
        // ... 
    } from './data.js';

    export default {
        components: { 
            DxGantt, 
            DxResources, 
            // ... 
        },
        data() {
            return { 
                resources, 
                // ... 
            };
        }
    };
</script>
export const resources = [{
    'resourceId': 1,
    'title': 'Management',
    'resourceColor': 'red'
},
// ...
];  
React
App.js
data.js
import React from 'react';

import 'devextreme/dist/css/dx.light.css';
import 'devexpress-gantt/dist/dx-gantt.css'; 

import Gantt, { 
    Resources, 
    // ... 
} from 'devextreme-react/gantt';
import { 
    resources, 
    // ... 
} from './data.js';

const App = () => {
    return (
        <Gantt ... >
            <Resources 
                dataSource={resources}
                keyExpr="resourceId"
                textExpr="title" 
                colorExpr="resourceColor" />
            {/* ... */}
        </Gantt>
    );
};

export default App;
export const resources = [{
    'resourceId': 1,
    'title': 'Management',
    'resourceColor': 'red'
},
// ...
];

rootValue

Specifies the root task's identifier.

Type: any
Default Value: 0

scaleType

Specifies the zoom level of tasks in the Gantt chart.

Type:

String

Default Value: 'auto'
Accepted Values: 'auto' | 'minutes' | 'hours' | 'days' | 'weeks' | 'months' | 'quarters' | 'years'

The scaleType property specifies the zoom level for tasks when the Gantt UI component is initialized or when you call the option() method.

jQuery
JavaScript
$(function() {
    $("#gantt").dxGantt({
        scaleType: 'hours',
        // ...
    });
}); 

If the scaleType property is set to "auto", the UI component is scaled to fit all tasks in the Gantt chart's visible area.

To browse tasks across various levels of detail in real time, hold the CTRL key and scroll the mouse wheel to zoom (in or out).

selectedRowKey

Allows you to select a row or determine which row is selected.

Type: any
Default Value: undefined

View Demo

jQuery
JavaScript
$(function() {
    $("#gantt").dxGantt({
        selectedRowKey: 1,
        // ...
    });
}); 
See Also

showResources

Specifies whether to display task resources.

Type:

Boolean

Default Value: true

View Demo

jQuery
JavaScript
$(function() {
    $("#gantt").dxGantt({
        showResources: false,
        // ...
    });
}); 

showRowLines

Specifies whether to show/hide horizontal faint lines that separate tasks.

Type:

Boolean

Default Value: true

jQuery
JavaScript
$(function() {
    $("#gantt").dxGantt({
        showRowLines: false,
        // ...
    });
}); 

stripLines[]

Configures strip lines.

Type:

Array<dxGanttStripLine>

Default Value: undefined

View Demo

Strip lines allows you to highlight certain time or time intervals in the chart. Use the start property to specify an individual line or combine it with the end property setting to specify a time interval.

DevExtreme Gantt - Strip Lines

jQuery
index.js
$(function() {
    $("#gantt").dxGantt({
        stripLines: [{
            title: "Start",
            start: tasks[0].start
        }, {
            title: "Final Phase",
            start: tasks[tasks.length - 3].start,
            end: tasks[tasks.length - 1].end,
        }, {
            title: "Current Time",
            start: new Date(),
            cssClass: "current-time"
        }],
        //...
    });
});

tabIndex

Specifies the number of the element when the Tab key is used for navigating.

Type:

Number

Default Value: 0

The value of this property will be passed to the tabindex attribute of the HTML element that underlies the UI component.

taskContentComponent

An alias for the taskContentTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.

taskContentRender

An alias for the taskContentTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.

taskContentTemplate

Specifies custom content for the task.

Type:

template

Template Data:
Name Type Description
cellSize

Object

The size of the cell that contains the task.

isMilestone

Boolean

Specifies whether the task is a milestone.

taskData

Object

The processed task.

taskHTML

Object

The default HTML element of the processed task.

taskPosition

Object

The task's position.

taskResources

Array<Object>

The task's resources.

taskSize

Object

The task's size.

jQuery
JavaScript
$(function() {
    $("#gantt").dxGantt({
        taskContentTemplate: getTaskContentTemplate,
        // ...
    });
}); 

function getTaskContentTemplate(item, container) {
    var $customContainer = $(document.createElement("div")) 
        .addClass("custom-task") 
        .text(item.taskData.title) 
        .attr("style", "width:" + item.taskSize.width + "px"); 
    return $customContainer; 
}
Angular
app.component.html
app.component.ts
app.module.ts
<dx-gantt taskContentTemplate="myTaskTemplate">
    <div *dxTemplate="let data of 'myTaskTemplate'">
        <div [style.width.px]="item.taskSize.width" class="custom-task">{{item.taskData.title}}</div>
        <!-- ... -->
    </div>    
    ...
</dx-gantt>
import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})

export class AppComponent {
    // ...
}
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxGanttModule } from 'devextreme-angular';

@NgModule({
    imports: [
        BrowserModule,
        DxGanttModule
    ],
    declarations: [AppComponent],
    bootstrap: [AppComponent]
})
export class AppModule { }
Vue
App.vue
<template>
    <DxGantt 
        :task-content-template="myTaskTemplate" >
        <template #myTaskTemplate="{ data : item }">
            <div [style.width.px]="item.taskSize.width" class="custom-task">{{item.taskData.title}}</div>
            <!-- ... -->
        </template>                       
    </DxGantt>
</template>

<script>
import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';

import { DxGantt } from 'devextreme-vue/gantt';

export default {
    components: {
        DxGantt
    },
    methods: {
        //...
    },
    data() {
        return {
            // ...
        }
    }
}
</script>
React
App.js
import React from 'react';
import Gantt from 'devextreme-react/gantt';
import { Template } from 'devextreme-react/core/template';

const TaskTemplate = (item) => {
    return ( 
        <div className="custom-task" style={{width: item.taskSize.width + "px"}}> 
            <div className="custom-task-title">{item.taskData.title}</div> 
        </div> 
    );         
}

export default function App() {
    return (
        <Gantt 
            taskContentRender={TaskTemplate}>
            //...
        </Gantt>
    );  
}

export default App;
ASP.NET MVC Controls
Razor C#
@(Html.DevExtreme().Gantt()
    .TaskContentTemplate(new JS("getTaskContentTemplate"))
    // ...
)

<script>
    function getTaskContentTemplate(task, container) {
        var $customContainer = $(document.createElement("div"))
            .addClass("custom-task");
            .text(item.Task.Title);
            .attr("style", "width:" + item.TaskSize.Width + "px"); 
        return $customContainer;
    }    
</script>
return: String | TElement

taskListWidth

Specifies the width of the task list in pixels.

Type:

Number

Default Value: 300

View Demo

DevExtreme Gantt Chart - Task List

jQuery
JavaScript
$(function() {
    $("#gantt").dxGantt({
        taskListWidth: 200,
        // ...
    });
}); 

taskProgressTooltipContentComponent

An alias for the taskProgressTooltipContentTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.

taskProgressTooltipContentRender

An alias for the taskProgressTooltipContentTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.

taskProgressTooltipContentTemplate

Specifies custom content for the tooltip that displays the task's progress while the progress handler is resized in the UI.

Type:

template

Template Data:
Name Type Description
progress

Number

The task's progress.

jQuery
JavaScript
$(function() {
    $("#gantt").dxGantt({
        taskProgressTooltipContentTemplate: getTaskProgressTooltipContentTemplate,
        // ...
    });
}); 

function getTaskProgressTooltipContentTemplate(item, container) {
    var $customTooltipProgress = $(document.createElement("div"))
        .addClass("custom-tooltip");

​ $(document.createElement("div")) .addClass("custom-tooltip-progress") .text("Progress: " + item.progress + "%") .appendTo($customTooltipProgress); // ... return $customTooltipProgress; }

Angular
app.component.html
app.component.ts
app.module.ts
<dx-gantt taskProgressTooltipContentTemplate="myTaskProgressTooltipTemplate">
    <div *dxTemplate="let item of 'myTaskProgressTooltipTemplate'" class="custom-tooltip">
        <div class="custom-tooltip-progress">Progress: {{item.progress}}%</div>
        <!-- ... -->
    </div>
    ...
</dx-gantt>
import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})

export class AppComponent {
    // ...
}
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxGanttModule } from 'devextreme-angular';

@NgModule({
    imports: [
        BrowserModule,
        DxGanttModule
    ],
    declarations: [AppComponent],
    bootstrap: [AppComponent]
})
export class AppModule { }
Vue
App.vue
<template>
    <DxGantt 
        :task-progress-tooltip-content-template="myTaskProgressTooltipTemplate" >
        <template #myTaskProgressTooltipTemplate="{ data: item }">
            <div class="custom-tooltip">
                <div class="custom-tooltip-progress">Progress: {{ item.progress }}%</div>
                <!-- ... -->
            </div>            
        </template>
    </DxGantt>
</template>

<script>
import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';

import { DxGantt } from 'devextreme-vue/gantt';

export default {
    components: {
        DxGantt
    },
    methods: {
        //...
    },
    data() {
        return {
            // ...
        }
    }
}
</script>
React
App.js
import React from 'react';
import Gantt from 'devextreme-react/gantt';
import { Template } from 'devextreme-react/core/template';

const TaskProgressTooltipTemplate = (item) => {
    return ( 
        <div className="custom-tooltip">
            <div className="custom-tooltip-progress">Progress: {item.progress}%</div>
            <!-- ... -->
        </div>            
    );         
}

export default function App() {
    return (
        <Gantt
            taskProgressTooltipContentRender={TaskProgressTooltipTemplate}>
            //...
        </Gantt>
    );
}

export default App;
ASP.NET MVC Controls
Razor C#
@(Html.DevExtreme().Gantt()
    .TaskProgressTooltipContentTemplate(new JS("getTaskProgressTooltipContentTemplate"))
    // ...
)

<script>
    function getTaskProgressTooltipContentTemplate(item, container) {
        var $customTooltipProgress = $(document.createElement("div"))
            .addClass("custom-tooltip");
    ​
        $(document.createElement("div"))
            .addClass("custom-tooltip-progress")
            .text("Progress: " + item.progress + "%")
            .appendTo($customTooltipProgress);
        // ...
        return $customTooltipProgress;
    }
</script>

tasks

Configures tasks.

Type:

Object

Default Value: null

View Demo

DevExtreme Gantt Chart - Tasks

Use the dataSource property to bind the UI component to a data source, which contains tasks. If the field names in your data source differ from default names ('id', 'parentId', 'title', 'start', 'end', 'progress', 'color'), use appropriate properties (keyExpr, parentIdExpr, etc.) to map data fields.

See Also
jQuery
index.js
data.js
$(function() {
    $("#gantt").dxGantt({
        tasks: {
            dataSource: tasks,
            keyExpr: "taskId", 
            parentIdExpr: "parentTaskId",
            titleExpr: "taskTitle",
            progressExpr: "taskProgress",
            startExpr: "startDate",
            endExpr: "endDate",
            colorExpr: "taskColor"
        },
        //...
    });
});
var tasks = [{
    'taskId': 1,
    'parentTaskId': 0,
    'taskTitle': 'Software Development',
    'startDate': new Date('2019-02-21T05:00:00.000Z'),
    'endDate': new Date('2019-07-04T12:00:00.000Z'),
    'taskProgress': 31
    'taskColor': 'red'
},
// ...
];
Angular
app.component.html
app.component.ts
app.module.ts
app.service.ts
angular.json
<dx-gantt ... >
    <dxo-tasks 
        [dataSource]="tasks" 
        keyExpr="taskId"
        parentIdExpr="parentTaskId"
        titleExpr="taskTitle"
        progressExpr="taskProgress"
        startExpr="startDate"
        endExpr="endDate"
        colorExpr="taskColor" >
    </dxo-tasks>
    <!-- ... -->
</dx-gantt>
import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})

export class AppComponent {
    tasks: Task[];
    // ...
    constructor(service: Service) {
        this.tasks = service.getTasks();
        // ...
    }        
}
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';
import { DxGanttModule } from 'devextreme-angular';
import { Service, Task, ... } from './app.service';

@NgModule({
    imports: [
        BrowserModule,
        DxGanttModule
    ],
    providers: [Service],
    declarations: [AppComponent],
    bootstrap: [AppComponent]
})
export class AppModule { }
import { Injectable } from '@angular/core';

export class Task {
    taskId: number;
    parentTaskId: number;
    taskTitle: string;
    startDate: Date;
    endDate: Date;
    taskProgress: number;
    taskColor: string;
}

const tasks: Task[] = [{
    'taskId': 1,
    'parentTaskId': 0,
    'taskTitle': 'Software Development',
    'startDate': new Date('2019-02-21T05:00:00.000Z'),
    'endDate': new Date('2019-07-04T12:00:00.000Z'),
    'taskProgress': 31,
    'taskColor': 'red'
},
// ...   
]; 
@Injectable()
export class Service {
    getTasks(): Task[] {
        return tasks;
    }
}
{
  "projects": {
    "ProjectName": {
      "architect": {
        "build": {
          "options": {
            "styles": [
              "node_modules/devextreme/dist/css/dx.light.css",
              "node_modules/devexpress-gantt/dist/dx-gantt.css",
              "src/styles.css"
            ],
            ...
          },
          ...
        },
        ...
      }
    },
    ...
  },
  ...
}
Vue
App.vue
data.js
<template>
    <DxGantt ... >        
        <DxTasks
            :data-source="tasks"
            key-expr="taskId"
            parent-id-expr="parentTaskId"
            title-expr="taskTitle"
            progress-expr="taskProgress"
            start-expr="startDate"
            end-expr="endDate"
            color-expr="taskColor" />
        <!-- ... -->
    </DxGantt>
</template>
<script>
    import 'devextreme/dist/css/dx.light.css';
    import 'devexpress-gantt/dist/dx-gantt.css'; 

    import { 
        DxGantt, 
        DxTasks, 
        // ... 
    } from 'devextreme-vue/gantt';

    import { 
        tasks, 
        // ... 
    } from './data.js';

    export default {
        components: { 
            DxGantt, 
            DxTasks, 
            // ... 
        },
        data() {
            return { 
                tasks, 
                // ... 
            };
        }
    };
</script>
export const tasks = [{
    'taskId': 1,
    'parentTaskId': 0,
    'taskTitle': 'Software Development',
    'startDate': new Date('2019-02-21T05:00:00.000Z'),
    'endDate': new Date('2019-07-04T12:00:00.000Z'),
    'taskProgress': 31,
    'taskColor': 'red'
},
// ...
];  
React
App.js
data.js
import React from 'react';

import 'devextreme/dist/css/dx.light.css';
import 'devexpress-gantt/dist/dx-gantt.css'; 

import Gantt, { 
    Tasks, 
    // ... 
} from 'devextreme-react/gantt';
import { 
    tasks, 
    // ... 
} from './data.js';

const App = () => {
    return (
        <Gantt ... >
            <Tasks 
                dataSource={tasks}
                keyExpr="taskId"
                parentIdExpr="parentTaskId"
                titleExpr="taskTitle"
                progressExpr="taskProgress"
                startExpr="startDate"
                endExpr="endDate"
                colorExpr="taskColor" />
            {/* ... */}
        </Gantt>
    );
};

export default App;
export const tasks = [{
    'taskId': 1,
    'parentTaskId': 0,
    'taskTitle': 'Software Development',
    'startDate': new Date('2019-02-21T05:00:00.000Z'),
    'endDate': new Date('2019-07-04T12:00:00.000Z'),
    'taskProgress': 31,
    'taskColor': 'red'
},
// ...
];

taskTimeTooltipContentComponent

An alias for the taskTimeTooltipContentTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.

taskTimeTooltipContentRender

An alias for the taskTimeTooltipContentTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.

taskTimeTooltipContentTemplate

Specifies custom content for the tooltip that displays the task's start and end time while the task is resized in the UI.

Type:

template

Template Data:
Name Type Description
end

Date

The task's end date.

start

Date

The task's start date.

jQuery
JavaScript
$(function() {
    $("#gantt").dxGantt({
        taskTimeTooltipContentTemplate: getTaskTimeTooltipContentTemplate,
        // ...
    });
}); 

function getTaskTimeTooltipContentTemplate(item, container) {
    var $customTooltipTime = $(document.createElement("div"))
        .addClass("custom-tooltip");

​ $(document.createElement("div")) .addClass("custom-tooltip-time") .text("End Date: " + item.end) .appendTo($customTooltipTime); // ... return $customTooltipTime; }

Angular
app.component.html
app.component.ts
app.module.ts
<dx-gantt taskTimeTooltipContentTemplate="myTaskTimeTooltipTemplate">
    <div *dxTemplate="let item of 'myTaskTimeTooltipTemplate'" class="custom-tooltip">
        <div class="custom-tooltip-time">End Date: {{item.end}}</div>
        <!-- ... -->
    </div>
    ...
</dx-gantt>
import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})

export class AppComponent {
    // ...
}
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxGanttModule } from 'devextreme-angular';

@NgModule({
    imports: [
        BrowserModule,
        DxGanttModule
    ],
    declarations: [AppComponent],
    bootstrap: [AppComponent]
})
export class AppModule { }
Vue
App.vue
<template>
    <DxGantt 
        :task-time-tooltip-content-template="myTaskTimeTooltipTemplate" >
        <template #myTaskTimeTooltipTemplate="{ data: item }">
            <div class="custom-tooltip">
                <div class="custom-tooltip-time">End Date: {{item.end}}</div>
                <!-- ... -->
            </div>
        </template>
    </DxGantt>
</template>

<script>
import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';

import { DxGantt } from 'devextreme-vue/gantt';

export default {
    components: {
        DxGantt
    },
    methods: {
        //...
    },
    data() {
        return {
            // ...
        }
    }
}
</script>
React
App.js
import React from 'react';
import Gantt from 'devextreme-react/gantt';
import { Template } from 'devextreme-react/core/template';

const TaskTimeTooltipTemplate = (item) => {
    return ( 
        <div className="custom-tooltip">
            <div className="custom-tooltip-time">End Date: {item.end}</div>
            <!-- ... -->
        </div>
    );         
}

export default function App() {
    return (
        <Gantt
            taskTimeTooltipContentRender={TaskTimeTooltipTemplate}>
            //...
        </Gantt>
    );
}

export default App;
ASP.NET MVC Controls
Razor C#
@(Html.DevExtreme().Gantt()
    .TaskTimeTooltipContentTemplate(new JS("getTaskTimeTooltipContentTemplate"))
    // ...
)

<script>
    function getTaskTimeTooltipContentTemplate(item, container) {
        var $customTooltipTime = $(document.createElement("div"))
            .addClass("custom-tooltip");
​
        $(document.createElement("div"))
            .addClass("custom-tooltip-time")
            .text("End Date: " + item.end)
            .appendTo($customTooltipTime);
        // ...
        return $customTooltipTime;
    }
</script>

taskTitlePosition

Specifies a task's title position.

Type:

String

Default Value: 'inside'
Accepted Values: 'inside' | 'outside' | 'none'

Titles can be displayed "inside" or "outside" the the task. Set the position to "none" to hide the title.

DevExtreme Gantt Chart - Task titles

jQuery
JavaScript
$(function() {
    $("#gantt").dxGantt({
        taskTitlePosition: 'none',
        // ...
    });
}); 

taskTooltipContentComponent

An alias for the taskTooltipContentTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.

taskTooltipContentRender

An alias for the taskTooltipContentTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.

taskTooltipContentTemplate

Specifies custom content for the task tooltip.

Type:

template

Template Data:

HTMLElement | jQuery

The task tooltip's container. It is an HTML Element or a jQuery Element when you use jQuery.

View Demo

Note that the container parameter contains the content of the default tooltip. You should clear the container parameter to specify custom content for the task tooltip.

jQuery
JavaScript
$(function() {
    $("#gantt").dxGantt({
        taskTooltipContentTemplate: getTaskTooltipContentTemplate,
        // ...
    });
}); 

function getTaskTooltipContentTemplate(task, container) {
    var $customTooltip = $(document.createElement("div"))
        .addClass("custom-task-edit-tooltip");

​ $(document.createElement("div")) .addClass("custom-tooltip-title") .text(task.title) .appendTo($customTooltip); // ... return $customTooltip; }

Angular
app.component.html
app.component.ts
app.module.ts
<dx-gantt taskTooltipContentTemplate="myTaskTooltipTemplate">
    <div *dxTemplate="let task of 'myTaskTooltipTemplate'" class="custom-task-edit-tooltip">
        <div class="custom-tooltip-title">{{task.title}}</div>
        <!-- ... -->
    </div>
    ...
</dx-gantt>
import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})

export class AppComponent {
    // ...
}
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxGanttModule } from 'devextreme-angular';

@NgModule({
    imports: [
        BrowserModule,
        DxGanttModule
    ],
    declarations: [AppComponent],
    bootstrap: [AppComponent]
})
export class AppModule { }
Vue
App.vue
<template>
    <DxGantt 
        :task-tooltip-content-template="myTooltipContentTemplate" >
        <template #myTooltipContentTemplate="{ data: task }">
            <div class="custom-task-edit-tooltip">
                <div class="custom-tooltip-title">{{ task.title }}</div>
                <!-- ... -->
            </div>
        </template>
    </DxGantt>
</template>

<script>
import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';

import { DxGantt } from 'devextreme-vue/gantt';

export default {
    components: {
        DxGantt
    },
    methods: {
        //...
    },
    data() {
        return {
            // ...
        }
    }
}
</script>
React
App.js
import React from 'react';
import Gantt from 'devextreme-react/gantt';
import { Template } from 'devextreme-react/core/template';

const TaskTooltipTemplate = (task) => {
    return ( 
        <div class="custom-task-edit-tooltip">
            <div class="custom-tooltip-title">{{ task.title }}</div>
            <!-- ... -->
        </div>
    );         
}

export default function App() {
    return (
        <Gantt
            taskTooltipContentRender={TaskTooltipTemplate}>
            //...
        </Gantt>
    );
}

export default App;
ASP.NET MVC Controls
Razor C#
@(Html.DevExtreme().Gantt()
    .TaskTooltipContentTemplate(new JS("getTaskTooltipContentTemplate"))
    // ...
)

<script>
    function getTaskTooltipContentTemplate(task, container) {
        var $customTooltip = $(document.createElement("div"))
            .addClass("custom-task-edit-tooltip");

        $(document.createElement("div"))
            .addClass("custom-tooltip-title")
            .text(task.Title)
            .appendTo($customTooltip);
        // ...

        return $customTooltip;            
    }    
</script>

toolbar

Configures toolbar settings.

Type:

Object

Default Value: null

validation

Configures validation properties.

Type:

Object

jQuery
index.js
$(function() {
    $("#gantt").dxGantt({
        validation: {
            autoUpdateParentTasks: true,
            validateDependencies: true
        },
        // ...
    });
});
Angular
app.component.html
app.component.ts
app.module.ts
<dx-gantt ... >
    <dxo-validation
        [autoUpdateParentTasks]="true" 
        [validateDependencies]="true">
    </dxo-validation>
    <!-- ... -->
</dx-gantt>
import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})

export class AppComponent {
    // ...      
}
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';
import { DxGanttModule } from 'devextreme-angular';

@NgModule({
    imports: [
        BrowserModule,
        DxGanttModule
    ],        
    declarations: [AppComponent],
    bootstrap: [AppComponent]
})
export class AppModule { }
Vue
App.vue
<template>
    <DxGantt ... >
        <DxValidation
            :auto-update-parent-tasks="true"
            :validate-dependencies="true" 
         />
        <!-- ... -->
    </DxGantt>
</template>
<script>
    import 'devextreme/dist/css/dx.light.css';
    import 'devexpress-gantt/dist/dx-gantt.css'; 

    import { 
        DxGantt, 
        DxValidation, 
        // ... 
    } from 'devextreme-vue/gantt';

    export default {
        components: { 
            DxGantt, 
            DxValidation, 
            // ... 
        }
    };
</script>
React
App.js
import React from 'react';

import 'devextreme/dist/css/dx.light.css';
import 'devexpress-gantt/dist/dx-gantt.css'; 

import Gantt, { 
    Validation, 
    // ... 
} from 'devextreme-react/gantt';

const App = () => {
    return (
        <Gantt ... >
            <Validation
                autoUpdateParentTasks={true}
                validateDependencies={true} />
            {/* ... */}
        </Gantt>
    );
};

export default App;
ASP.NET MVC Controls
Razor C#
@(Html.DevExtreme().Gantt()
    .Validation(e => {
        e.AutoUpdateParentTasks(true)
        e.ValidateDependencies(true)
    })
    // ...
)

visible

Specifies whether the UI component is visible.

Type:

Boolean

Default Value: true

width

Specifies the UI component's width.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The UI component's width.

Default Value: undefined

This property accepts a value of one of the following types:

  • Number
    The width in pixels.

  • String
    A CSS-accepted measurement of width. For example, "55px", "80%", "auto", "inherit".

  • Function
    A function returning either of the above. For example:

    JavaScript
    width: function() {
        return window.innerWidth / 1.5;
    }