menu

Blazor

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GanttTimelineSettings - Blazor API Reference | Syncfusion

    Show / Hide Table of Contents

    Class GanttTimelineSettings

    Configures gantt timeline settings collection.

    Inheritance
    System.Object
    GanttTimelineSettings
    GanttZoomTimelineSettings
    Namespace: Syncfusion.Blazor.Gantt
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class GanttTimelineSettings : ComponentBase

    Constructors

    GanttTimelineSettings()

    Declaration
    public GanttTimelineSettings()

    Properties

    BottomTier

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

    Declaration
    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
    public bool ShowTooltip { get; set; }
    Property Value
    Type Description
    System.Boolean

    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.

    TimelineUnitSize

    Gets or sets the width of timeline cell.

    Declaration
    public int TimelineUnitSize { get; set; }
    Property Value
    Type Description
    System.Int32

    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
    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
    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
    public bool UpdateTimescaleView { get; set; }
    Property Value
    Type Description
    System.Boolean

    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.

    WeekendBackground

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

    Declaration
    public string WeekendBackground { get; set; }
    Property Value
    Type Description
    System.String

    A System.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.

    WeekStartDay

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

    Declaration
    public int WeekStartDay { get; set; }
    Property Value
    Type Description
    System.Int32

    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.

    Methods

    BuildRenderTree(RenderTreeBuilder)

    Declaration
    protected override void BuildRenderTree(RenderTreeBuilder __builder)
    Parameters
    Type Name Description
    Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder

    OnInitializedAsync()

    Declaration
    protected override Task OnInitializedAsync()
    Returns
    Type
    System.Threading.Tasks.Task

    OnParametersSetAsync()

    Declaration
    protected override Task OnParametersSetAsync()
    Returns
    Type
    System.Threading.Tasks.Task

    UpdateChildProperties(String, Object)

    Declaration
    public void UpdateChildProperties(string key, object changedValue)
    Parameters
    Type Name Description
    System.String key
    System.Object changedValue
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved