JavaScript/jQuery Gantt Options

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

accessKey

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

Type:

String

| undefined
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 the UI component changes its visual state as a result of user interaction.

Type:

Boolean

Default Value: false

The UI component switches to the active state when users press down the primary mouse button. When this property is set to true, the CSS rules for the active state apply. You can change these rules to customize the component.

Use this property when you display the component 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

JavaScript
  • $(function() {
  • $("#gantt").dxGantt({
  • 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 dxGanttColumn 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 column templates.

View Demo

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

contextMenu

Configures the context menu settings.

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
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
  • },
  • // ...
  • ];

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

index.js
  • $(function() {
  • $("#gantt").dxGantt({
  • editing: {
  • enabled: true,
  • allowDependencyAdding: false,
  • allowDependencyDeleting: false,
  • allowResourceAdding: false,
  • allowResourceDeleting: false,
  • allowTaskAdding: false,
  • allowTaskDeleting: false,
  • allowTaskResourceUpdating: false,
  • allowTaskUpdating: false
  • }
  • });
  • });
See Also

elementAttr

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

Type:

Object

Default Value: {}

  • $(function(){
  • $("#ganttContainer").dxGantt({
  • // ...
  • elementAttr: {
  • id: "elementId",
  • class: "class-name"
  • }
  • });
  • });

endDateRange

Specifies the end date of the date interval in the Gantt chart.

Type:

Date

Default Value: null

View Demo

JavaScript
  • $(function() {
  • $("#gantt").dxGantt({
  • startDateRange: new Date(2018, 01, 1),
  • endDateRange: new Date(2020, 01, 1)
  • // ...
  • });
  • });
See Also

filterRow

Configures filter row settings.

View Demo

Users can enter a value into the filter row to filter Gantt data. Set the filterRow.visible property to true to display the filter row.

DevExtreme Gantt - Filter Row

Each cell in the filter row contains a magnifier icon. Click a column's magnifier icon to select a filter operation available for the column. Use the selectedFilterOperation property to specify the default filter operation for a column's filter row.

DevExtreme Gantt - Filter Row

To hide a filter row cell for an individual column, set the column’s allowFiltering property to false.

firstDayOfWeek

Specifies the first day of a week.

Type:

FirstDayOfWeek

| undefined
Default Value: undefined

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.

View Demo

JavaScript
  • $(function() {
  • $("#gantt").dxGantt({
  • firstDayOfWeek: 1,
  • // ...
  • });
  • });

focusStateEnabled

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

Type:

Boolean

Default Value: false

headerFilter

Configures the header filter settings.

View Demo

The header filter allows users to filter values in an individual column. The header filter is a popup window that contains all unique values of a column. A click on the filter icon invokes the header filter.

DevExtreme Gantt - Header Filter

Set the headerFilter.visible property to true to display filter icons for all columns. To hide the filter icon for an individual column, set the column’s allowHeaderFiltering property to false.

index.js
  • $(function() {
  • $("#gantt").dxGantt({
  • headerFilter: {
  • visible: true,
  • width: 280,
  • height: 350,
  • searchTimeout: 800
  • },
  • // ...
  • });
  • });
See Also

height

Specifies the UI component's height.

Type:

Number

|

String

|

Function

| undefined
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", "20vh", "80%", "inherit".

  • Function (deprecated since v21.2)
    Refer to the W0017 warning description for information on how you can migrate to viewport units.

hint

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

Type:

String

| undefined
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 is rendered and each time the component is repainted.

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

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

component

Gantt

The UI component's instance.

Default Value: null

onContextMenuPreparing

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

Type:

Function

Function parameters:

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

index.js
  • $(function() {
  • $("#gantt").dxGantt({
  • // ...
  • onContextMenuPreparing: function (e) {
  • // your code
  • e.cancel = true;
  • }
  • });
  • });

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:

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

index.js
  • $(function() {
  • $("#gantt").dxGantt({
  • // ...
  • onCustomCommand: function (e) {
  • // your code
  • }
  • });
  • });
See Also

onDependencyDeleted

A function that is executed when a dependency is deleted.

Type:

Function

Function parameters:

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.

values any

The values of the deleted dependency.

Default Value: null

DevExtreme Gantt - Dependency

JavaScript
  • $(function() {
  • $("#gantt").dxGantt({
  • // ...
  • onDependencyDeleted: function (e) {
  • if (e.key != 1)
  • // your code
  • }
  • })
  • })
See Also

onDependencyDeleting

A function that is executed before a dependency is deleted.

Type:

Function

Function parameters:

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.

values any

The values of the deleted dependency.

Default Value: null

DevExtreme Gantt - Dependency

index.js
  • $(function() {
  • $("#gantt").dxGantt({
  • // ...
  • onDependencyDeleting: function (e) {
  • if (e.key != 1) {
  • // your code
  • e.cancel = true;
  • }
  • }
  • });
  • });
See Also

onDependencyInserted

A function that is executed when a dependency is inserted.

Type:

Function

Function parameters:

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.

values any

The values of the inserted dependency.

Default Value: null

DevExtreme Gantt - Dependency

index.js
  • $(function() {
  • $("#gantt").dxGantt({
  • // ...
  • onDependencyInserted: function (e) {
  • if (e.values.type == 3) {
  • // your code
  • }
  • }
  • });
  • });
See Also

onDependencyInserting

A function that is executed before a dependency is inserted.

Type:

Function

Function parameters:

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.

values any

The values of the inserted dependency.

Default Value: null

DevExtreme Gantt - Dependency

index.js
  • $(function() {
  • $("#gantt").dxGantt({
  • // ...
  • onDependencyInserting: function (e) {
  • if (e.values.type == 3) {
  • // your code
  • e.cancel = true;
  • }
  • }
  • });
  • });
See Also

onDisposing

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

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

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

component

Gantt

The UI component's instance.

Default Value: null

onInitialized

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

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

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

component

Gantt

The UI component's instance.

Default Value: null

See Also
  • Get a UI component Instance in jQuery

onOptionChanged

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

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
value any

The modified property's new value.

previousValue any

The UI component's previous value.

name

String

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

fullName

String

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

element

HTMLElement | jQuery

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

component

Gantt

The UI component's instance.

Default Value: null

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

index.js
  • $(function() {
  • $("#ganttContainer").dxGantt({
  • // ...
  • onOptionChanged: function(e) {
  • if(e.name === "changedProperty") {
  • // handle the property change here
  • }
  • }
  • });
  • });

onResourceAssigned

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

Type:

Function

Function parameters:

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.

values any

The values of the processed resource and task.

Default Value: null

DevExtreme Gantt Chart - Resources

index.js
  • $(function() {
  • $("#gantt").dxGantt({
  • // ...
  • onResourceAssigned: function (e) {
  • if (e.values.taskID != 0) {
  • // your code
  • }
  • }
  • });
  • });
See Also

onResourceAssigning

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

Type:

Function

Function parameters:

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.

values any

The values of the processed resource and task.

Default Value: null

DevExtreme Gantt Chart - Resources

index.js
  • $(function() {
  • $("#gantt").dxGantt({
  • // ...
  • onResourceAssigning: function (e) {
  • if (e.values.taskID != 0) {
  • // your code
  • e.cancel = true;
  • }
  • }
  • });
  • });
See Also

onResourceDeleted

A function that is executed when a resource is deleted.

Type:

Function

Function parameters:

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.

values any

The values of the deleted resource.

Default Value: null

DevExtreme Gantt Chart - Resources

index.js
  • $(function() {
  • $("#gantt").dxGantt({
  • // ...
  • onResourceDeleted: function (e) {
  • if (e.key == 0) {
  • // your code
  • }
  • }
  • });
  • });
See Also

onResourceDeleting

A function that is executed before a resource is deleted.

Type:

Function

Function parameters:

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.

values any

The values of the deleted resource.

Default Value: null

DevExtreme Gantt Chart - Resources

index.js
  • $(function() {
  • $("#gantt").dxGantt({
  • // ...
  • onResourceDeleting: function (e) {
  • if (e.key == 0) {
  • // your code
  • e.cancel = true;
  • }
  • }
  • });
  • });
See Also

onResourceInserted

A function that is executed when a resource is inserted.

Type:

Function

Function parameters:

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.

values any

The values of the inserted resource.

Default Value: null

DevExtreme Gantt Chart - Resources

index.js
  • $(function() {
  • $("#gantt").dxGantt({
  • // ...
  • onResourceInserted: function (e) {
  • if (e.values.text == " "){
  • // your code
  • }
  • }
  • });
  • });
See Also

onResourceInserting

A function that is executed before a resource is inserted.

Type:

Function

Function parameters:

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.

values any

The values of the inserted resource.

Default Value: null

DevExtreme Gantt Chart - Resources

index.js
  • $(function() {
  • $("#gantt").dxGantt({
  • // ...
  • onResourceInserting: function (e) {
  • if (e.values.text == " "){
  • // your code
  • e.cancel = true;
  • }
  • }
  • });
  • });
See Also

onResourceManagerDialogShowing

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

Type:

Function

Function parameters:

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.

Default Value: null

DevExtreme Gantt - Invoke Resource Manager

index.js
  • $(function() {
  • $("#gantt").dxGantt({
  • // ...
  • onResourceManagerDialogShowing: function (e) {
  • if (e.values[0].key != 1) {
  • // your code
  • e.cancel = true;
  • }
  • }
  • });
  • });
See Also

onResourceUnassigned

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

Type:

Function

Function parameters:

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.

values any

The values of the processed resource and task.

Default Value: null

DevExtreme Gantt Chart - Resources

index.js
  • $(function() {
  • $("#gantt").dxGantt({
  • // ...
  • onResourceUnassigned: function (e) {
  • if (e.key != 0) {
  • // your code
  • }
  • }
  • });
  • });
See Also

onResourceUnassigning

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

Type:

Function

Function parameters:

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.

values any

The values of the processed resource and task.

Default Value: null

DevExtreme Gantt Chart - Resources

index.js
  • $(function() {
  • $("#gantt").dxGantt({
  • // ...
  • onResourceUnassigning: function (e) {
  • if (e.key != 0) {
  • // your code
  • e.cancel = true;
  • }
  • }
  • });
  • });
See Also

onScaleCellPrepared

A function that is executed before a scale cell is prepared.

Type:

Function

Function parameters:

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.

scaleElement

HTMLElement | jQuery

The scale cell.

scaleIndex

Number

Specifies the scale's index.

scaleType

GanttRenderScaleType

The scale type.

separatorElement

HTMLElement | jQuery

The separator after the scale cell.

endDate

Date

The end date of the scale cell.

startDate

Date

The start date of the scale cell.

Default Value: null

The example below illustrates how to customize the scale.

DevExtreme Gantt - Customize Scale

index.js
  • $(function() {
  • $("#gantt").dxGantt({
  • // ...
  • onScaleCellPrepared: function(e) {
  • var scaleElement = e.scaleElement[0];
  • if(e.scaleIndex === 0) {
  • scaleElement.style.backgroundColor = "silver";
  • scaleElement.innerText = "bottom";
  • } else {
  • scaleElement.style.backgroundColor = "LightSteelBlue";
  • scaleElement.innerText = "top";
  • }
  • var border = e.separatorElement[0];
  • border.style.borderColor = "steelBlue";
  • }
  • });
  • });

The code below colors the scale cells depending on the season:

DevExtreme Gantt - Customize Scale by Seasons

index.js
  • $(function() {
  • $("#gantt").dxGantt({
  • // ...
  • onScaleCellPrepared: function(e) {
  • var scaleElement = e.scaleElement;
  • var color = "";
  • var month = e.end.getMonth();
  • if (month > 1 && month < 5) {
  • color = "lightGreen";
  • } else if (month > 4 && month < 8) {
  • color = "green";
  • } else if (month > 7 && month < 11) {
  • color = "yellow";
  • } else
  • color = "white";
  • scaleElement.style.backgroundColor = color;
  • }
  • });
  • });

onSelectionChanged

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

Type:

Function

Function parameters:

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.

selectedRowKey any

The key of the row whose selection state was changed.

Default Value: null

View Demo

index.js
  • $(function() {
  • $("#gantt").dxGantt({
  • // ...
  • onSelectionChanged: function (e) {
  • if (e.selectedRowKey === 2) {
  • // your code
  • } else {
  • // your code
  • }
  • }
  • });
  • });
See Also

onTaskClick

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

Type:

Function

Function parameters:

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.

Default Value: null

DevExtreme Gantt Chart - Task Element

index.js
  • $(function() {
  • $("#gantt").dxGantt({
  • // ...
  • onTaskClick: function (e) {
  • if (e.key != 0) {
  • // your code
  • }
  • }
  • });
  • });
See Also

onTaskDblClick

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

Type:

Function

Function parameters:

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.

Default Value: null

DevExtreme Gantt Chart - Task Element

index.js
  • $(function() {
  • $("#gantt").dxGantt({
  • // ...
  • onTaskDblClick: function (e) {
  • if (e.key != 0) {
  • // your code
  • e.cancel = true;
  • }
  • }
  • });
  • });
See Also

onTaskDeleted

A function that is executed when a task is deleted.

Type:

Function

Function parameters:

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.

values any

The values of the deleted task.

Default Value: null

DevExtreme Gantt Chart - Task Element

index.js
  • $(function() {
  • $("#gantt").dxGantt({
  • // ...
  • onTaskDeleted: function (e) {
  • if (e.key != 0) {
  • // your code
  • }
  • }
  • });
  • });
See Also

onTaskDeleting

A function that is executed before a task is deleted.

Type:

Function

Function parameters:

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.

values any

The values of the deleted task.

Default Value: null

DevExtreme Gantt Chart - Task Element

index.js
  • $(function() {
  • $("#gantt").dxGantt({
  • // ...
  • onTaskDeleting: function (e) {
  • if (e.key != 0) {
  • // your code
  • e.cancel = true;
  • }
  • }
  • });
  • });
See Also

onTaskEditDialogShowing

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

Type:

Function

Function parameters:

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.

readOnlyFields

Array<String>

An array of read-only fields.

values any

The task values.

Default Value: null

The hiddenFields and readOnlyFields parameters affect only task fields. Disable the allowTaskResourceUpdating property to freeze the Resource Manager in the Task Details dialog.

DevExtreme Gantt Chart - Task Edit Dialog

index.js
  • $(function() {
  • $("#gantt").dxGantt({
  • // ...
  • onTaskEditDialogShowing: function (e) {
  • if (e.key != 0) {
  • // your code
  • e.cancel = true;
  • }
  • }
  • });
  • });
See Also

onTaskInserted

A function that is executed when a task is inserted.

Type:

Function

Function parameters:

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.

values any

The values of the inserted task.

Default Value: null

DevExtreme Gantt Chart - Task Element

index.js
  • $(function() {
  • $("#gantt").dxGantt({
  • // ...
  • onTaskInserted: function (e) {
  • if (e.values.text == " ") {
  • // your code
  • }
  • }
  • });
  • });
See Also

onTaskInserting

A function that is executed before a task is inserted.

Type:

Function

Function parameters:

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.

values any

The values of the inserted task.

Default Value: null

DevExtreme Gantt Chart - Task Element

Note that you should not specify a task ID in the onTaskInserting function.

index.js
  • $(function() {
  • $("#gantt").dxGantt({
  • // ...
  • onTaskInserting: function (e) {
  • if (e.values.text == " ") {
  • // your code
  • e.cancel = true;
  • }
  • }
  • });
  • });
See Also

onTaskMoving

A function that is executed before a task is moved.

Type:

Function

Function parameters:

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.

newValues any

The task values after moving.

values any

The task values before moving.

Default Value: null

DevExtreme Gantt Chart - Task Element

index.js
  • $(function() {
  • $("#gantt").dxGantt({
  • // ...
  • onTaskMoving: function (e) {
  • if (e.key != 0) {
  • // your code
  • e.cancel = true;
  • }
  • }
  • });
  • });
See Also

onTaskUpdated

A function that is executed when a task is updated.

Type:

Function

Function parameters:

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.

values any

The task values after update.

Default Value: null

DevExtreme Gantt Chart - Task Element

index.js
  • $(function() {
  • $("#gantt").dxGantt({
  • // ...
  • onTaskUpdated: function (e) {
  • if (e.key != 0) {
  • // your code
  • }
  • }
  • });
  • });
See Also

onTaskUpdating

A function that is executed before a task is updated.

Type:

Function

Function parameters:

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.

newValues any

The task values after update.

values any

The task values before update.

Default Value: null

DevExtreme Gantt Chart - Task Element

index.js
  • $(function() {
  • $("#gantt").dxGantt({
  • // ...
  • onTaskUpdating: function (e) {
  • if (e.key != 0) {
  • // your code
  • e.cancel = true;
  • }
  • }
  • });
  • });
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
index.js
data.js
  • $(function() {
  • $("#gantt").dxGantt({
  • resourceAssignments: {
  • dataSource: resourceAssignments,
  • keyExpr: "key",
  • resourceIdExpr: "resourceKey",
  • taskIdExpr: "taskKey"
  • },
  • //...
  • });
  • });
  • var 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.

The 'color' field accepts the following values:

index.js
data.js
  • $(function() {
  • $("#gantt").dxGantt({
  • resources: {
  • dataSource: resources,
  • keyExpr: "resourceId",
  • textExpr: "title",
  • colorExpr: "resourceColor"
  • },
  • //...
  • });
  • });
  • var resources = [{
  • 'resourceId': 1,
  • 'title': 'Management',
  • 'resourceColor': 'red'
  • },
  • // ...
  • ];
See Also

rootValue

Specifies the root task's identifier.

Type: any
Default Value: 0

scaleType

Specifies the zoom level of tasks in the Gantt chart.

Default Value: 'auto'

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

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

If the scaleType property is set to "auto", the UI component's scale type is calculated based on the time difference between the start of the first task and the end of the final task. For example, if this difference is more than a year, the scaleType property is set to 'years'.

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

scaleTypeRange

Configures zoom range settings.

Type:

Object

Use the scaleTypeRange.min and scaleTypeRange.max properties to limit zoom in the Gantt chart.

index.js
  • $(function() {
  • $("#gantt").dxGantt({
  • scaleTypeRange: {
  • min: 'days',
  • max: 'years'
  • },
  • // ...
  • });
  • });
See Also

selectedRowKey

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

Type: any | undefined
Default Value: undefined

View Demo

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

showDependencies

Specifies whether to display dependencies between tasks.

Type:

Boolean

Default Value: true

View Demo

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

showResources

Specifies whether to display task resources.

Type:

Boolean

Default Value: true

View Demo

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

showRowLines

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

Type:

Boolean

Default Value: true

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

sorting

Configures sort settings.

View Demo

Users can sort Gantt data by a single or multiple columns. Use the mode option to specify the sort mode.

  • Single Mode. Click a column header to sort data by this column. Subsequent clicks on the same header reverse the sort order.

    DevExtreme Gantt - Sorting

  • Multiple Mode. Hold Shift and click column headers to sort data by multiple columns. Subsequent clicks on the same header with the Shift key pressed reverse the column's sort order. Set the showSortIndexes option to true to show the column sort index in the header.

    DevExtreme Gantt - Sorting

To disable sorting for a particular column, set the column’s allowSorting option to false.

To clear sorting for a column, hold Ctrl and click the column header. You can also use the column header’s context menu to specify the column’s sort settings and clear sorting. Use the ascendingText, descendingText, and the clearText options to specify text for the corresponding context menu items.

DevExtreme Gantt - Sorting

index.js
  • $(function() {
  • $("#gantt").dxGantt({
  • sorting: {
  • mode: 'multiple',
  • showSortIndexes: true,
  • ascendingText: "Ascending Order",
  • descendingText: "Descending Order",
  • clearText: "Clear Sort"
  • }
  • });
  • });

startDateRange

Specifies the start date of the date interval in the Gantt chart.

Type:

Date

Default Value: null

View Demo

JavaScript
  • $(function() {
  • $("#gantt").dxGantt({
  • startDateRange: new Date(2018, 01, 1),
  • endDateRange: new Date(2020, 01, 1)
  • // ...
  • });
  • });
See Also

stripLines[]

Configures strip lines.

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

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.

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.

View Demo

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;
  • }

taskListWidth

Specifies the width of the task list in pixels.

Type:

Number

Default Value: 300

View Demo

DevExtreme Gantt Chart - Task List

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

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.

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;
  • }

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.

The 'color' field accepts the following values:

NOTE
The 'id' and 'parentId' fields should not have the same value.
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'
  • },
  • // ...
  • ];
See Also

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.

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;
  • }

taskTitlePosition

Specifies a task's title position.

Default Value: 'inside'

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

DevExtreme Gantt Chart - Task titles

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

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.

index.js
  • $(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;
  • }

toolbar

Configures toolbar settings.

Default Value: null

validation

Configures validation properties.

Type:

Object

View Demo

index.js
  • $(function() {
  • $("#gantt").dxGantt({
  • validation: {
  • autoUpdateParentTasks: true,
  • 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

| undefined
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", "20vw", "80%", "auto", "inherit".

  • Function (deprecated since v21.2)
    Refer to the W0017 warning description for information on how you can migrate to viewport units.