JavaScript/jQuery Gantt Methods

The resource key.

taskKey:

The task key.

jQuery

index.js

var gantt = $("#ganttContainer").dxGantt("instance");
gantt.assignResourceToTask("resource_key","task_key");

Angular

app.component.ts

app.component.html

app.module.ts

import { Component, ViewChild } from '@angular/core';
import { DxGanttComponent } from "devextreme-angular";

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

export class AppComponent {
    @ViewChild(DxGanttComponent, { static: false }) gantt: DxGanttComponent;
    // Prior to Angular 8
    // @ViewChild(DxGanttComponent) gantt: DxGanttComponent;

    yourCustomMethod() {
        this.gantt.instance.assignResourceToTask("resource_key","task_key"); 
        // ...
    }
}

<dx-gantt ... >
</dx-gantt>

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 ...
        :ref="ganttRef">
    </DxGantt>
</template>

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

import DxGantt from 'devextreme-vue/gantt';

const ganttRef = 'gantt';

export default {
    components: {
        DxGantt
    },
    data() {
        return {
            ganttRef
        }
    },
    computed: {
        gantt: function() {
            return this.$refs[ganttRef].instance;
        }
    },
    methods: {
        yourCustomMethod(){
            this.gantt.assignResourceToTask("resource_key","task_key");
            // ...
        }
    }
}
</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 {
    constructor(props) {
        super(props);

        this.ganttRef = React.createRef();

        this.yourCustomMethod = () => {
            this.gantt.assignResourceToTask("resource_key","task_key");
            // ...
        }
    }

    get gantt() {
        return this.ganttRef.current.instance;
    }

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

ASP.NET Core Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    @* ... *@
)

<script type="text/javascript">
    function getGanttInstance() {
        return $("#gantt").dxGantt("instance");
    }
    function yourCustomMethod() {
        var ganttInstance = getGanttInstance();
        ganttInstance.assignResourceToTask("resource_key","task_key");
        // ...
    }
</script>

ASP.NET MVC Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    @* ... *@
)

<script type="text/javascript">
    function getGanttInstance() {
        return $("#gantt").dxGantt("instance");
    }
    function yourCustomMethod() {
        var ganttInstance = getGanttInstance();
        ganttInstance.assignResourceToTask("resource_key","task_key");
        // ...
    }
</script>

beginUpdate()

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

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

defaultOptions(rule)

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

Parameters:

rule:

The component's default device properties.

Object structure:

Name	Type	Description
device	Device \| Array<Device> \| Function	Device parameters. When specifying a function, get information about the current device from the argument. Return true if the properties should be applied to the device.
options	Object	Options to be applied.

Name

Type

Description

device

Device

|

Array<Device>

|

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

options

Options to be applied.

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

jQuery

JavaScript

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

Angular

TypeScript

import Gantt from "devextreme/ui/gantt";
// ...
export class AppComponent {
    constructor () {
        Gantt.defaultOptions({
            device: { deviceType: "desktop" },
            options: {
                // Here go the Gantt properties
            }
        });
    }
}

Vue

<template>
    <div>
        <DxGantt id="gantt1" />
        <DxGantt id="gantt2" />
    </div>
</template>
<script>
import DxGantt from "devextreme-vue/gantt";
import Gantt from "devextreme/ui/gantt";

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

export default {
    components: {
        DxGantt
    }
}
</script>

React

import React, {useEffect} from "react";
import dxGantt from "devextreme/ui/gantt";
import Gantt from "devextreme-react/gantt";

export default function App() {
    useEffect(() => { 
        dxGantt.defaultOptions({
            device: { deviceType: "desktop" },
            options: {
                // Here go the Gantt properties
            }
        })
    });

    return (
        <div>
            <Gantt id="gantt1" />
            <Gantt id="gantt2" />
        </div>
    )
}

deleteDependency(key)

Deletes a dependency.

Parameters:

key:

The dependency key.

jQuery

index.js

var gantt = $("#ganttContainer").dxGantt("instance");
gantt.deleteDependency("dependency_key");

Angular

app.component.ts

app.component.html

app.module.ts

import { Component, ViewChild } from '@angular/core';
import { DxGanttComponent } from "devextreme-angular";

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

export class AppComponent {
    @ViewChild(DxGanttComponent, { static: false }) gantt: DxGanttComponent;
    // Prior to Angular 8
    // @ViewChild(DxGanttComponent) gantt: DxGanttComponent;

    yourCustomMethod() {
        this.gantt.instance.deleteDependency("dependency_key"); 
        // ...
    }
}

<dx-gantt ... >
</dx-gantt>

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 ...
        :ref="ganttRef">
    </DxGantt>
</template>

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

import DxGantt from 'devextreme-vue/gantt';

const ganttRef = 'gantt';

export default {
    components: {
        DxGantt
    },
    data() {
        return {
            ganttRef
        }
    },
    computed: {
        gantt: function() {
            return this.$refs[ganttRef].instance;
        }
    },
    methods: {
        yourCustomMethod(){
            this.gantt.deleteDependency("dependency_key");
            // ...
        }
    }
}
</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 {
    constructor(props) {
        super(props);

        this.ganttRef = React.createRef();

        this.yourCustomMethod = () => {
            this.gantt.deleteDependency("dependency_key");
            // ...
        }
    }

    get gantt() {
        return this.ganttRef.current.instance;
    }

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

ASP.NET Core Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    @* ... *@
)

<script type="text/javascript">
    function getGanttInstance() {
        return $("#gantt").dxGantt("instance");
    }
    function yourCustomMethod() {
        var ganttInstance = getGanttInstance();
        ganttInstance.deleteDependency("dependency_key");
        // ...
    }
</script>

ASP.NET MVC Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    @* ... *@
)

<script type="text/javascript">
    function getGanttInstance() {
        return $("#gantt").dxGantt("instance");
    }
    function yourCustomMethod() {
        var ganttInstance = getGanttInstance();
        ganttInstance.deleteDependency("dependency_key");
        // ...
    }
</script>

deleteResource(key)

Deletes a resource.

Parameters:

key:

The resource key.

jQuery

index.js

var gantt = $("#ganttContainer").dxGantt("instance");
gantt.deleteResource("resource_key");

Angular

app.component.ts

app.component.html

app.module.ts

import { Component, ViewChild } from '@angular/core';
import { DxGanttComponent } from "devextreme-angular";

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

export class AppComponent {
    @ViewChild(DxGanttComponent, { static: false }) gantt: DxGanttComponent;
    // Prior to Angular 8
    // @ViewChild(DxGanttComponent) gantt: DxGanttComponent;

    yourCustomMethod() {
        this.gantt.instance.deleteResource("resource_key");
        // ...
    }
}

<dx-gantt ... >
</dx-gantt>

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 ...
        :ref="ganttRef">
    </DxGantt>
</template>

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

import DxGantt from 'devextreme-vue/gantt';

const ganttRef = 'gantt';

export default {
    components: {
        DxGantt
    },
    data() {
        return {
            ganttRef
        }
    },
    computed: {
        gantt: function() {
            return this.$refs[ganttRef].instance;
        }
    },
    methods: {
        yourCustomMethod(){
            this.gantt.deleteResource("resource_key");
            // ...
        }
    }
}
</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 {
    constructor(props) {
        super(props);

        this.ganttRef = React.createRef();

        this.yourCustomMethod = () => {
            this.gantt.deleteResource("resource_key");
            // ...
        }
    }

    get gantt() {
        return this.ganttRef.current.instance;
    }

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

ASP.NET Core Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    @* ... *@
)

<script type="text/javascript">
    function getGanttInstance() {
        return $("#gantt").dxGantt("instance");
    }
    function yourCustomMethod() {
        var ganttInstance = getGanttInstance();
        ganttInstance.deleteResource("resource_key");
        // ...
    }
</script>

ASP.NET MVC Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    @* ... *@
)

<script type="text/javascript">
    function getGanttInstance() {
        return $("#gantt").dxGantt("instance");
    }
    function yourCustomMethod() {
        var ganttInstance = getGanttInstance();
        ganttInstance.deleteResource("resource_key");
        // ...
    }
</script>

deleteTask(key)

Deletes a task.

Parameters:

key:

The task key.

jQuery

index.js

var gantt = $("#ganttContainer").dxGantt("instance");
gantt.deleteTask("task_key");

Angular

app.component.ts

app.component.html

app.module.ts

import { Component, ViewChild } from '@angular/core';
import { DxGanttComponent } from "devextreme-angular";

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

export class AppComponent {
    @ViewChild(DxGanttComponent, { static: false }) gantt: DxGanttComponent;
    // Prior to Angular 8
    // @ViewChild(DxGanttComponent) gantt: DxGanttComponent;

    yourCustomMethod() {
        this.gantt.instance.deleteTask("task_key");
        // ...
    }
}

<dx-gantt ... >
</dx-gantt>

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 ...
        :ref="ganttRef">
    </DxGantt>
</template>

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

import DxGantt from 'devextreme-vue/gantt';

const ganttRef = 'gantt';

export default {
    components: {
        DxGantt
    },
    data() {
        return {
            ganttRef
        }
    },
    computed: {
        gantt: function() {
            return this.$refs[ganttRef].instance;
        }
    },
    methods: {
        yourCustomMethod(){
            this.gantt.deleteTask("task_key");
            // ...
        }
    }
}
</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 {
    constructor(props) {
        super(props);

        this.ganttRef = React.createRef();

        this.yourCustomMethod = () => {
            this.gantt.deleteTask("task_key");
            // ...
        }
    }

    get gantt() {
        return this.ganttRef.current.instance;
    }

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

ASP.NET Core Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    @* ... *@
)

<script type="text/javascript">
    function getGanttInstance() {
        return $("#gantt").dxGantt("instance");
    }
    function yourCustomMethod() {
        var ganttInstance = getGanttInstance();
        ganttInstance.deleteTask("task_key");
        // ...
    }
</script>

ASP.NET MVC Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    @* ... *@
)

<script type="text/javascript">
    function getGanttInstance() {
        return $("#gantt").dxGantt("instance");
    }
    function yourCustomMethod() {
        var ganttInstance = getGanttInstance();
        ganttInstance.deleteTask("task_key");
        // ...
    }
</script>

dispose()

Disposes of all the resources allocated to the Gantt instance.

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

JavaScript

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

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

Angular

app.component.html

<dx-gantt ...
    *ngIf="condition">
</dx-gantt>

Vue

App.vue

<template>
    <DxGantt ...
        v-if="condition">
    </DxGantt>
</template>

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

export default {
    components: {
        DxGantt
    }
}
</script>

React

App.js

import React from 'react';

import Gantt from 'devextreme-react/gantt';

function DxGantt(props) {
    if (!props.shouldRender) {
        return null;
    }

    return (
        <Gantt ... >    
        </Gantt>
    );
}

class App extends React.Component {
    render() {
        return (
            <DxGantt shouldRender="condition" />
        );
    }
}
export default App;

element()

Gets the root UI component element.

Return Value:

HTMLElement | jQuery

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

endUpdate()

Refreshes the UI component after a call of the beginUpdate() method.

Main article: beginUpdate()

exportToPdf(options) CTP

Exports Gantt chart data to a PDF document.

Parameters:

options:

PDF export options.

Return Value:

Promise<any> (jQuery or native)

A Promise that is resolved after the Gantt chart is exported. It is a native Promise or a jQuery.Promise when you use jQuery.

View Demo

The exportToPdf method allows you to save information about the Gantt chart's layout, appearance, and tasks. This method supports the following options:

format {string | width?: number, height?: number } - Specifies the document size.
landscape {boolean} - Specifies whether to use horizontal orientation for the document.
fileName {string} - Specifies the file name.
exportMode {"all", "treeList", "chart"} - Specifies which part of the component to export (chart area, tree list area, or the entire component).
dateRange: {"all" | "visible" | startDate? : Date, endDate? : Date, startIndex? : number, endIndex? : number } - Specifies the date range for which to export tasks.
margins { left?: number, top?: number, right?: number, bottom?: number } - Specifies the outer indents of the exported area.

Note that you should link the jspdf.js and jspdf-autotable.js libraries to your project.

Use the following settings to export the Gantt chart to a PDF document:

JavaScript

var gantt = $("#ganttContainer").dxGantt("instance");
gantt.exportToPdf({
    format: "A4",
    landscape: true,
    exportMode: "chart",
    dateRange: "visible"
});

Use the following settings to process the PDF document when the export is complete:

JavaScript

var gantt = $("#ganttContainer").dxGantt("instance");
gantt.exportToPdf({
    format: "A4",
    landscape: true,
    exportMode: "chart",
    dateRange: "visible"
}).then(function(doc) { 
    doc.addPage(); 
    // your code
    doc.save('customDoc.pdf'); 
});

Use the following settings to print the exported PDF document:

JavaScript

var gantt = $("#ganttContainer").dxGantt("instance");
gantt.exportToPdf({
    format: "A4",
    landscape: true,
    exportMode: "chart",
    dateRange: "visible"
}).then(function(doc) { 
    doc.autoPrint(); 
    window.open(doc.output('your_url'), '_blank');
});

jQuery

index.js

var gantt = $("#ganttContainer").dxGantt("instance");
gantt.exportToPdf({
    format: "A4",
    landscape: true,
    exportMode: "chart",
    dateRange: "visible"
});

Angular

app.component.ts

app.component.html

app.module.ts

import { Component, ViewChild } from '@angular/core';
import { DxGanttComponent } from "devextreme-angular";

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

export class AppComponent {
    @ViewChild(DxGanttComponent, { static: false }) gantt: DxGanttComponent;
    // Prior to Angular 8
    // @ViewChild(DxGanttComponent) gantt: DxGanttComponent;

    yourCustomMethod() {
        this.gantt.instance.exportToPdf({
            format: "A4",
            landscape: true,
            exportMode: "chart",
            dateRange: "visible"
        });
        // ...
    }
}

<dx-gantt ... >
</dx-gantt>

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 ...
        :ref="ganttRef">
    </DxGantt>
</template>

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

import DxGantt from 'devextreme-vue/gantt';

const ganttRef = 'gantt';

export default {
    components: {
        DxGantt
    },
    data() {
        return {
            ganttRef
        }
    },
    computed: {
        gantt: function() {
            return this.$refs[ganttRef].instance;
        }
    },
    methods: {
        yourCustomMethod(){
        this.gantt.exportToPdf({
            format: "A4",
            landscape: true,
            exportMode: "chart",
            dateRange: "visible"
        });
            // ...
        }
    }
}
</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 {
    constructor(props) {
        super(props);

        this.ganttRef = React.createRef();

        this.yourCustomMethod = () => {
            this.gantt.exportToPdf({
                format: "A4",
                landscape: true,
                exportMode: "chart",
                dateRange: "visible"
            });
            // ...
        }
    }

    get gantt() {
        return this.ganttRef.current.instance;
    }

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

ASP.NET Core Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    @* ... *@
)

<script type="text/javascript">
    function getGanttInstance() {
        return $("#gantt").dxGantt("instance");
    }
    function yourCustomMethod() {
        var ganttInstance = getGanttInstance();
        ganttInstance.exportToPdf({
            format: "A4",
            landscape: true,
            exportMode: "chart",
            dateRange: "visible"
        });
        // ...
    }
</script>

ASP.NET MVC Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    @* ... *@
)

<script type="text/javascript">
    function getGanttInstance() {
        return $("#gantt").dxGantt("instance");
    }
    function yourCustomMethod() {
        var ganttInstance = getGanttInstance();
        ganttInstance.exportToPdf({
            format: "A4",
            landscape: true,
            exportMode: "chart",
            dateRange: "visible"
        });
        // ...
    }
</script>

focus()

Sets focus on the UI component.

getDependencyData(key)

Gets the dependency data.

Parameters:

key:

The dependency key.

Return Value:

The dependency data.

jQuery

index.js

var gantt = $("#ganttContainer").dxGantt("instance");
gantt.getDependencyData("dependency_key");

Angular

app.component.ts

app.component.html

app.module.ts

import { Component, ViewChild } from '@angular/core';
import { DxGanttComponent } from "devextreme-angular";

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

export class AppComponent {
    @ViewChild(DxGanttComponent, { static: false }) gantt: DxGanttComponent;
    // Prior to Angular 8
    // @ViewChild(DxGanttComponent) gantt: DxGanttComponent;

    yourCustomMethod() {
        this.gantt.instance.getDependencyData("dependency_key");
        // ...
    }
}

<dx-gantt ... >
</dx-gantt>

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 ...
        :ref="ganttRef">
    </DxGantt>
</template>

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

import DxGantt from 'devextreme-vue/gantt';

const ganttRef = 'gantt';

export default {
    components: {
        DxGantt
    },
    data() {
        return {
            ganttRef
        }
    },
    computed: {
        gantt: function() {
            return this.$refs[ganttRef].instance;
        }
    },
    methods: {
        yourCustomMethod(){
            this.gantt.getDependencyData("dependency_key");
            // ...
        }
    }
}
</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 {
    constructor(props) {
        super(props);

        this.ganttRef = React.createRef();

        this.yourCustomMethod = () => {
            this.gantt.getDependencyData("dependency_key");
            // ...
        }
    }

    get gantt() {
        return this.ganttRef.current.instance;
    }

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

ASP.NET Core Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    @* ... *@
)

<script type="text/javascript">
    function getGanttInstance() {
        return $("#gantt").dxGantt("instance");
    }
    function yourCustomMethod() {
        var ganttInstance = getGanttInstance();
        ganttInstance.getDependencyData("dependency_key");
        // ...
    }
</script>

ASP.NET MVC Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    @* ... *@
)

<script type="text/javascript">
    function getGanttInstance() {
        return $("#gantt").dxGantt("instance");
    }
    function yourCustomMethod() {
        var ganttInstance = getGanttInstance();
        ganttInstance.getDependencyData("dependency_key");
        // ...
    }
</script>

getInstance(element)

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

Parameters:

element:

Element

|

jQuery

The UI component's container.

Return Value:

The UI component's instance.

getInstance is a static method that the UI component class supports. The following code demonstrates how to get the Gantt instance found in an element with the myGantt ID:

// Modular approach
import Gantt from "devextreme/ui/gantt";
...
let element = document.getElementById("myGantt");
let instance = Gantt.getInstance(element) as Gantt;

// Non-modular approach
let element = document.getElementById("myGantt");
let instance = DevExpress.ui.dxGantt.getInstance(element);

getResourceAssignmentData(key)

Gets the resource assignment data.

Parameters:

key:

The resource assignment key.

Return Value:

The resource assignment data.

jQuery

index.js

var gantt = $("#ganttContainer").dxGantt("instance");
gantt.getResourceAssignmentData("res_assignment_key");

Angular

app.component.ts

app.component.html

app.module.ts

import { Component, ViewChild } from '@angular/core';
import { DxGanttComponent } from "devextreme-angular";

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

export class AppComponent {
    @ViewChild(DxGanttComponent, { static: false }) gantt: DxGanttComponent;
    // Prior to Angular 8
    // @ViewChild(DxGanttComponent) gantt: DxGanttComponent;

    yourCustomMethod() {
        this.gantt.instance.getResourceAssignmentData("res_assignment_key");
        // ...
    }
}

<dx-gantt ... >
</dx-gantt>

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 ...
        :ref="ganttRef">
    </DxGantt>
</template>

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

import DxGantt from 'devextreme-vue/gantt';

const ganttRef = 'gantt';

export default {
    components: {
        DxGantt
    },
    data() {
        return {
            ganttRef
        }
    },
    computed: {
        gantt: function() {
            return this.$refs[ganttRef].instance;
        }
    },
    methods: {
        yourCustomMethod(){
            this.gantt.getResourceAssignmentData("res_assignment_key");
            // ...
        }
    }
}
</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 {
    constructor(props) {
        super(props);

        this.ganttRef = React.createRef();

        this.yourCustomMethod = () => {
            this.gantt.getResourceAssignmentData("res_assignment_key");
            // ...
        }
    }

    get gantt() {
        return this.ganttRef.current.instance;
    }

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

ASP.NET Core Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    @* ... *@
)

<script type="text/javascript">
    function getGanttInstance() {
        return $("#gantt").dxGantt("instance");
    }
    function yourCustomMethod() {
        var ganttInstance = getGanttInstance();
        ganttInstance.getResourceAssignmentData("res_assignment_key");
        // ...
    }
</script>

ASP.NET MVC Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    @* ... *@
)

<script type="text/javascript">
    function getGanttInstance() {
        return $("#gantt").dxGantt("instance");
    }
    function yourCustomMethod() {
        var ganttInstance = getGanttInstance();
        ganttInstance.getResourceAssignmentData("res_assignment_key");
        // ...
    }
</script>

getResourceData(key)

Gets the resource data.

Parameters:

key:

The resource key.

Return Value:

The resource data.

jQuery

index.js

var gantt = $("#ganttContainer").dxGantt("instance");
gantt.getResourceData("resource_key");

Angular

app.component.ts

app.component.html

app.module.ts

import { Component, ViewChild } from '@angular/core';
import { DxGanttComponent } from "devextreme-angular";

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

export class AppComponent {
    @ViewChild(DxGanttComponent, { static: false }) gantt: DxGanttComponent;
    // Prior to Angular 8
    // @ViewChild(DxGanttComponent) gantt: DxGanttComponent;

    yourCustomMethod() {
        this.gantt.instance.getResourceData("resource_key");
        // ...
    }
}

<dx-gantt ... >
</dx-gantt>

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 ...
        :ref="ganttRef">
    </DxGantt>
</template>

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

import DxGantt from 'devextreme-vue/gantt';

const ganttRef = 'gantt';

export default {
    components: {
        DxGantt
    },
    data() {
        return {
            ganttRef
        }
    },
    computed: {
        gantt: function() {
            return this.$refs[ganttRef].instance;
        }
    },
    methods: {
        yourCustomMethod(){
            this.gantt.getResourceData("resource_key");
            // ...
        }
    }
}
</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 {
    constructor(props) {
        super(props);

        this.ganttRef = React.createRef();

        this.yourCustomMethod = () => {
            this.gantt.getResourceData("resource_key");
            // ...
        }
    }

    get gantt() {
        return this.ganttRef.current.instance;
    }

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

ASP.NET Core Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    @* ... *@
)

<script type="text/javascript">
    function getGanttInstance() {
        return $("#gantt").dxGantt("instance");
    }
    function yourCustomMethod() {
        var ganttInstance = getGanttInstance();
        ganttInstance.getResourceData("resource_key");
        // ...
    }
</script>

ASP.NET MVC Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    @* ... *@
)

<script type="text/javascript">
    function getGanttInstance() {
        return $("#gantt").dxGantt("instance");
    }
    function yourCustomMethod() {
        var ganttInstance = getGanttInstance();
        ganttInstance.getResourceData("resource_key");
        // ...
    }
</script>

getTaskData(key)

Gets the task data.

Parameters:

key:

The task key.

Return Value:

The task data.

jQuery

index.js

var gantt = $("#ganttContainer").dxGantt("instance");
gantt.getTaskData("task_key");

Angular

app.component.ts

app.component.html

app.module.ts

import { Component, ViewChild } from '@angular/core';
import { DxGanttComponent } from "devextreme-angular";

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

export class AppComponent {
    @ViewChild(DxGanttComponent, { static: false }) gantt: DxGanttComponent;
    // Prior to Angular 8
    // @ViewChild(DxGanttComponent) gantt: DxGanttComponent;

    yourCustomMethod() {
        this.gantt.instance.getTaskData("task_key");
        // ...
    }
}

<dx-gantt ... >
</dx-gantt>

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 ...
        :ref="ganttRef">
    </DxGantt>
</template>

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

import DxGantt from 'devextreme-vue/gantt';

const ganttRef = 'gantt';

export default {
    components: {
        DxGantt
    },
    data() {
        return {
            ganttRef
        }
    },
    computed: {
        gantt: function() {
            return this.$refs[ganttRef].instance;
        }
    },
    methods: {
        yourCustomMethod(){
            this.gantt.getTaskData("task_key");
            // ...
        }
    }
}
</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 {
    constructor(props) {
        super(props);

        this.ganttRef = React.createRef();

        this.yourCustomMethod = () => {
            this.gantt.getTaskData("task_key");
            // ...
        }
    }

    get gantt() {
        return this.ganttRef.current.instance;
    }

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

ASP.NET Core Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    @* ... *@
)

<script type="text/javascript">
    function getGanttInstance() {
        return $("#gantt").dxGantt("instance");
    }
    function yourCustomMethod() {
        var ganttInstance = getGanttInstance();
        ganttInstance.getTaskData("task_key");
        // ...
    }
</script>

ASP.NET MVC Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    @* ... *@
)

<script type="text/javascript">
    function getGanttInstance() {
        return $("#gantt").dxGantt("instance");
    }
    function yourCustomMethod() {
        var ganttInstance = getGanttInstance();
        ganttInstance.getTaskData("task_key");
        // ...
    }
</script>

getTaskResources(key)

Gets resources assigned to a task.

Parameters:

key:

The task's key.

Return Value:

The resources.

jQuery

index.js

var gantt = $("#ganttContainer").dxGantt("instance");
//...
gantt.getTaskResources("task_key");

Angular

app.component.ts

app.component.html

app.module.ts

import { Component, ViewChild } from '@angular/core';
import { DxGanttComponent } from "devextreme-angular";

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

export class AppComponent {
    @ViewChild(DxGanttComponent, { static: false }) gantt: DxGanttComponent;
    // Prior to Angular 8
    // @ViewChild(DxGanttComponent) gantt: DxGanttComponent;

    yourCustomMethod() {
        this.gantt.instance.getTaskResources("task_key");
        // ...
    }
}

<dx-gantt ... >
</dx-gantt>

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 ...
        :ref="ganttRef">
    </DxGantt>
</template>

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

import DxGantt from 'devextreme-vue/gantt';

const ganttRef = 'gantt';

export default {
    components: {
        DxGantt
    },
    data() {
        return {
            ganttRef
        }
    },
    computed: {
        gantt: function() {
            return this.$refs[ganttRef].instance;
        }
    },
    methods: {
        yourCustomMethod(){
            this.gantt.getTaskResources("task_key");
            // ...
        }
    }
}
</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 {
    constructor(props) {
        super(props);

        this.ganttRef = React.createRef();

        this.yourCustomMethod = () => {
            this.gantt.getTaskResources("task_key");
            // ...
        }
    }

    get gantt() {
        return this.ganttRef.current.instance;
    }

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

ASP.NET Core Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    @* ... *@
)

<script type="text/javascript">
    function getGanttInstance() {
        return $("#gantt").dxGantt("instance");
    }
    function yourCustomMethod() {
        var ganttInstance = getGanttInstance();
        ganttInstance.getTaskResources("task_key");
        // ...
    }
</script>

ASP.NET MVC Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    @* ... *@
)

<script type="text/javascript">
    function getGanttInstance() {
        return $("#gantt").dxGantt("instance");
    }
    function yourCustomMethod() {
        var ganttInstance = getGanttInstance();
        ganttInstance.getTaskResources("task_key");
        // ...
    }
</script>

getVisibleDependencyKeys()

Gets the keys of the visible dependencies.

Return Value:

The keys.

jQuery

index.js

var gantt = $("#ganttContainer").dxGantt("instance");
//...
var keys = gantt.getVisibleDependencyKeys();

Angular

app.component.ts

app.component.html

app.module.ts

import { Component, ViewChild } from '@angular/core';
import { DxGanttComponent } from "devextreme-angular";

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

export class AppComponent {
    @ViewChild(DxGanttComponent, { static: false }) gantt: DxGanttComponent;
    // Prior to Angular 8
    // @ViewChild(DxGanttComponent) gantt: DxGanttComponent;

    yourCustomMethod() {
        this.gantt.instance.getVisibleDependencyKeys();
        // ...
    }
}

<dx-gantt ... >
</dx-gantt>

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 ...
        :ref="ganttRef">
    </DxGantt>
</template>

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

import DxGantt from 'devextreme-vue/gantt';

const ganttRef = 'gantt';

export default {
    components: {
        DxGantt
    },
    data() {
        return {
            ganttRef
        }
    },
    computed: {
        gantt: function() {
            return this.$refs[ganttRef].instance;
        }
    },
    methods: {
        yourCustomMethod(){
            this.gantt.getVisibleDependencyKeys();
            // ...
        }
    }
}
</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 {
    constructor(props) {
        super(props);

        this.ganttRef = React.createRef();

        this.yourCustomMethod = () => {
            this.gantt.getVisibleDependencyKeys();
            // ...
        }
    }

    get gantt() {
        return this.ganttRef.current.instance;
    }

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

ASP.NET Core Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    @* ... *@
)

<script type="text/javascript">
    function getGanttInstance() {
        return $("#gantt").dxGantt("instance");
    }
    function yourCustomMethod() {
        var ganttInstance = getGanttInstance();
        ganttInstance.getVisibleDependencyKeys();
        // ...
    }
</script>

ASP.NET MVC Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    @* ... *@
)

<script type="text/javascript">
    function getGanttInstance() {
        return $("#gantt").dxGantt("instance");
    }
    function yourCustomMethod() {
        var ganttInstance = getGanttInstance();
        ganttInstance.getVisibleDependencyKeys();
        // ...
    }
</script>

getVisibleResourceAssignmentKeys()

Gets the keys of the visible resource assignments.

Return Value:

The keys.

jQuery

index.js

var gantt = $("#ganttContainer").dxGantt("instance");
//...
var keys = gantt.getVisibleResourceAssignmentKeys();

Angular

app.component.ts

app.component.html

app.module.ts

import { Component, ViewChild } from '@angular/core';
import { DxGanttComponent } from "devextreme-angular";

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

export class AppComponent {
    @ViewChild(DxGanttComponent, { static: false }) gantt: DxGanttComponent;
    // Prior to Angular 8
    // @ViewChild(DxGanttComponent) gantt: DxGanttComponent;

    yourCustomMethod() {
        this.gantt.instance.getVisibleResourceAssignmentKeys();
        // ...
    }
}

<dx-gantt ... >
</dx-gantt>

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 ...
        :ref="ganttRef">
    </DxGantt>
</template>

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

import DxGantt from 'devextreme-vue/gantt';

const ganttRef = 'gantt';

export default {
    components: {
        DxGantt
    },
    data() {
        return {
            ganttRef
        }
    },
    computed: {
        gantt: function() {
            return this.$refs[ganttRef].instance;
        }
    },
    methods: {
        yourCustomMethod(){
            this.gantt.getVisibleResourceAssignmentKeys();
            // ...
        }
    }
}
</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 {
    constructor(props) {
        super(props);

        this.ganttRef = React.createRef();

        this.yourCustomMethod = () => {
            this.gantt.getVisibleResourceAssignmentKeys();
            // ...
        }
    }

    get gantt() {
        return this.ganttRef.current.instance;
    }

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

ASP.NET Core Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    @* ... *@
)

<script type="text/javascript">
    function getGanttInstance() {
        return $("#gantt").dxGantt("instance");
    }
    function yourCustomMethod() {
        var ganttInstance = getGanttInstance();
        ganttInstance.getVisibleResourceAssignmentKeys();
        // ...
    }
</script>

ASP.NET MVC Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    @* ... *@
)

<script type="text/javascript">
    function getGanttInstance() {
        return $("#gantt").dxGantt("instance");
    }
    function yourCustomMethod() {
        var ganttInstance = getGanttInstance();
        ganttInstance.getVisibleResourceAssignmentKeys();
        // ...
    }
</script>

getVisibleResourceKeys()

Gets the keys of the visible resources.

Return Value:

The keys.

jQuery

index.js

var gantt = $("#ganttContainer").dxGantt("instance");
//...
var keys = gantt.getVisibleResourceKeys();

Angular

app.component.ts

app.component.html

app.module.ts

import { Component, ViewChild } from '@angular/core';
import { DxGanttComponent } from "devextreme-angular";

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

export class AppComponent {
    @ViewChild(DxGanttComponent, { static: false }) gantt: DxGanttComponent;
    // Prior to Angular 8
    // @ViewChild(DxGanttComponent) gantt: DxGanttComponent;

    yourCustomMethod() {
        this.gantt.instance.getVisibleResourceKeys();
        // ...
    }
}

<dx-gantt ... >
</dx-gantt>

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 ...
        :ref="ganttRef">
    </DxGantt>
</template>

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

import DxGantt from 'devextreme-vue/gantt';

const ganttRef = 'gantt';

export default {
    components: {
        DxGantt
    },
    data() {
        return {
            ganttRef
        }
    },
    computed: {
        gantt: function() {
            return this.$refs[ganttRef].instance;
        }
    },
    methods: {
        yourCustomMethod(){
            this.gantt.getVisibleResourceKeys();
            // ...
        }
    }
}
</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 {
    constructor(props) {
        super(props);

        this.ganttRef = React.createRef();

        this.yourCustomMethod = () => {
            this.gantt.getVisibleResourceKeys();
            // ...
        }
    }

    get gantt() {
        return this.ganttRef.current.instance;
    }

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

ASP.NET Core Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    @* ... *@
)

<script type="text/javascript">
    function getGanttInstance() {
        return $("#gantt").dxGantt("instance");
    }
    function yourCustomMethod() {
        var ganttInstance = getGanttInstance();
        ganttInstance.getVisibleResourceKeys();
        // ...
    }
</script>

ASP.NET MVC Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    @* ... *@
)

<script type="text/javascript">
    function getGanttInstance() {
        return $("#gantt").dxGantt("instance");
    }
    function yourCustomMethod() {
        var ganttInstance = getGanttInstance();
        ganttInstance.getVisibleResourceKeys();
        // ...
    }
</script>

getVisibleTaskKeys()

Gets the keys of the visible tasks.

Return Value:

The keys.

jQuery

index.js

var gantt = $("#ganttContainer").dxGantt("instance");
//...
var keys = gantt.getVisibleTaskKeys();

Angular

app.component.ts

app.component.html

app.module.ts

import { Component, ViewChild } from '@angular/core';
import { DxGanttComponent } from "devextreme-angular";

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

export class AppComponent {
    @ViewChild(DxGanttComponent, { static: false }) gantt: DxGanttComponent;
    // Prior to Angular 8
    // @ViewChild(DxGanttComponent) gantt: DxGanttComponent;

    yourCustomMethod() {
        this.gantt.instance.getVisibleTaskKeys();
        // ...
    }
}

<dx-gantt ... >
</dx-gantt>

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 ...
        :ref="ganttRef">
    </DxGantt>
</template>

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

import DxGantt from 'devextreme-vue/gantt';

const ganttRef = 'gantt';

export default {
    components: {
        DxGantt
    },
    data() {
        return {
            ganttRef
        }
    },
    computed: {
        gantt: function() {
            return this.$refs[ganttRef].instance;
        }
    },
    methods: {
        yourCustomMethod(){
            this.gantt.getVisibleTaskKeys();
            // ...
        }
    }
}
</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 {
    constructor(props) {
        super(props);

        this.ganttRef = React.createRef();

        this.yourCustomMethod = () => {
            this.gantt.getVisibleTaskKeys();
            // ...
        }
    }

    get gantt() {
        return this.ganttRef.current.instance;
    }

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

ASP.NET Core Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    @* ... *@
)

<script type="text/javascript">
    function getGanttInstance() {
        return $("#gantt").dxGantt("instance");
    }
    function yourCustomMethod() {
        var ganttInstance = getGanttInstance();
        ganttInstance.getVisibleTaskKeys();
        // ...
    }
</script>

ASP.NET MVC Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    @* ... *@
)

<script type="text/javascript">
    function getGanttInstance() {
        return $("#gantt").dxGantt("instance");
    }
    function yourCustomMethod() {
        var ganttInstance = getGanttInstance();
        ganttInstance.getVisibleTaskKeys();
        // ...
    }
</script>

insertDependency(data)

Inserts a new dependency.

Parameters:

data:

The dependency data.

jQuery

index.js

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

Angular

app.component.ts

app.component.html

app.module.ts

import { Component, ViewChild } from '@angular/core';
import { DxGanttComponent } from "devextreme-angular";

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

export class AppComponent {
    @ViewChild(DxGanttComponent, { static: false }) gantt: DxGanttComponent;
    // Prior to Angular 8
    // @ViewChild(DxGanttComponent) gantt: DxGanttComponent;

    yourCustomMethod() {
        this.gantt.instance.insertDependency({ predecessorId: 1, successorId: 3, type: 3 });
        // ...
    }
}

<dx-gantt ... >
</dx-gantt>

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 ...
        :ref="ganttRef">
    </DxGantt>
</template>

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

import DxGantt from 'devextreme-vue/gantt';

const ganttRef = 'gantt';

export default {
    components: {
        DxGantt
    },
    data() {
        return {
            ganttRef
        }
    },
    computed: {
        gantt: function() {
            return this.$refs[ganttRef].instance;
        }
    },
    methods: {
        yourCustomMethod(){
            this.gantt.insertDependency({ predecessorId: 1, successorId: 3, type: 3 });
            // ...
        }
    }
}
</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 {
    constructor(props) {
        super(props);

        this.ganttRef = React.createRef();

        this.yourCustomMethod = () => {
            this.gantt.insertDependency({ predecessorId: 1, successorId: 3, type: 3 });
            // ...
        }
    }

    get gantt() {
        return this.ganttRef.current.instance;
    }

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

ASP.NET Core Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    @* ... *@
)

<script type="text/javascript">
    function getGanttInstance() {
        return $("#gantt").dxGantt("instance");
    }
    function yourCustomMethod() {
        var ganttInstance = getGanttInstance();
        ganttInstance.insertDependency({ predecessorId: 1, successorId: 3, type: 3 });
        // ...
    }
</script>

ASP.NET MVC Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    @* ... *@
)

<script type="text/javascript">
    function getGanttInstance() {
        return $("#gantt").dxGantt("instance");
    }
    function yourCustomMethod() {
        var ganttInstance = getGanttInstance();
        ganttInstance.insertDependency({ predecessorId: 1, successorId: 3, type: 3 });
        // ...
    }
</script>

insertResource(data, taskKeys)

Inserts a new resource.

Parameters:

data:

The resource data.

taskKeys?:

An array of task keys.

jQuery

index.js

var gantt = $("#ganttContainer").dxGantt("instance");
// Inserts a new resource 
gantt.insertResource({ text: "New Resource" });

// Inserts a new resource and assigns it to an individual task
gantt.insertResource({ text: "New Resource" }, [6]);

// Inserts a new resource and assigns it to multiple tasks
gantt.insertResource({ text: "New Resource" }, [6,8]);

Angular

app.component.ts

app.component.html

app.module.ts

import { Component, ViewChild } from '@angular/core';
import { DxGanttComponent } from "devextreme-angular";

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

export class AppComponent {
    @ViewChild(DxGanttComponent, { static: false }) gantt: DxGanttComponent;
    // Prior to Angular 8
    // @ViewChild(DxGanttComponent) gantt: DxGanttComponent;

    yourCustomMethod() {
        // Inserts a new resource 
        this.gantt.instance.insertResource({ text: "New Resource" });

        // Inserts a new resource and assigns it to an individual task
        this.gantt.instance.insertResource({ text: "New Resource" }, [6]);

        // Inserts a new resource and assigns it to multiple tasks
        this.gantt.instance.insertResource({ text: "New Resource" }, [6,8]);
    }
}

<dx-gantt ... >
</dx-gantt>

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 ...
        :ref="ganttRef">
    </DxGantt>
</template>

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

import DxGantt from 'devextreme-vue/gantt';

const ganttRef = 'gantt';

export default {
    components: {
        DxGantt
    },
    data() {
        return {
            ganttRef
        }
    },
    computed: {
        gantt: function() {
            return this.$refs[ganttRef].instance;
        }
    },
    methods: {
        yourCustomMethod(){
            // Inserts a new resource 
            this.gantt.insertResource({ text: "New Resource" });

            // Inserts a new resource and assigns it to an individual task
            this.gantt.insertResource({ text: "New Resource" }, [6]);

            // Inserts a new resource and assigns it to multiple tasks
            this.gantt.insertResource({ text: "New Resource" }, [6,8]);
        }
    }
}
</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 {
    constructor(props) {
        super(props);

        this.ganttRef = React.createRef();

        this.yourCustomMethod = () => {
            // Inserts a new resource 
            this.gantt.insertResource({ text: "New Resource" });

            // Inserts a new resource and assigns it to an individual task
            this.gantt.insertResource({ text: "New Resource" }, [6]);

            // Inserts a new resource and assigns it to multiple tasks
            this.gantt.insertResource({ text: "New Resource" }, [6,8]);
        }
    }

    get gantt() {
        return this.ganttRef.current.instance;
    }

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

ASP.NET Core Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    @* ... *@
)

<script type="text/javascript">
    function getGanttInstance() {
        return $("#gantt").dxGantt("instance");
    }
    function yourCustomMethod() {
        var ganttInstance = getGanttInstance();
        // Inserts a new resource 
        ganttInstance.insertResource({ text: "New Resource" });

        // Inserts a new resource and assigns it to an individual task
        ganttInstance.insertResource({ text: "New Resource" }, [6]);

        // Inserts a new resource and assigns it to multiple tasks
        ganttInstance.insertResource({ text: "New Resource" }, [6,8]);
    }
</script>

ASP.NET MVC Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    @* ... *@
)

<script type="text/javascript">
    function getGanttInstance() {
        return $("#gantt").dxGantt("instance");
    }
    function yourCustomMethod() {
        var ganttInstance = getGanttInstance();
        // Inserts a new resource 
        ganttInstance.insertResource({ text: "New Resource" });

        // Inserts a new resource and assigns it to an individual task
        ganttInstance.insertResource({ text: "New Resource" }, [6]);

        // Inserts a new resource and assigns it to multiple tasks
        ganttInstance.insertResource({ text: "New Resource" }, [6,8]);
    }
</script>

insertTask(data)

Inserts a new task.

Parameters:

data:

The task data.

The insertTask method does not update the following data fields in the data source:

Key value fields.
Fields that are not assigned to the Gantt's columns.

jQuery

index.js

var gantt = $("#ganttContainer").dxGantt("instance");
// Inserts a new task with the specified subject at the end of the other tasks.
gantt.insertTask({ title: "New Task" });

// Inserts a child task with the specified subject as a child of the task with ID = 2
gantt.insertTask({ title: "New Task" , parentId: 2});

Angular

app.component.ts

app.component.html

app.module.ts

import { Component, ViewChild } from '@angular/core';
import { DxGanttComponent } from "devextreme-angular";

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

export class AppComponent {
    @ViewChild(DxGanttComponent, { static: false }) gantt: DxGanttComponent;
    // Prior to Angular 8
    // @ViewChild(DxGanttComponent) gantt: DxGanttComponent;

    yourCustomMethod() {
        // Inserts a new task with the specified subject at the end of the other tasks.
        this.gantt.instance.insertTask({ title: "New Task" });

        // Inserts a child task with the specified subject as a child of the task with ID = 2
        this.gantt.instance.insertTask({ title: "New Task" , parentId: 2});
    }
}

<dx-gantt ... >
</dx-gantt>

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 ...
        :ref="ganttRef">
    </DxGantt>
</template>

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

import DxGantt from 'devextreme-vue/gantt';

const ganttRef = 'gantt';

export default {
    components: {
        DxGantt
    },
    data() {
        return {
            ganttRef
        }
    },
    computed: {
        gantt: function() {
            return this.$refs[ganttRef].instance;
        }
    },
    methods: {
        yourCustomMethod(){
            // Inserts a new task with the specified subject at the end of the other tasks.
            this.gantt.insertTask({ title: "New Task" });

            // Inserts a child task with the specified subject as a child of the task with ID = 2
            this.gantt.insertTask({ title: "New Task" , parentId: 2});
        }
    }
}
</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 {
    constructor(props) {
        super(props);

        this.ganttRef = React.createRef();

        this.yourCustomMethod = () => {
            // Inserts a new task with the specified subject at the end of the other tasks.
            this.gantt.insertTask({ title: "New Task" });

            // Inserts a child task with the specified subject as a child of the task with ID = 2
            this.gantt.insertTask({ title: "New Task" , parentId: 2});
        }
    }

    get gantt() {
        return this.ganttRef.current.instance;
    }

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

ASP.NET Core Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    @* ... *@
)

<script type="text/javascript">
    function getGanttInstance() {
        return $("#gantt").dxGantt("instance");
    }
    function yourCustomMethod() {
        var ganttInstance = getGanttInstance();
        // Inserts a new task with the specified subject at the end of the other tasks.
        ganttInstance.insertTask({ title: "New Task" });

        // Inserts a child task with the specified subject as a child of the task with ID = 2
        ganttInstance.insertTask({ title: "New Task" , parentId: 2});
    }
</script>

ASP.NET MVC Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    @* ... *@
)

<script type="text/javascript">
    function getGanttInstance() {
        return $("#gantt").dxGantt("instance");
    }
    function yourCustomMethod() {
        var ganttInstance = getGanttInstance();
        // Inserts a new task with the specified subject at the end of the other tasks.
        ganttInstance.insertTask({ title: "New Task" });

        // Inserts a child task with the specified subject as a child of the task with ID = 2
        ganttInstance.insertTask({ title: "New Task" , parentId: 2});
    }
</script>

instance()

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

Return Value:

This UI component's instance.

off(eventName)

Detaches all event handlers from a single event.

Parameters:

eventName:

The event's name.

Return Value:

The object for which this method is called.

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

Parameters:

eventName:

The event's name.

eventHandler:

The event's handler.

Return Value:

The object for which this method is called.

on(eventName, eventHandler)

Subscribes to an event.

Parameters:

eventName:

The event's name.

eventHandler:

The event's handler.

Return Value:

The object for which this method is called.

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

on(events)

Subscribes to events.

Parameters:

events:

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

Return Value:

The object for which this method is called.

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

option()

Gets all UI component properties.

Return Value:

The UI component's properties.

option(optionName)

Gets the value of a single property.

Parameters:

optionName:

The property's name or full path.

Return Value: any

This property's value.

option(optionName, optionValue)

Updates the value of a single property.

Parameters:

optionName:

The property's name or full path.

optionValue: any

This property's new value.

option(options)

Updates the values of several properties.

Parameters:

options:

Options with their new values.

registerKeyHandler(key, handler)

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

Parameters:

key:

A key.

handler:

A handler. Accepts the keydown event as the argument. It is a EventObject or a jQuery.Event when you use jQuery.

The key argument accepts one of the following values:

"backspace"
"tab"
"enter"
"escape"
"pageUp"
"pageDown"
"end"
"home"
"leftArrow"
"upArrow"
"rightArrow"
"downArrow"
"del"
"space"
"F"
"A"
"asterisk"
"minus"

A custom handler for a key cancels the default handler for this key.

repaint()

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

resetOption(optionName)

Resets a property to its default value.

Parameters:

optionName:

A property's name.

scrollToDate(date)

Scrolls the Gantt chart to the specified date.

Parameters:

date:

Date

|

Number

|

The date.

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

Date

var gantt = $("#ganttContainer").dxGantt("instance"); gantt.scrollToDate(new Date("December 17, 2020"));
Number - Specifies a date as a timestamp (total milliseconds since 1970/01/01).

var gantt = $("#ganttContainer").dxGantt("instance"); gantt.scrollToDate(1876800000000);
String - Specifies a date as a string value.

var gantt = $("#ganttContainer").dxGantt("instance"); gantt.scrollToDate("2020/01/01");

Note that the scrollToDate method scrolls to a date inside the current scroll area. You can zoom the chart to resize the viewport.

jQuery

index.js

var gantt = $("#ganttContainer").dxGantt("instance");
gantt.scrollToDate(new Date("December 17, 2020"));

Angular

app.component.ts

app.component.html

app.module.ts

import { Component, ViewChild } from '@angular/core';
import { DxGanttComponent } from "devextreme-angular";

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

export class AppComponent {
    @ViewChild(DxGanttComponent, { static: false }) gantt: DxGanttComponent;
    // Prior to Angular 8
    // @ViewChild(DxGanttComponent) gantt: DxGanttComponent;

    yourCustomMethod() {
        this.gantt.instance.scrollToDate(new Date("December 17, 2020")); 
        // ...
    }
}

<dx-gantt ... >
</dx-gantt>

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 ...
        :ref="ganttRef">
    </DxGantt>
</template>

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

import DxGantt from 'devextreme-vue/gantt';

const ganttRef = 'gantt';

export default {
    components: {
        DxGantt
    },
    data() {
        return {
            ganttRef
        }
    },
    computed: {
        gantt: function() {
            return this.$refs[ganttRef].instance;
        }
    },
    methods: {
        yourCustomMethod(){
            this.gantt.scrollToDate(new Date("December 17, 2020"));
            // ...
        }
    }
}
</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 {
    constructor(props) {
        super(props);

        this.ganttRef = React.createRef();

        this.yourCustomMethod = () => {
            this.gantt.scrollToDate(new Date("December 17, 2020"));
            // ...
        }
    }

    get gantt() {
        return this.ganttRef.current.instance;
    }

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

ASP.NET Core Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    @* ... *@
)

<script type="text/javascript">
    function getGanttInstance() {
        return $("#gantt").dxGantt("instance");
    }
    function yourCustomMethod() {
        var ganttInstance = getGanttInstance();
        ganttInstance.scrollToDate(new Date("December 17, 2020"));
        // ...
    }
</script>

showResourceManagerDialog()

Invokes the Resource Manager dialog.

DevExtreme Gantt - Invoke Resource Manager

jQuery

index.js

var gantt = $("#ganttContainer").dxGantt("instance");
gantt.showResourceManagerDialog();

Angular

app.component.ts

app.component.html

app.module.ts

import { Component, ViewChild } from '@angular/core';
import { DxGanttComponent } from 'devextreme-angular';

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

export class AppComponent implements OnAfterViewInit {

    @ViewChild(DxGanttComponent) gantt: DxGanttComponent;

    showDialog() {
        this.gantt.instance.showResourceManagerDialog();
    }

    ngAfterViewInit () {
        this.showDialog();
    }
}

<dx-gantt ...>
</dx-gantt>

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 ...>
    </DxGantt>
</template>

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

import DxGantt from 'devextreme-vue/gantt';

export default {
    components: {
        DxGantt
    },
    methods: {
        showDialog() {
            this.gantt.showResourceManagerDialog();
        }
    }
}
</script>

React

App.js

import React from 'react';

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

const App = () => {
    const showDialog = () => {
        myGantt.current.instance.showResourceManagerDialog();
    }

    return (
        <Gantt ref={myGantt} />
    );
}

export default App;

ASP.NET Core Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    // ...
)
<script>
    function showDialog() {
        gantt.showResourceManagerDialog();
    }
</script>

unassignResourceFromTask(resourceKey, taskKey)

Removes a resource from the task.

Parameters:

resourceKey:

The resource key.

taskKey:

The task key.

jQuery

index.js

var gantt = $("#ganttContainer").dxGantt("instance");
gantt.unassignResourceFromTask(3, 10);

Angular

app.component.ts

app.component.html

app.module.ts

import { Component, ViewChild } from '@angular/core';
import { DxGanttComponent } from "devextreme-angular";

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

export class AppComponent {
    @ViewChild(DxGanttComponent, { static: false }) gantt: DxGanttComponent;
    // Prior to Angular 8
    // @ViewChild(DxGanttComponent) gantt: DxGanttComponent;

    yourCustomMethod() {
        this.gantt.instance.unassignResourceFromTask(3, 10);
        // ...
    }
}

<dx-gantt ... >
</dx-gantt>

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 ...
        :ref="ganttRef">
    </DxGantt>
</template>

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

import DxGantt from 'devextreme-vue/gantt';

const ganttRef = 'gantt';

export default {
    components: {
        DxGantt
    },
    data() {
        return {
            ganttRef
        }
    },
    computed: {
        gantt: function() {
            return this.$refs[ganttRef].instance;
        }
    },
    methods: {
        yourCustomMethod(){
            this.gantt.unassignResourceFromTask(3, 10);
            // ...
        }
    }
}
</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 {
    constructor(props) {
        super(props);

        this.ganttRef = React.createRef();

        this.yourCustomMethod = () => {
            this.gantt.unassignResourceFromTask(3, 10);
            // ...
        }
    }

    get gantt() {
        return this.ganttRef.current.instance;
    }

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

ASP.NET Core Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    @* ... *@
)

<script type="text/javascript">
    function getGanttInstance() {
        return $("#gantt").dxGantt("instance");
    }
    function yourCustomMethod() {
        var ganttInstance = getGanttInstance();
        ganttInstance.unassignResourceFromTask(3, 10);
        // ...
    }
</script>

ASP.NET MVC Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .ID("gantt")
    @* ... *@
)

<script type="text/javascript">
    function getGanttInstance() {
        return $("#gantt").dxGantt("instance");
    }
    function yourCustomMethod() {
        var ganttInstance = getGanttInstance();
        ganttInstance.unassignResourceFromTask(3, 10);
        // ...
    }
</script>

updateDimensions()

Updates the dimensions of the UI component contents.

updateTask(key, data)

Updates the task data.

Parameters:

key:

The task key.

data: