Class GanttTimelineSettings

Inheritance

System.Object

Syncfusion.EJ2.EJTagHelper

GanttTimelineSettings

Namespace: Syncfusion.EJ2.Gantt

Assembly: Syncfusion.EJ2.dll

Syntax

public class GanttTimelineSettings : EJTagHelper

Constructors

GanttTimelineSettings()

Declaration

public GanttTimelineSettings()

Properties

BottomTier

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 GanttTimelineTierSettings BottomTier { get; set; }

Property Value

Type	Description
GanttTimelineTierSettings	The default value is null

ContentTemplate

To get or set value for ContentTemplate.

Declaration

public MvcTemplate<object> ContentTemplate { get; set; }

Property Value

Type
Syncfusion.EJ2.MvcTemplate<System.Object>

ShowTooltip

Enables or disables tooltip for timeline cells.

Declaration

public bool ShowTooltip { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

ShowWeekend

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 bool ShowWeekend { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

TimelineUnitSize

Defines width of timeline cell.

Declaration

public double TimelineUnitSize { get; set; }

Property Value

Type	Description
System.Double	The default value is 33

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 TimelineViewMode TimelineViewMode { get; set; }

Property Value

Type	Description
TimelineViewMode	The default value is TimelineViewMode.None

TopTier

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 GanttTimelineTierSettings TopTier { get; set; }

Property Value

Type	Description
GanttTimelineTierSettings	The default value is null

UpdateTimescaleView

Enables or disables timeline auto update on editing action.

Declaration

public bool UpdateTimescaleView { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

ViewEndDate

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 string ViewEndDate { get; set; }

Property Value

Type	Description
System.String	The default value is "auto"

ViewStartDate

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 string ViewStartDate { get; set; }

Property Value

Type	Description
System.String	The default value is "auto"

WeekendBackground

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 string WeekendBackground { get; set; }

Property Value

Type	Description
System.String	The default value is null

WeekStartDay

Sets the first day of the week for timeline week calculations and labels. Accepts values: 0 = Sunday, 1 = Monday, ..., 6 = Saturday.

Declaration

public double WeekStartDay { get; set; }

Property Value

Type	Description
System.Double	The default value is 0