Vue Gantt API CTP

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

NOTE

DevExtreme Gantt is available as a community technology preview (CTP). Should you have any questions or suggestions prior to its official release, please email your comments to support@devexpress.com.

import DxGantt from "devextreme-vue/gantt"

Type: DxGanttTypes.default

View Demo

Configuration

An object that defines the Gantt widget's configuration options.

Name	Description
accessKey	Specifies the shortcut key that sets focus on the widget.
activeStateEnabled	Specifies whether or not the widget 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 widget responds to user interaction.
editing	Configures edit options.
elementAttr	Specifies the attributes to be attached to the widget's root element.
focusStateEnabled	Specifies whether the widget can be focused using keyboard navigation.
height	Specifies the widget's height.
hint	Specifies text for a hint that appears when a user pauses on the widget.
hoverStateEnabled	Specifies whether the widget changes its state when a user pauses on it.
onContentReady	A function that is executed when the widget's content is ready and each time the content is changed.
onDisposing	A function that is executed before the widget is disposed of.
onInitialized	A function used in JavaScript frameworks to save the widget instance.
onOptionChanged	A function that is executed after a widget option 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.
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.
visible	Specifies whether the widget is visible.
width	Specifies the widget's width.

Methods

This section describes members used to manipulate the widget.

Name	Description
beginUpdate()	Prevents the widget from refreshing until the endUpdate() method is called.
defaultOptions(rule)	Specifies the device-dependent default configuration options for this component.
dispose()	Disposes of all the resources allocated to the Gantt instance.
element()	Gets the root widget element.
endUpdate()	Refreshes the widget after a call of the beginUpdate() method.
focus()	Sets focus on the widget.
getInstance(element)	Gets the instance of a widget found using its DOM node.
instance()	Gets the widget's instance. Use it to access other methods of the widget.
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 widget options.
option(optionName)	Gets the value of a single option.
option(optionName, optionValue)	Updates the value of a single option.
option(options)	Updates the values of several options.
registerKeyHandler(key, handler)	Registers a handler to be executed when a user presses a specific key.
repaint()	Repaints the widget without reloading data. Call it to update the widget's markup.
resetOption(optionName)	Resets an option to its default value.

Events

This section describes the events this widget raises.

Name	Description
contentReady	Raised when the widget's content is ready.
disposing	Raised before the widget is disposed of.
initialized	Raised only once, after the widget is initialized.
optionChanged	Raised after a widget option is changed.
selectionChanged	Raised after users select a task or clear its selection.

Vue Gantt API CTP

See Also

Configuration

See Also

Methods

Events

See Also