Class GanttTimelineSettingsBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
GanttTimelineSettingsBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class GanttTimelineSettingsBuilder : ControlBuilder
Constructors
GanttTimelineSettingsBuilder()
Declaration
public GanttTimelineSettingsBuilder()
GanttTimelineSettingsBuilder(GanttTimelineSettings)
Declaration
public GanttTimelineSettingsBuilder(GanttTimelineSettings model)
Parameters
Methods
BottomTier(GanttTimelineTierSettings)
Defines bottom tier settings in timeline.
When timelineViewMode is set to a specific mode (not 'None'), explicit bottomTier settings override the mode's default.
Declaration
public GanttTimelineSettingsBuilder BottomTier(GanttTimelineTierSettings value)
Parameters
Returns
BottomTier(Action<GanttTimelineTierSettingsBuilder>)
Declaration
public GanttTimelineSettingsBuilder BottomTier(Action<GanttTimelineTierSettingsBuilder> bottomTier)
Parameters
Returns
Enables or disables tooltip for timeline cells.
Declaration
public GanttTimelineSettingsBuilder ShowTooltip(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
ShowWeekend(Boolean)
Enables or disables the display of weekend cells in the Gantt Chart timeline.
Weekend days are determined based on the workweek configuration, which defines the working days (e.g., Monday to Friday).
Any day not included in the workweek is treated as a non-working day.
When set to false, non-working days will be hidden from the timeline view.
Declaration
public GanttTimelineSettingsBuilder ShowWeekend(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
TimelineUnitSize(Double)
Defines width of timeline cell.
Declaration
public GanttTimelineSettingsBuilder TimelineUnitSize(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
TimelineViewMode(TimelineViewMode)
Defines timeline mode of Gantt header.
None - Default.
Week - Define the week mode header.
Day - Define the day mode header.
Hour - Define the hour mode header.
Month - Define the month mode header.
Year - Define the year mode header.
Minutes - Define the minutes mode header.
Declaration
public GanttTimelineSettingsBuilder TimelineViewMode(TimelineViewMode value)
Parameters
Returns
TopTier(GanttTimelineTierSettings)
Defines top tier setting in timeline.
When timelineViewMode is set to a specific mode (not 'None'), explicit topTier settings override the mode's default.
Declaration
public GanttTimelineSettingsBuilder TopTier(GanttTimelineTierSettings value)
Parameters
Returns
TopTier(Action<GanttTimelineTierSettingsBuilder>)
Declaration
public GanttTimelineSettingsBuilder TopTier(Action<GanttTimelineTierSettingsBuilder> topTier)
Parameters
Returns
UpdateTimescaleView(Boolean)
Enables or disables timeline auto update on editing action.
Declaration
public GanttTimelineSettingsBuilder UpdateTimescaleView(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
ViewEndDate(String)
Specifies the end date for the visible timeline rendering in the Gantt chart UI.
If no value is provided (auto), the end date is automatically calculated to fill the chart width based on the visible timeline.
If a specific date is provided, the timeline ends at this date and remains fixed.
Declaration
public GanttTimelineSettingsBuilder ViewEndDate(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
ViewStartDate(String)
Specifies the start date for the visible timeline rendering in the Gantt chart UI.
If a specific date is provided, the timeline starts at this date and remains fixed.
Declaration
public GanttTimelineSettingsBuilder ViewStartDate(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
WeekendBackground(String)
Defines the background color for weekend cells when the timeline shows day-level units (i.e., timelineViewMode is 'Day' or 'Week' and bottomTier.unit is 'Day').
Declaration
public GanttTimelineSettingsBuilder WeekendBackground(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
WeekStartDay(Double)
Sets the first day of the week for timeline week calculations and labels.
Accepts values: 0 = Sunday, 1 = Monday, ..., 6 = Saturday.
Declaration
public GanttTimelineSettingsBuilder WeekStartDay(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns