React Gantt API

The Gantt is a UI component that displays the task flow and dependencies between tasks.

import Gantt from "devextreme-react/gantt"
Type: GanttTypes.default

View Demo

See Also

Props

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

Name Description
accessKey

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

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

Specifies whether users can select tasks in the Gantt.
columns

An array of columns in the Gantt.
dependencies

Configures dependencies.
disabled

Specifies whether the UI component responds to user interaction.
editing

Configures edit properties.
elementAttr

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

Specifies the first day of a week.
focusStateEnabled

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

Specifies the UI component's height.
hint

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

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

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

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

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

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

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

Configures resource assignments.
resources

Configures task resources.
scaleType

Specifies the zoom level of tasks in the Gantt chart.
selectedRowKey

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

Specifies whether to display task resources.
showRowLines

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

Configures strip lines.
tabIndex

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

Specifies the width of the task list in pixels.
tasks

Configures tasks.
taskTitlePosition

Specifies a task's title position.
toolbar

Configures toolbar settings.
validation

Configures validation properties.
visible

Specifies whether the UI component is visible.
width

Specifies the UI component's width.

See Also

Methods

This section describes methods that control the Gantt UI component.

Name Description
beginUpdate()

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

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

Disposes of all the resources allocated to the Gantt instance.
element()

Gets the root UI component element.
endUpdate()

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

Sets focus on the UI component.
getInstance(element)

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

Gets the UI component's instance. Use it to access other methods of the UI component.
off(eventName)

Detaches all event handlers from a single event.
off(eventName, eventHandler)

Detaches a particular event handler from a single event.
on(eventName, eventHandler)

Subscribes to an event.
on(events)

Subscribes to events.
option()

Gets all UI component properties.
option(optionName)

Gets the value of a single property.
option(optionName, optionValue)

Updates the value of a single property.
option(options)

Updates the values of several properties.
registerKeyHandler(key, handler)

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

Repaints the UI component without reloading data. Call it to update the UI component's markup.
resetOption(optionName)

Resets an property to its default value.

Events

This section describes the events this UI component raises.

Name Description
contentReady

Raised when the UI component's content is ready.
disposing

Raised before the UI component is disposed of.
initialized

Raised only once, after the UI component is initialized.
optionChanged

Raised after a UI component property is changed.
selectionChanged

Raised after users select a task or clear its selection.

See Also