Class GanttTimelineTierSettings

Configures gantt Timeline tier collection.

Inheritance
object
ComponentBase
OwningComponentBase
SfOwningComponentBase
GanttTimelineTierSettings
GanttBottomTierSettings
GanttTopTierSettings
GanttBottomTierSettings
GanttTopTierSettings
Implements
Inherited Members
Namespace: Syncfusion.Blazor.Gantt
Assembly: Syncfusion.Blazor.dll
Syntax
public class GanttTimelineTierSettings : SfOwningComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Constructors

GanttTimelineTierSettings()

Declaration
public GanttTimelineTierSettings()

Properties

Count

Gets or sets the number of timeline units combined for a single cell.

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

An int that represents the number of timeline units combined for a single cell. The default value is 1.
Remarks

This property allows you to control how many timeline units are combined into a single cell in the timeline view. For example, if Count is set to 2 and the timeline view displays hours, each cell will represent a two-hour period. The default value is 1, which means each cell represents a single timeline unit.

Format

Gets or sets the timeline cell format.

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

A string that represents the timeline cell format. The default value is an empty string.
Remarks

This property allows you to specify the format of the text displayed in the timeline cells. The format is a string that can include a combination of static text and format placeholders. For example, if the timeline displays hours, the format string "h:mm tt" would display the time in a 12-hour clock format with AM or PM. If this property is set to an empty string, the default format for the timeline unit is used.

Formatter

Defines a method to get custom formatted values of timeline cells.

Declaration
[Parameter]
[JsonPropertyName("formatter")]
public dynamic Formatter { get; set; }
Property Value
Type Description
dynamic

This property gets or sets the custom formatter used to get the formatted values of timeline cells. Default value is null.
Remarks

The custom formatter method should accept a single parameter of type dynamic and return a string.

FormatterTemplate

Defines a template for formatting the timeline cells.

Declaration
[Parameter]
[JsonPropertyName("formatterTemplate")]
[JsonIgnore]
public RenderFragment<GanttTimelineFormatter> FormatterTemplate { get; set; }
Property Value
Type Description
RenderFragment<GanttTimelineFormatter>

This property gets or sets the template for formatting the timeline cells. Default value is null.
Remarks

The RenderFragment type allows you to define a template that can be used to format the timeline cells. The template should accept a single parameter of type GanttTimelineFormatter and return a RenderFragment.

Unit

Defines the timeline mode.

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

This property gets or sets the timeline mode. Default value is TimelineViewMode.Day.
Remarks

The TimelineViewMode enum determines the type of time unit per cell. The available options are Day, Week, Month, Year.

tier

Gets or sets the current tier value used for rendering timeline headers in the Gantt chart.

Declaration
protected string tier { get; set; }
Property Value
Type
string

Methods

OnInitializedAsync()

Receive its initial parameters from its parent in the render tree.

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
Task

Task.
Overrides

OnParametersSetAsync()

Incoming values have been assigned to properties.

Declaration
protected override Task OnParametersSetAsync()
Returns
Type
Task
Overrides

Implements