Class GanttTimelineSettings

Configures gantt timeline settings collection.

Inheritance
object
ComponentBase
GanttTimelineSettings
GanttZoomTimelineSettings
Implements
Inherited Members
Namespace: Syncfusion.Blazor.Gantt
Assembly: Syncfusion.Blazor.Gantt.dll
Syntax
public class GanttTimelineSettings : ComponentBase, IComponent, IHandleEvent, IHandleAfterRender

Constructors

GanttTimelineSettings()

Declaration
public GanttTimelineSettings()

Properties

BottomTier

Gets or sets the settings for the bottom tier timeline of the gantt chart component.

Declaration
[Parameter]
public GanttTimelineTierSettings BottomTier { get; set; }
Property Value
Type Description
GanttTimelineTierSettings

A GanttTimelineTierSettings object representing the settings for the bottom timeline tier of the gantt chart component.
Remarks

This property allows to customize the appearance and behavior of the bottom timeline tier of the gantt chart component. If this property is not set, the default settings for the bottom timeline tier will be used.

ShowTooltip

Gets or sets a value indicating whether to show tooltip when hover the timeline cells in Gantt chart header.

Declaration
[Parameter]
public bool ShowTooltip { get; set; }
Property Value
Type Description
bool

true, to show tooltips for the timeline cells in header; otherwise, false. The default value is true.
Remarks

Set this parameter to true to show a tooltip when the user hovers over the timeline cells in the gantt chart component.

ShowWeekend

Gets or sets a value indicating whether weekend and non-working dates are displayed in the timeline.

Declaration
[Parameter]
public bool ShowWeekend { get; set; }
Property Value
Type Description
bool

true to display weekend and non-working dates in the timeline; otherwise, false. The default value is true.
Remarks

This property controls the visibility of weekend and non-working dates in the Gantt chart timeline. When set to false, weekends and other configured non-working days are excluded from the timeline view, allowing the chart to display only working days based on the defined working calendar and schedule.

TimelineUnitSize

Gets or sets the width of timeline cell.

Declaration
[Parameter]
public int TimelineUnitSize { get; set; }
Property Value
Type Description
int

The width of the timeline cell or unit.
Remarks

This parameter represents the width, in pixels, of a single cell on a timeline. This value is used to calculate the width of the cell on the timeline. The default value is 33.

TimelineViewMode

Gets or sets the timeline mode of Gantt chart header for the timeline view.

Declaration
[Parameter]
public TimelineViewMode TimelineViewMode { get; set; }
Property Value
Type Description
TimelineViewMode

The mode for the timeline view. The default value is TimelineViewMode.None.
Remarks

The timeline view mode determines how the timeline is displayed to the user. Possible values are TimelineViewMode.None, TimelineViewMode.Day, TimelineViewMode.Week, TimelineViewMode.Month, and TimelineViewMode.Year.

TopTier

Gets or sets the settings for the top tier of the gantt chart timeline.

Declaration
[Parameter]
public GanttTimelineTierSettings TopTier { get; set; }
Property Value
Type Description
GanttTimelineTierSettings

A GanttTimelineTierSettings object representing the settings for the top timeline tier of the gantt chart component.
Remarks

This property specifies the settings for the top timeline tier. You can customize the appearance and behavior of the timeline tier by setting the properties of the GanttTimelineTierSettings object.

UpdateTimescaleView

Gets or sets a value indicating whether the timescale view should be auto updated on editing action.

Declaration
[Parameter]
public bool UpdateTimescaleView { get; set; }
Property Value
Type Description
bool

true if the timescale view should be updated; otherwise, false. The default value is true.
Remarks

When set to true, the timescale view will be updated. When set to false, the timescale view will not be updated.

ViewEndDate

Gets or sets the end date of the visible timeline range in the Gantt chart.

Declaration
[Parameter]
public DateTime? ViewEndDate { get; set; }
Property Value
Type Description
DateTime?

A DateTime value that specifies the end date of the timeline view. The default value is null.
Remarks

This property defines the end of the visible timeline range displayed in the Gantt chart. When set to null, the timeline end date is automatically determined based on the ProjectEndDate value. If ProjectEndDate is also null, the timeline end date is calculated from the latest task end date available in the task collection. This property affects only the visible timeline range and does not modify task dates, dependencies, baselines, critical path calculations, or scheduling behavior. Use ViewStartDate to define the start date of the visible timeline range.

ViewStartDate

Gets or sets the start date of the visible timeline range in the Gantt chart.

Declaration
[Parameter]
public DateTime? ViewStartDate { get; set; }
Property Value
Type Description
DateTime?

A DateTime value that specifies the start date of the timeline view. The default value is null.
Remarks

This property defines the beginning of the visible timeline range displayed in the Gantt chart. When set to null, the timeline start date is automatically determined based on the ProjectStartDate value. If ProjectStartDate is also null, the timeline start date is calculated from the earliest task start date available in the task collection. This property affects only the visible timeline range and does not modify task dates, dependencies, baselines, critical path calculations, or scheduling behavior. Use ViewEndDate to define the end date of the visible timeline range.

WeekStartDay

Gets or sets the day of the week that the timeline view starts on.

Declaration
[Parameter]
public int WeekStartDay { get; set; }
Property Value
Type Description
int

The day of the week that the timeline view starts on. The default value is 0, which represents Sunday.
Remarks

This property determines which day of the week the timeline view starts on. The value should be an integer between 0 and 6, where 0 represents Sunday, 1 represents Monday, and so on.

WeekendBackground

Gets or sets the background color of weekend cell in week - day timeline mode.

Declaration
[Parameter]
public string? WeekendBackground { get; set; }
Property Value
Type Description
string

A string representing the color of the background for the weekend cell in the week - day timeline mode.
Remarks

This property can be set to any valid CSS color value, such as a color name (e.g. "red"), a hex value (e.g. "#FF0000"), or an RGB value (e.g. "rgb(255, 0, 0)"). If this property is set to null, the default background color for the weekend days will be used.

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
RenderTreeBuilder __builder
Overrides

OnInitializedAsync()

Triggers during the initial rendering of the component.

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
Task

A Task representing the asynchronous operation.
Overrides

OnParametersSetAsync()

Called by the framework when component parameters have been set. Executes logic that depends on the updated parameter values.

Declaration
protected override Task OnParametersSetAsync()
Returns
Type
Task
Overrides

Implements