Syncfusion.EJ2
Properties  Methods 


Gantt Class Members

The following tables list the members exposed by Gantt.

Public Constructors
 NameDescription
Public Constructor  
Top
Public Properties
 NameDescription
Public Property Triggers when Gantt actions such as sorting, filtering, searching etc., starts.  
Public Property Triggers when Gantt actions such as sorting, filtering, searching etc. are completed.  
Public Property Triggers when actions are failed.  
Public Property Defines the tabs and fields to be included in the add dialog. If the value was empty, then it will be calculated from `taskSettings` and `columns` value.  
Public Property If `allowExcelExport` set to true, then it will allow the user to export Gantt to Excel and CSV file.  
Public Property Enables or disables filtering support in Gantt.  
Public Property If `allowReordering` is set to true, Gantt columns can be reordered. Reordering can be done by drag and drop of a particular column from one index to another index.  
Public Property If `allowResizing` is set to true, Gantt columns can be resized.  
Public Property If `allowSelection` is set to true, it allows selection of (highlight row) Gantt chart rows by clicking it.  
Public Property If `allowSorting` is set to true, it allows sorting of gantt chart tasks when column header is clicked.  
Public Property Enables or disables rendering of unscheduled tasks in Gantt.  
Public Property Enables or disables the focusing the task bar on click action.  
Public Property Defines the baseline bar color.  
Public Property Triggers before Gantt data is exported to Excel file.  
Public Property Triggers before tooltip get rendered.  
Public Property Triggers when a particular selected cell is deselected.  
Public Property Triggers before the selected cell is deselecting.  
Public Property This will be triggered a cell get begins to edit.  
Public Property Triggers after a cell is selected.  
Public Property Triggers before any cell selection occurs.  
Public Property If `collapseAllParentTasks` set to true, then root tasks are rendered with collapsed state.  
Public Property This will be triggered after the row getting collapsed.  
Public Property This will be triggered before the row getting collapsed.  
Public Property Triggers when column header element is dragged (moved) continuously.  
Public Property Triggers when column header element drag (move) starts.  
Public Property Triggers when a column header element is dropped on the target column.  
Public Property Triggers when click on column menu.  
Public Property `columnMenuItems` defines both built-in and custom column menu items. The available built-in items are, `ColumnChooser` - To show/hide the TreeGrid columns. `SortAscending` - Sort the current column in ascending order. `SortDescending` - Sort the current column in descending order. `Filter` - Filter options will show based on filterSettings property.  
Public Property Triggers before column menu opens.  
Public Property Defines column collection displayed in grid If the `columns` declaration was empty then `columns` are automatically populated from `taskSettings` value.  
Public Property Defines background color of dependency lines.  
Public Property Defines width of dependency lines.  
Public Property Triggers when click on context menu.  
Public Property If `contextMenuItems` are array collection of menu items in Context Menu.  
Public Property Triggers before context menu opens.  
Public Property Triggers when the component is created.  
Public Property Triggers when data source is populated in the Grid.  
Public Property It is used to render Gantt chart rows and tasks. `dataSource` value was defined as array of JavaScript objects or instances of `DataManager`.  
Public Property Specifies the dateFormat for Gantt, given format is displayed in tooltip and Grid cells.  
Public Property Defines customized working time of project.  
Public Property Triggers when the component is destroyed.  
Public Property `durationUnit` Specifies the duration unit for each tasks whether day or hour or minute. `day`: Sets the duration unit as day. `hour`: Sets the duration unit as hour. `minute`: Sets the duration unit as minute.  
Public Property Defines the tabs and fields to be included in the edit dialog. If the value was empty, then it will be calculated from `taskSettings` and `columns` value.  
Public Property Configures edit settings of Gantt.  
Public Property If `enableContextMenu` is set to true, Enable context menu in Gantt.  
Public Property Enable or disable persisting component's state between page reloads.  
Public Property If `enablePredecessorValidation` is set to true, it allows to validate the predecessor link.  
Public Property Enable or disable rendering component in right to left direction.  
Public Property This will be triggered when a task get saved by cell edit.  
Public Property Defines events and status of project throughout the timeline.  
Public Property Triggers after Gantt data is exported to Excel file.  
Public Property Triggers before exporting each header cell to Excel file. You can also customize the Excel cells.  
Public Property Triggers before exporting each cell to Excel file. You can also customize the Excel cells.  
Public Property This will be triggered after the row getting expanded.  
Public Property This will be triggered before the row getting expanded.  
Public Property Configures the filter settings for Gantt.  
Public Property Configures the grid lines in tree grid and gantt chart.  
Public Property This will be triggered before the header cell element is appended to the Grid element.  
Public Property Defines the height of the Gantt component container.  
Public Property If `highlightWeekends` set to true, then all weekend days are highlighted in week - day timeline mode.  
Public Property Defines holidays presented in project timeline.  
Public Property Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.  
Public Property (Inherited from Syncfusion.EJ2.EJTagHelper)
Public Property Defines weekend days are considered as working day or not.  
Public Property Defines the right, left and inner task labels in task bar.  
Public Property Triggered before the Gantt control gets rendered.  
Public Property Overrides the global culture and localization value for this component. Default global culture is 'en-US'.  
Public Property The milestone template that renders customized milestone task from the given template.  
Public Property The parent task bar template that renders customized parent task bars from the given template.  
Public Property Defines end date of the project, if `projectEndDate` value not set then it will be calculated from data source.  
Public Property Defines start date of the project, if `projectStartDate` value not set then it will be calculated from data source.  
Public Property Defines the external [`Query`](https://ej2.syncfusion.com/documentation/data/api-query.html) that will be executed along with data processing.  
Public Property This will be triggered before the header cell element is appended to the Grid element.  
Public Property This will be triggered after the taskbar element is appended to the Gantt element.  
Public Property If `renderBaseline` is set to `true`, then baselines are rendered for tasks.  
Public Property Triggers when column resize starts.  
Public Property Triggers when column resize ends.  
Public Property Triggers on column resizing.  
Public Property Defines mapping property to get resource id value from resource collection.  
Public Property Defines mapping property to get resource name value from resource collection.  
Public Property Defines resource collection assigned for projects.  
Public Property This will be triggered before the row element is appended to the Grid element.  
Public Property Triggers when a selected row is deselected.  
Public Property Triggers before deselecting the selected row.  
Public Property Defines height value for grid rows and chart rows in Gantt.  
Public Property Triggers after a row is selected.  
Public Property Triggers before row selection occurs.  
Public Property Configures the search settings for Gantt.  
Public Property The `selectedRowIndex` allows you to select a row at initial rendering. You can also get the currently selected row index.  
Public Property Configures the selection settings.  
Public Property If `showColumnMenu` set to true, then it will enable the column menu options in each columns.  
Public Property To show notes column cell values inside the cell or in tooltip.  
Public Property Configures the sort settings of the Gantt.  
Public Property Triggers when splitter resizing action completed.  
Public Property Triggers when splitter resizing starts.  
Public Property Triggers when splitter bar was dragging.  
Public Property Configures the splitter settings for Gantt.  
Public Property This will be triggered taskbar was dragged and dropped on new position.  
Public Property This event will be triggered when taskbar was in dragging state.  
Public Property Defines height of taskbar element in Gantt.  
Public Property The task bar template that renders customized child task bars from the given template.  
Public Property Defines mapping properties to find task values such as id, start date, end date, duration and progress values from data source.  
Public Property Configures timeline settings of Gantt. Defines default timeline modes or customized top tier mode and bottom tier mode or single tier only.  
Public Property `toolbar` defines the toolbar items of the Gantt. It contains built-in and custom toolbar items. If an array value is assigned, it is considered as the list of built-in and custom toolbar items in the Gantt's toolbar. The available built-in toolbar items are: Add: Adds a new record. Edit: Edits the selected task. Update: Updates the edited task. Delete: Deletes the selected task. Cancel: Cancels the edit state. Search: Searches tasks by the given key. ExpandAll: Expands all the task of Gantt. CollapseAll: Collapses all the task of Gantt. PrevTimeSpan: Extends timeline with one unit before the timeline start date. NextTimeSpan: Extends timeline with one unit after the timeline finish date. ZoomIn: ZoomIn the Gantt control. ZoomOut: ZoomOut the Gantt control. ZoomToFit: Display the all tasks within the viewable Gantt chart. ExcelExport: To export in Excel format CsvExport : To export in CSV format  
Public Property Triggers when toolbar item was clicked.  
Public Property Enables or disables default tooltip of Gantt element and defines customized tooltip for Gantt elements.  
Public Property To define expander column index in Grid.  
Public Property Defines the width of the Gantt component container.  
Public Property Defines workweek of project.  
Top
Protected Properties
 NameDescription
Protected PropertyOverridden.   
Protected Property (Inherited from Syncfusion.EJ2.EJTagHelper)
Protected Property (Inherited from Syncfusion.EJ2.EJTagHelper)
Protected Property (Inherited from Syncfusion.EJ2.EJTagHelper)
Protected PropertyOverridden.   
Protected PropertyOverridden.   
Protected Property (Inherited from Syncfusion.EJ2.EJTagHelper)
Protected PropertyOverridden.   
Top
Public Methods
Protected Methods
 NameDescription
Protected Method (Inherited from Syncfusion.EJ2.EJTagHelper)
Protected Method (Inherited from Syncfusion.EJ2.EJTagHelper)
Top
Extension Methods
 NameDescription
Public Extension MethodOverloaded.  Iterates the index.
Top
See Also