Class SfGantt<TValue>

Blazor Gantt chart is a project management tool which is used for scheduling and managing projects. It allows us to manage tasks, task relationships, and resources in a project.

Inheritance

System.Object

SfBaseComponent

SfDataBoundComponent

SfGantt<TValue>

Implements

IGantt

Inherited Members

SfDataBoundComponent.SetDataManager<T>(Object)

SfDataBoundComponent.DataManager

SfDataBoundComponent.MainParent

SfBaseComponent.Dispose()

SfBaseComponent.Dispose(Boolean)

SfBaseComponent.OnObservableChange(String, Object, Boolean, NotifyCollectionChangedEventArgs)

Namespace: Syncfusion.Blazor.Gantt

Assembly: Syncfusion.Blazor.dll

Syntax

public class SfGantt<TValue> : SfDataBoundComponent, IGantt

Type Parameters

Name	Description
TValue	The second generic type parameter.

Remarks

TValue is inferred from value of DataSource property if it is bounded with IEnumerable. If data is consumed using SfDataManager then TValue must be assigned explicitly.

Constructors

SfGantt()

Declaration

public SfGantt()

Properties

AddDialogFields

Defines the tabs and fields to be included in the add dialog.

Declaration

public List<GanttAddDialogField> AddDialogFields { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<GanttAddDialogField>

AllowExcelExport

If 'AllowExcelExport' is set to true, it allows to export excel and csv.

Declaration

public bool AllowExcelExport { get; set; }

Property Value

Type	Description
System.Boolean

AllowFiltering

Specifies whether allowFiltering is true or false.

Declaration

public bool AllowFiltering { get; set; }

Property Value

Type	Description
System.Boolean

AllowMultiSorting

If AllowMultiSorting set to true, then it will allow the user to sort multiple column in the gantt.

Declaration

public bool AllowMultiSorting { get; set; }

Property Value

Type	Description
System.Boolean

AllowReordering

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.

Declaration

public bool AllowReordering { get; set; }

Property Value

Type	Description
System.Boolean

AllowResizing

If AllowResizing is set to true, Gantt columns can be resized.

Declaration

public bool AllowResizing { get; set; }

Property Value

Type	Description
System.Boolean

AllowRowDragAndDrop

If AllowRowDragAndDrop set to true, then it will allow the user to perform drag and drop action in Gantt.

Declaration

public bool AllowRowDragAndDrop { get; set; }

Property Value

Type	Description
System.Boolean

AllowSelection

If AllowSelection is set to true, it allows selection of (highlight row) Gantt records by clicking it.

Declaration

public bool AllowSelection { get; set; }

Property Value

Type	Description
System.Boolean

AllowSorting

If AllowSorting is set to true, it allows sorting of treegrid records when column header is clicked.

Declaration

public bool AllowSorting { get; set; }

Property Value

Type	Description
System.Boolean

AllowUnscheduledTasks

Enables or disables rendering of unscheduled tasks in Gantt. You can create or update the tasks with anyone of start date, end date, and duration values or none.

Declaration

public bool AllowUnscheduledTasks { get; set; }

Property Value

Type	Description
System.Boolean

BaselineColor

Defines the baseline color.

Declaration

public string BaselineColor { get; set; }

Property Value

Type	Description
System.String

ChildContent

Declaration

public RenderFragment ChildContent { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment

CollapseAllParentTasks

if CollapseAllParentTasks is set true,then root tasks are rendered with collapsed state.

Declaration

public bool CollapseAllParentTasks { get; set; }

Property Value

Type	Description
System.Boolean

ColumnChooserSettings

Configures Column chooser settings for the user.

Declaration

public GanttColumnChooserSettings ColumnChooserSettings { get; set; }

Property Value

Type	Description
GanttColumnChooserSettings

ColumnMenuItems

The available built-in ColumnMenu items are, AutoFitAllColumns - Auto fit all columns. AutoFitThisColumn - Auto fit the current column. SortAscending - Sort the current column in ascending order. SortDescending - Sort the current column in descending order. ColumnChooser - To show/hide the TreeGrid columns. Filter - Filter options will show based on filterSettings property.

Declaration

public string[] ColumnMenuItems { get; set; }

Property Value

Type	Description
System.String[]

Columns

Defines column collection displayed in grid. If the Columns declaration was empty then columns are automatically populated based on taskFieldSettings value.

Declaration

public List<GanttColumn> Columns { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<GanttColumn>

ConnectorLineBackground

Defines background color of dependency lines.

Declaration

public string ConnectorLineBackground { get; set; }

Property Value

Type	Description
System.String

ConnectorLineWidth

Defines width of dependency lines.

Declaration

public int ConnectorLineWidth { get; set; }

Property Value

Type	Description
System.Int32

ContextMenuItems

ContextMenuItems defines both built-in and custom context menu items.

The available built-in items are, AutoFitAll - Auto fit the size of all columns. AutoFit - Auto fit the current column. SortAscending - Sort the current column in ascending order. SortDescending - Sort the current column in descending order. TaskInformation - Go to the first page. Save - Saves the edited Task. Cancel - Cancels the edited Task. DeleteTask - Deletes the current Task. Add - Adds a new row to the Gantt. Convert - Convert Current Task to Milestone or vice-versa. Indent - Indent the selected record to one level. Outdent - Outdent the selected record to one level. DeleteDependency - Deletes the current dependency task link.

Declaration

public object ContextMenuItems { get; set; }

Property Value

Type	Description
System.Object

CurrentViewData

Declaration

public IEnumerable<object> CurrentViewData { get; set; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<System.Object>

CustomZoomingLevels

To customize zooming Level.

Declaration

public GanttZoomTimelineSettings[] CustomZoomingLevels { get; set; }

Property Value

Type	Description
GanttZoomTimelineSettings[]

DataSource

Provides the data source for rendering gantt rows. The data source value can be of any type. that implements IEnumerable.

Declaration

public IEnumerable<TValue> DataSource { get; set; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<TValue>

Remarks

To consume data from remote service or custom adaptor, SfDataManager component has to be used.

DataSourceChanged

Invokes when data source changes.

Declaration

public EventCallback<IEnumerable<TValue>> DataSourceChanged { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<System.Collections.Generic.IEnumerable<TValue>>

DateFormat

Specifies the dateFormat for Gantt, given format is displayed in tooltip and Grid cells. By default, the format is based on the culture.

Declaration

public string DateFormat { get; set; }

Property Value

Type	Description
System.String

DayWorkingTime

Defines customized working time of project.Default Day Working Time from 8.00 To 17.00.

Declaration

public List<GanttDayWorkingTime> DayWorkingTime { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<GanttDayWorkingTime>

DependencyTypes

Gets or sets the dependency types in Gantt.

Declaration

public List<DependencyType> DependencyTypes { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<DependencyType>	Predecessor types configured in Gantt. By default, all 4 types (FS, SS, FF, and SF) are enabled.

Remarks

To configure specific dependency types which should be allowed in Gantt. The type mentioned in the first index of the DependencyTypes property will be the default type.

Examples

   

    <SfGantt DataSource="@TaskCollection" DependencyTypes="@(new List<DependencyType>() { DependencyType.FS })" >  
    </SfGantt>   

DisableHtmlEncode

If DisableHtmlEncode is set to true, it encodes the HTML of the header and content cells.

Declaration

public bool DisableHtmlEncode { get; set; }

Property Value

Type	Description
System.Boolean

DurationUnit

DurationUnit Specifies the duration unit for each tasks whether day or hour or minute.

Declaration

public DurationUnit DurationUnit { get; set; }

Property Value

Type	Description
DurationUnit

EditDialogFields

Defines the tabs and fields to be included in the edit dialog.

Declaration

public List<GanttEditDialogField> EditDialogFields { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<GanttEditDialogField>

EditSettings

Configures the edit settings.It enables you to edit the tasks.

Declaration

public GanttEditSettings EditSettings { get; set; }

Property Value

Type	Description
GanttEditSettings

EnableContextMenu

If EnableContextMenu set to true, then it will enable all the build in ContextMenu items.

Declaration

public bool EnableContextMenu { get; set; }

Property Value

Type	Description
System.Boolean

EnablePersistence

Enable or disable persisting component's state between page reloads.

Declaration

public bool EnablePersistence { get; set; }

Property Value

Type	Description
System.Boolean

EnablePredecessorValidation

If EnablePredecessorValidation is set to true, it allows to validate the predecessor link.

Declaration

public bool EnablePredecessorValidation { get; set; }

Property Value

Type	Description
System.Boolean

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration

public bool EnableRtl { get; set; }

Property Value

Type	Description
System.Boolean

EnableVirtualization

If EnableVirtualization set to true, then the Gantt will render only the rows visible within the view-port and load subsequent rows on vertical scrolling. This helps to load large dataset in Gantt.

Declaration

public bool EnableVirtualization { get; set; }

Property Value

Type	Description
System.Boolean

EventMarkers

Defines events and status of project throughout the timeline.You can define date and label for the event markers.

Declaration

public List<GanttEventMarker> EventMarkers { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<GanttEventMarker>

FilterSettings

Configures the filter settings for Gantt.You can filter the records with different operators.

Declaration

public GanttFilterSettings FilterSettings { get; set; }

Property Value

Type	Description
GanttFilterSettings

FlatData

Declaration

public IEnumerable<object> FlatData { get; set; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<System.Object>

GridLines

Configures the grid lines in tree grid and gantt chart.

• BothDisplays both the horizontal and vertical grid lines.
• NoneNo grid lines are displayed.
• HorizontalDisplays the horizontal grid lines only.
• VerticalDisplays grid lines based on the theme.

Declaration

public GridLine GridLines { get; set; }

Property Value

Type	Description
GridLine

Height

Defines the height of the Gantt component container.

Declaration

public string Height { get; set; }

Property Value

Type	Description
System.String

HighlightWeekends

If highlightWeekends set to true, then all weekend days are highlighted in week only on day timeline mode.

Declaration

public bool HighlightWeekends { get; set; }

Property Value

Type	Description
System.Boolean

Holidays

Defines holidays presented in project timeline.

Declaration

public List<GanttHoliday> Holidays { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<GanttHoliday>

ID

To get Gantt ID.

Declaration

public string ID { get; set; }

Property Value

Type	Description
System.String

IncludeWeekend

Defines weekend days are considered as working day or not.

Declaration

public bool IncludeWeekend { get; set; }

Property Value

Type	Description
System.Boolean

KeySettings

Configures the cell movement keys in the Grid.

Declaration

public GanttKeySettings KeySettings { get; set; }

Property Value

Type	Description
GanttKeySettings

LabelSettings

Configures the gantt label settings for Gantt.You can define Task Label.

Declaration

public GanttLabelSettings<TValue> LabelSettings { get; set; }

Property Value

Type	Description
GanttLabelSettings<TValue>

Locale

Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

Declaration

public string Locale { get; set; }

Property Value

Type	Description
System.String

ProjectEndDate

Defines end date of the project, if ProjectEndDate value not set then it will be calculated from data source.

Declaration

public Nullable<DateTime> ProjectEndDate { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTime>

ProjectStartDate

Defines start date of the project, if ProjectStartDate value not set then it will be calculated from data source.

Declaration

public Nullable<DateTime> ProjectStartDate { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTime>

Query

Defines the external Query that will be executed along with data processing.

Declaration

public Query Query { get; set; }

Property Value

Type	Description
Query

RenderBaseline

If 'RenderBaseline' is set to true, it allows to baseline.you should map the baseline start and end date values from the data source.

Declaration

public bool RenderBaseline { get; set; }

Property Value

Type	Description
System.Boolean

ResourceFields

Configures the GanttResourceFields.you can show or allocate the resources (human resources) for each task.

Declaration

public GanttResourceFields<ExpandoObject> ResourceFields { get; set; }

Property Value

Type	Description
GanttResourceFields<System.Dynamic.ExpandoObject>

RowHeight

Defines height value for grid rows and chart rows in Gantt.

Declaration

public int RowHeight { get; set; }

Property Value

Type	Description
System.Int32

ScrollToTaskbarOnClick

Gets or sets whether to scroll and bring taskbar into current view port on row click action.

Declaration

public bool ScrollToTaskbarOnClick { get; set; }

Property Value

Type	Description
System.Boolean	true, if taskbar is brought into view on row selection by horizontally scrolling the chart timeline.The default value is true

Remarks

For seemless view of task information of enable this property.

Examples

<SfGantt DataSource="@TaskCollection" Height="450px" Width="700px" ScrollToTaskbarOnClick="true" >
    <GanttTaskFields Id = "TaskId" Name="TaskName" StartDate="StartDate" EndDate="EndDate" Duration="Duration" Progress="Progress"
    Dependency="Predecessor" ParentID="ParentId"></GanttTaskFields>
</ SfGantt >

SearchSettings

Configures the search settings for Gantt.You can search records in Gantt.

Declaration

public GanttSearchSettings SearchSettings { get; set; }

Property Value

Type	Description
GanttSearchSettings

SelectedRowIndex

The SelectedRowIndex allows you to select a row at initial rendering. You can also get the currently selected row index.

Declaration

public int SelectedRowIndex { get; set; }

Property Value

Type	Description
System.Int32

SelectionSettings

Configures the selection settings.It provides an option to highlight a row or a cell.

Declaration

public GanttSelectionSettings SelectionSettings { get; set; }

Property Value

Type	Description
GanttSelectionSettings

ShowColumnChooser

If ShowColumnChooser is set to true, it allows you to dynamically show or hide columns.

Declaration

public bool ShowColumnChooser { get; set; }

Property Value

Type	Description
System.Boolean	true if ShowColumnChooser is enabled; otherwise, false.The default value is false.

ShowColumnMenu

If ShowColumnMenu set to true, then it will enable the column menu options in each columns with default items.

Declaration

public bool ShowColumnMenu { get; set; }

Property Value

Type	Description
System.Boolean

ShowInlineNotes

To show notes column cell values inside the cell or in tooltip.

Declaration

public bool ShowInlineNotes { get; set; }

Property Value

Type	Description
System.Boolean

SortSettings

Configures the sort settings of the gantt.It enables you to sort data in the ascending or descending order.

Declaration

public GanttSortSettings SortSettings { get; set; }

Property Value

Type	Description
GanttSortSettings

SplitterSettings

Configures the splitter settings for Gantt.You can change splitter position.

Declaration

public GanttSplitterSettings SplitterSettings { get; set; }

Property Value

Type	Description
GanttSplitterSettings

TaskbarHeight

Defines height of taskbar element in Gantt.

Declaration

public Nullable<int> TaskbarHeight { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

TaskFields

Defines mapping properties to find task values such as id, start date, end date, duration and progress values from data source.

Declaration

public GanttTaskFields TaskFields { get; set; }

Property Value

Type	Description
GanttTaskFields

TaskMode

Specifies task schedule mode for a project.

• AutoTasks are displayed in auto scheduled mode.
• ManualTasks are displayed in manual scheduled mode.
• CustomBoth Auto and Manual tasks are render by mapped from data source.

Declaration

public ScheduleMode TaskMode { get; set; }

Property Value

Type	Description
ScheduleMode

TaskType

Defines the fixed tasktype resource allocation.

Declaration

public TaskType TaskType { get; set; }

Property Value

Type	Description
TaskType

TimelineSettings

Configures the time line settings for Gantt.you can define timescale mode of top tier and bottom tier.

Declaration

public GanttTimelineSettings TimelineSettings { get; set; }

Property Value

Type	Description
GanttTimelineSettings

TimelineTierSettings

Configures the topTier and bottomTier timeline settings for Gantt.

Declaration

public GanttTimelineTierSettings TimelineTierSettings { get; set; }

Property Value

Type	Description
GanttTimelineTierSettings

Toolbar

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.

Declaration

public object Toolbar { get; set; }

Property Value

Type	Description
System.Object

TooltipSettings

Configures the tooltip settings for Gantt.You can display a tooltip for various UI elements like taskbar, timeline cells, and grid cells.

Declaration

public GanttTooltipSettings<TValue> TooltipSettings { get; set; }

Property Value

Type	Description
GanttTooltipSettings<TValue>

TreeColumnIndex

To define expander column index in Grid.

Declaration

public int TreeColumnIndex { get; set; }

Property Value

Type	Description
System.Int32

ValidateManualTasksOnLinking

It enables date validation while connecting manually scheduled tasks with predecessor.

Declaration

public bool ValidateManualTasksOnLinking { get; set; }

Property Value

Type	Description
System.Boolean

ViewType

Defines the view type of the Gantt.

• ProjectViewDefines project view type.

Declaration

public ViewType ViewType { get; set; }

Property Value

Type	Description
ViewType

Width

Defines the width of the Gantt component container.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String

WorkUnit

Specifies the work unit for each tasks whether day or hour or minute.

• MinuteDefines unit value of duration as minute.
• HourDefines unit value of duration as hour.
• DayDefines unit value of duration as day.

Declaration

public WorkUnit WorkUnit { get; set; }

Property Value

Type	Description
WorkUnit

WorkWeek

Defines workweek of project.You can customise work week.

Declaration

public string[] WorkWeek { get; set; }

Property Value

Type	Description
System.String[]

ZoomTimelineSettings

Configures the time line settings for Gantt.you can define timescale mode of top tier and bottom tier.

Declaration

public GanttZoomTimelineSettings ZoomTimelineSettings { get; set; }

Property Value

Type	Description
GanttZoomTimelineSettings

Methods

AddPredecessor(Int32, String)

To add dependency for Task.

Declaration

public void AddPredecessor(int id, string predecessorString)

Parameters

Type	Name	Description
System.Int32	id	Defines record to add.
System.String	predecessorString	Defines the position of row.

AddRecordAsync(TValue, Nullable<Double>, Nullable<RowPosition>)

Method to add record.

Declaration

public Task AddRecordAsync(TValue data, Nullable<double> index = null, Nullable<RowPosition> position = null)

Parameters

Type	Name	Description
TValue	data	Defines record to add.
System.Nullable<System.Double>	index	Defines the position of row.
System.Nullable<RowPosition>	position	Defines the row index.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder	__builder

CallStateHasChangedAsync()

Declaration

public Task CallStateHasChangedAsync()

Returns

Type	Description
System.Threading.Tasks.Task

CancelEdit()

Cancels edited state.

Declaration

public void CancelEdit()

ClearFilteringAsync()

Clears all the filtered rows of the Gantt.

Declaration

public Task ClearFilteringAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

ClearSelectionAsync()

Deselects the current selected rows and cells.

Declaration

public Task ClearSelectionAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

ClearSortingAsync()

Clears all the sorted columns of the gantt.

Declaration

public Task ClearSortingAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

CollapseAllAsync()

Collapse all the Gantt Column.

Declaration

public Task CollapseAllAsync()

Returns

Type	Description
System.Threading.Tasks.Task	Task.

CollapseAtLevelAsync(Double)

Collapse the records along with its child records, at specific hierarchical level.

Declaration

public Task CollapseAtLevelAsync(double level)

Parameters

Type	Name	Description
System.Double	level	Specify the level of the record to be Collapsed.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

Remarks

Collapsing of child records can be cancelled by using Collapsing event.

Examples

<button @onclick="CollapseLevel">CollapseLevel</button>
<SfGantt @ref = "gantt" DataSource="@TaskCollection">
    <GanttTaskFields Id = "TaskId" Name="TaskName" StartDate="StartDate" EndDate="EndDate"
        Duration="Duration" Progress="Progress" Child="SubTasks">
    </GanttTaskFields>
</SfGantt>
@code{
private SfGantt<TaskData> gantt;
private async Task CollapseLevel()
{
    await gantt.CollapseAtLevelAsync(12); /// pass the hierarchical level 
}
}

CollapseByKeyAsync(Object)

Collapses a recored based on the primary key value of the record.

Declaration

public Task CollapseByKeyAsync(object key)

Parameters

Type	Name	Description
System.Object	key	The primary key value of the record to be collapsed.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

Examples

<button @onclick="CollapseKey">CollapseKey</button>
<SfGantt @ref = "gantt" DataSource="@TaskCollection">
    <GanttTaskFields Id = "TaskId" Name="TaskName" StartDate="StartDate" EndDate="EndDate"
        Duration="Duration" Progress="Progress" Child="SubTasks">
    </GanttTaskFields>
</SfGantt>
@code{
private SfGantt<TaskData> gantt;
private async Task CollapseKey()
{
    await gantt.CollapseByKeyAsync(12); /// pass primary key value here
}
}

ConvertToMilestone(String)

Method to convert task data to milestone data.

Declaration

public void ConvertToMilestone(string id)

Parameters

Type	Name	Description
System.String	id	Specifies the task id.

DeleteRecordAsync(Nullable<Int32>)

Method to delete record.

Declaration

public Task DeleteRecordAsync(Nullable<int> TaskID = null)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	TaskID	Defines the TaskID.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

EnableItems(List<Int32>, Boolean)

Enable/disable toolbar items dynamically.

Declaration

public void EnableItems(List<int> items, bool isEnable)

Parameters

Type	Name	Description
System.Collections.Generic.List<System.Int32>	items	Defines the List of enable items.
System.Boolean	isEnable	Defines isEnable.

ExpandAllAsync()

Method to expand all the rows of Gantt.

Declaration

public Task ExpandAllAsync()

Returns

Type	Description
System.Threading.Tasks.Task	Task.

ExpandAtLevelAsync(Double)

Expands the records along with its parent at specific hierarchical level.

Declaration

public Task ExpandAtLevelAsync(double level)

Parameters

Type	Name	Description
System.Double	level	Specifies the hierarchical Level to be Expanded.

Returns

Type	Description
System.Threading.Tasks.Task	Task.

Remarks

Expanding of child records can be cancelled by using Expanding event.

Examples

<button @onclick="ExpandLevel">ExpandLevel</button>
<SfGantt @ref = "gantt" DataSource="@TaskCollection">
    <GanttTaskFields Id = "TaskId" Name="TaskName" StartDate="StartDate" EndDate="EndDate"
        Duration="Duration" Progress="Progress" Child="SubTasks">
    </GanttTaskFields>
</SfGantt>
@code{
private SfGantt<TaskData> gantt;
private async Task ExpandLevel()
{
    await gantt.ExpandAtLevelAsync(12); /// pass the hierarchical level
}
}

ExpandByKeyAsync(Object)

Expands a record based on the primary key value of the record.

Declaration

public Task ExpandByKeyAsync(object key)

Parameters

Type	Name	Description
System.Object	key	The primary key value of the record to be expanded.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

Examples

<button @onclick="ExpandKey">ExpandKey</button>
<SfGantt @ref = "gantt" DataSource="@TaskCollection">
    <GanttTaskFields Id = "TaskId" Name="TaskName" StartDate="StartDate" EndDate="EndDate"
        Duration="Duration" Progress="Progress" Child="SubTasks">
    </GanttTaskFields>
</SfGantt>
@code{
private SfGantt<TaskData> gantt;
private async Task ExpandKey()
{
    await gantt.ExpandByKeyAsync(12); /// pass primary key value here
}
}

ExportToCsvAsync()

Export Gantt data in csv format.

Declaration

public Task ExportToCsvAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

ExportToCsvAsync(ExcelExportProperties)

Export Gantt data in csv format with excel export properties.

Declaration

public Task ExportToCsvAsync(ExcelExportProperties excelExportProperties)

Parameters

Type	Name	Description
ExcelExportProperties	excelExportProperties	Defines the options for customizing the excel document during export.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

ExportToExcelAsync()

Export Gantt data in Excel format.

Declaration

public Task ExportToExcelAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

ExportToExcelAsync(ExcelExportProperties)

Export Gantt data in Excel format with excel export properties.

Declaration

public Task ExportToExcelAsync(ExcelExportProperties excelExportProperties)

Parameters

Type	Name	Description
ExcelExportProperties	excelExportProperties	Defines the options for customizing the excel document during export.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

FilterByColumnAsync(String, String, String)

Filters gantt row by column name with the given options.

Declaration

public Task FilterByColumnAsync(string fieldName, string filterOperator, string filterValue)

Parameters

Type	Name	Description
System.String	fieldName	Specifies the field name to be filtered.
System.String	filterOperator	Specifies the filter operator.
System.String	filterValue	Specifies the filter value.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

GetColumnIndexByFieldAsync(String)

Gets a column index by column name.

Declaration

public Task<double> GetColumnIndexByFieldAsync(string field)

Parameters

Type	Name	Description
System.String	field	Specify the field name of the column.

Returns

Type	Description
System.Threading.Tasks.Task<System.Double>	System.Threading.Tasks.Task.

GetColumnsAsync()

Gets the columns from the Gantt Chart.

Declaration

public Task<List<GanttColumn>> GetColumnsAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<GanttColumn>>	System.Threading.Tasks.Task.

Remarks

Gets the column collections from Gantt Chart with updated properties.

Examples

<button @onclick="ClickHandler">GetColumns</button>
<SfGantt @ref = "gantt" DataSource="@TaskCollection">
    <GanttTaskFields Id = "TaskId" Name="TaskName" StartDate="StartDate" EndDate="EndDate"
        Duration="Duration" Progress="Progress" Child="SubTasks">
    </GanttTaskFields>
</SfGantt>
@code{
private SfGantt<TaskData> gantt;
private async Task ClickHandler()
{
    var columns = await gantt.GetColumnsAsync();
}
}

GetHierarchicalData(Int32)

Method to get hierarchy relation properties of Task based on TaskId.

Declaration

public ExpandoObject GetHierarchicalData(int id)

Parameters

Type	Name	Description
System.Int32	id	Defines the Id of Task

Returns

Type	Description
System.Dynamic.ExpandoObject	System.Dynamic.ExpandoObject.

GetRecordByID(String)

To Get Record by Id.

Declaration

public IDictionary<string, object> GetRecordByID(string id)

Parameters

Type	Name	Description
System.String	id	Specifies the task id.

Returns

Type	Description
System.Collections.Generic.IDictionary<System.String, System.Object>	GetRecordByID.

GetSelectedRecordsAsync()

Gets the collection of selected records.

Declaration

public Task<List<TValue>> GetSelectedRecordsAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<TValue>>	System.Threading.Tasks.Task.

GetSelectedRowIndexesAsync()

Gets the collection of selected row indexes.

Declaration

public Task<List<double>> GetSelectedRowIndexesAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<System.Double>>	System.Threading.Tasks.Task.

HideColumnAsync(String, String)

Hides a column by column name.

Declaration

public Task HideColumnAsync(string key, string hideBy)

Parameters

Type	Name	Description
System.String	key	Specifies the column name.
System.String	hideBy	Specifies the Gantt column Properties like "HeaderText".

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

HideColumnsAsync(String[], String)

Hides columns by column names.

Declaration

public Task HideColumnsAsync(string[] key, string hideBy)

Parameters

Type	Name	Description
System.String[]	key	Specifies the column names.
System.String	hideBy	Specifies the Gantt column Properties like "HeaderText".

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

HideSpinnerAsync()

Method used to hide spinner.

Declaration

public Task HideSpinnerAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

IndentAsync()

To indent the level of selected task to the hierarchical Gantt task.

Declaration

public Task IndentAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

ModelChanged(IDictionary<String, Object>, String)

Declaration

public void ModelChanged(IDictionary<string, object> propertyChanges, string propertyName = null)

Parameters

Type	Name	Description
System.Collections.Generic.IDictionary<System.String, System.Object>	propertyChanges
System.String	propertyName

NextTimeSpan()

To update timeline at end point with one unit.

Declaration

public void NextTimeSpan()

OnAfterRenderAsync(Boolean)

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Type	Name	Description
System.Boolean	firstRender

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

SfDataBoundComponent.OnAfterRenderAsync(Boolean)

OnInitializedAsync()

Declaration

protected override Task OnInitializedAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

SfDataBoundComponent.OnInitializedAsync()

OnInitializedBase()

Receive its initial parameters from its parent in the render tree.

Declaration

protected Task OnInitializedBase()

Returns

Type	Description
System.Threading.Tasks.Task	Task.

OnParametersSetAsync()

Declaration

protected override Task OnParametersSetAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

SfDataBoundComponent.OnParametersSetAsync()

OnParametersSetBase()

Incoming changedValues have been assigned to properties.

Declaration

protected Task OnParametersSetBase()

Returns

Type	Description
System.Threading.Tasks.Task	Task.

OpenAddDialogAsync()

Method to open Add dialog.

Declaration

public Task OpenAddDialogAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

OpenEditDialogAsync(Nullable<Int32>)

Method to open Edit dialog.

Declaration

public Task OpenEditDialogAsync(Nullable<int> TaskID = null)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	TaskID	Defines Task id.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

OutdentAsync()

To outdent the level of selected task from the hierarchical Gantt task.

Declaration

public Task OutdentAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

PreventRender(Boolean)

Prevents the Gantt render. This method will internally sets value to be returned from ShouldRender method.

Declaration

public void PreventRender(bool preventRender = true)

Parameters

Type	Name	Description
System.Boolean	preventRender	Default value is true. Toggles the ShouldRender method value.

PreviousTimeSpan()

To update timeline at start point with one unit.

Declaration

public void PreviousTimeSpan()

RefreshAsync()

Refreshes the gantt chart.

Declaration

public Task RefreshAsync()

Returns

Type	Description
System.Threading.Tasks.Task	void.

RefreshColumnsAsync()

Refreshes the Gantt column changes.

Declaration

public Task RefreshColumnsAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

Remarks

Refreshes the Gantt column with dynamically updated column property value.

Examples

<button @onclick="ClickHandler">RefreshColumns</button>
<SfGantt @ref="gantt" DataSource="@TaskCollection">
    <GanttTaskFields Id = "TaskId" Name="TaskName" StartDate="StartDate" EndDate="EndDate"
        Duration="Duration" Progress="Progress" Child="SubTasks">
    </GanttTaskFields>
       <GanttColumns>
           <GanttColumn Field="TaskId"></GanttColumn>
           <GanttColumn Field="TaskName"></GanttColumn>
       </GanttColumns>
</SfGantt>
@code{
private SfGantt<TaskData> gantt;
private async Task ClickHandler()
{
    gantt.Columns[0].Width = "250";
    gantt.RefreshColumnsAsync();
}
}

See Also

GanttColumn

RemovePredecessor(Int32)

To remove dependency from task.

Declaration

public void RemovePredecessor(int id)

Parameters

Type	Name	Description
System.Int32	id	Defines Task id.

ReorderColumnsAsync(List<String>, String)

Changes the TreeGrid column positions by field names.

Declaration

public Task ReorderColumnsAsync(List<string> fromFName, string toFName)

Parameters

Type	Name	Description
System.Collections.Generic.List<System.String>	fromFName	Specifies the start row index.
System.String	toFName	Specifies the to row index.param>.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

ReorderRowAsync(Double, Double, String)

Reorder the rows based on given indexes and position--add.

Declaration

public Task ReorderRowAsync(double fromIndexes, double toIndex, string position)

Parameters

Type	Name	Description
System.Double	fromIndexes
System.Double	toIndex
System.String	position

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

ScrollIntoViewAsync(Int32, Int32)

Scrolls to specific row or column into view based on row and column index

Declaration

public Task ScrollIntoViewAsync(int columnIndex = -1, int rowIndex = -1)

Parameters

Type	Name	Description
System.Int32	columnIndex	Specifies the column index to scroll horizontally
System.Int32	rowIndex	Specifies the row index to scroll vertically

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task

Remarks

Programmatically scroll to view particular data in grid part of Gantt.

ScrollToTaskbarAsync(Int32)

Scrolls the content to bring the taskbar (specified by task id) visible to the user. Chart is scrolled to bring the taskbar into view port.

Declaration

public Task ScrollToTaskbarAsync(int taskId)

Parameters

Type	Name	Description
System.Int32	taskId	The task id of the record to be visible on the view port.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

Examples

<button @onclick="ScrollToTaskbar">ScrollToTaskbar</button>
<SfGantt @ref = "gantt" DataSource="@TaskCollection">
    <GanttTaskFields Id = "TaskId" Name="TaskName" StartDate="StartDate" EndDate="EndDate"
        Duration="Duration" Progress="Progress" ParentID="ParentId">
    </GanttTaskFields>
</SfGantt>
@code{
private SfGantt<TaskData> gantt;
private async Task ScrollToTaskbar()
{
    await gantt.ScrollToTaskbarAsync(12); /// pass the task id here
}
}

ScrollToTimelineAsync(DateTime)

Scrolls the chart timeline horizontally to a specific date or time.

Declaration

public Task ScrollToTimelineAsync(DateTime scrollDateTime)

Parameters

Type	Name	Description
System.DateTime	scrollDateTime	The DateTime in the timeline to be focused.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

Examples

<button @onclick="ScrollToTimeline">ScrollTimeline</button>
<SfGantt @ref = "gantt" DataSource="@TaskCollection">
    <GanttTaskFields Id = "TaskId" Name="TaskName" StartDate="StartDate" EndDate="EndDate"
        Duration="Duration" Progress="Progress" ParentID="ParentId">
    </GanttTaskFields>
</SfGantt>
@code{
private SfGantt<TaskData> gantt;
private async Task ScrollToTimeline()
{
    await gantt.ScrollToTimelineAsync(new DateTime(2021, 12, 25)); /// pass the date here
}
}

SearchAsync(String)

Searches Gantt records using the given key.

Declaration

public Task SearchAsync(string key)

Parameters

Type	Name	Description
System.String	key	Specifies Search key.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

SelectCellAsync(ValueTuple<Int32, Int32>, Nullable<Boolean>)

Selects a cell by the given index.

Declaration

public Task SelectCellAsync(ValueTuple<int, int> cellIndex, Nullable<bool> isToggle = null)

Parameters

Type	Name	Description
System.ValueTuple<System.Int32, System.Int32>	cellIndex	Specifies cell index to be selected.
System.Nullable<System.Boolean>	isToggle	Specifies isToggle.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

SelectRowAsync(Double, Boolean)

Selects a row by given index.

Declaration

public Task SelectRowAsync(double index, bool isToggle = false)

Parameters

Type	Name	Description
System.Double	index	Specifies row index to be selected.
System.Boolean	isToggle	Specifies isToggle.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

SelectRowsAsync(Double[])

Selects a collection of rows by indexes.

Declaration

public Task SelectRowsAsync(double[] rowIndexes)

Parameters

Type	Name	Description
System.Double[]	rowIndexes	Specifies the indexes of rows to be selected.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

SelectRowsByRangeAsync(Int32, Int32)

Selects a range of rows from start and end row indexes.

Declaration

public Task SelectRowsByRangeAsync(int startIndex, int endIndex)

Parameters

Type	Name	Description
System.Int32	startIndex	Specifies the Row starting index to be selected.
System.Int32	endIndex	Sepcifies the Row ending index to be selected.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

SetSplitterPositionAsync(SplitterView)

Changes the splitter position dynamically based on view property.

Declaration

public Task SetSplitterPositionAsync(SplitterView positionValue)

Parameters

Type	Name	Description
SplitterView	positionValue	Specifies the position value.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

SetSplitterPositionAsync(Int32)

Changes the splitter position dynamically based on columnIndex property.

Declaration

public Task SetSplitterPositionAsync(int positionValue)

Parameters

Type	Name	Description
System.Int32	positionValue	Specifies the position value.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

SetSplitterPositionAsync(String)

Changes the splitter position dynamically based on position property.

Declaration

public Task SetSplitterPositionAsync(string positionValue)

Parameters

Type	Name	Description
System.String	positionValue	Specifies the position value.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

ShouldRender()

Declaration

protected override bool ShouldRender()

Returns

Type	Description
System.Boolean

ShowColumnAsync(String, String)

Shows a column by its column name.

Declaration

public Task ShowColumnAsync(string key, string hideBy)

Parameters

Type	Name	Description
System.String	key	Specifies the column name.
System.String	hideBy	Specifies the Gantt column Properties like "HeaderText".

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

ShowColumnsAsync(String[], String)

Shows columns by its column names.

Declaration

public Task ShowColumnsAsync(string[] key, string hideBy)

Parameters

Type	Name	Description
System.String[]	key	Specifies the column names.
System.String	hideBy	Specifies the Gantt column Properties like "HeaderText".

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

ShowSpinnerAsync()

Method used to show spinner.

Declaration

public Task ShowSpinnerAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

SortByColumnAsync(String, SortDirection, Nullable<Boolean>)

Sorts a column with the given options.

Declaration

public Task SortByColumnAsync(string columnName, SortDirection direction, Nullable<bool> isMultiSort = null)

Parameters

Type	Name	Description
System.String	columnName	Specifies the field name to be sorted.
SortDirection	direction	Sepcifies the sorting direction.
System.Nullable<System.Boolean>	isMultiSort	Specifies the multi sorted whether true or false.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

UpdateChildProperties(String, Object)

Incoming changedValues have been assigned to child properties.

Declaration

public void UpdateChildProperties(string key, object changedValue)

Parameters

Type	Name	Description
System.String	key	Specifies the Key.
System.Object	changedValue	Specifies the changedValue.

UpdatePredecessor(Int32, String)

To modify current dependency values of Task by task id.

Declaration

public void UpdatePredecessor(int id, string predecessorString)

Parameters

Type	Name	Description
System.Int32	id	Specifies the task id.
System.String	predecessorString	Sepcifies the predecessor string.

UpdateProjectDates(Nullable<DateTime>, Nullable<DateTime>)

To validate project start date and end date.

Declaration

public void UpdateProjectDates(Nullable<DateTime> startDate, Nullable<DateTime> endDate)

Parameters

Type	Name	Description
System.Nullable<System.DateTime>	startDate	Specifies the start Date.
System.Nullable<System.DateTime>	endDate	Specifies the end Date.

UpdateRecordByIDAsync(TValue)

To Update Record.

Declaration

public Task UpdateRecordByIDAsync(TValue data)

Parameters

Type	Name	Description
TValue	data	Specifies the task data.

Returns

Type	Description
System.Threading.Tasks.Task	Task.

ZoomInAsync()

Method used to Timeline zoom in .

Declaration

public Task ZoomInAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

ZoomToFitAsync()

Method used to zoom fit to Project in Timeline.

Declaration

public Task ZoomToFitAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

Implements

IGantt

See Also

SfDataManager