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

Syncfusion.Blazor.SfBaseComponent

SfDataBoundComponent

SfGantt<TValue>

Implements

IGantt

Inherited Members

SfDataBoundComponent.SetDataManager<T>(Object)

SfDataBoundComponent.DataManager

SfDataBoundComponent.MainParent

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

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>

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

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

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

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.

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

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

CancelEdit()

Cancels edited state.

Declaration

public void CancelEdit()

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.

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.

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.

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.

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.

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.

PreviousTimeSpan()

To update timeline at start point with one unit.

Declaration

public void PreviousTimeSpan()

RemovePredecessor(Int32)

To remove dependency from task.

Declaration

public void RemovePredecessor(int id)

Parameters

Type	Name	Description
System.Int32	id	Defines Task id.

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.

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.

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>, Boolean, String)

To validate project start date and end date.

Declaration

public void UpdateProjectDates(Nullable<DateTime> startDate, Nullable<DateTime> endDate, bool isTimelineRoundOff, string isFrom = null)

Parameters

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

Implements

IGantt

See Also

SfDataManager