Class
TelerikGantt<TItem>

The class for the Telerik Gantt component.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Type Parameters:

TItem

Syntax:

cs-api-definition
public class TelerikGantt<TItem> : BaseComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseBaseComponentTelerikGantt<TItem>

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

Inherited Members BaseComponent.ShouldRender()BaseComponent.OnInitializedAsync()BaseComponent.InitLocalizer()BaseComponent.ThrowIfParameterIsNull(object, string)BaseComponent.HaveOptionsChanged(IDictionary<string, object>, IDictionary<string, object>)BaseComponent.GetClassString(params string[])BaseComponent.InvokeAsync<T>(string, params object[])BaseComponent.InvokeAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidAsync(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidComponentMethodAsync(string, params object[])BaseComponent.InvokeComponentVoidMethodAsync(string, object)BaseComponent.InvokeDisposeAsync()BaseComponent.StateHasChanged()BaseComponent.RootComponentBaseComponent.ClassComponentBase.OnInitialized()ComponentBase.OnParametersSet()ComponentBase.OnParametersSetAsync()ComponentBase.OnAfterRender(bool)ComponentBase.InvokeAsync(Action)ComponentBase.InvokeAsync(Func<Task>)ComponentBase.SetParametersAsync(ParameterView)

Constructors

TelerikGantt()

Declaration

cs-api-definition
public TelerikGantt()

Properties

AutoGenerateColumns

Declaration

cs-api-definition
public bool AutoGenerateColumns { get; }

Property Value

bool

ColumnReorderable

Defines whether the columns of the TreeList can be reordered.

Declaration

cs-api-definition
[Parameter]
public bool ColumnReorderable { get; set; }

Property Value

bool

ColumnResizable

Defines whether the columns of the TreeList can be resized.

Declaration

cs-api-definition
[Parameter]
public bool ColumnResizable { get; set; }

Property Value

bool

ConvertedTreeListEditMode

Declaration

cs-api-definition
protected TreeListEditMode ConvertedTreeListEditMode { get; }

Property Value

TreeListEditMode

Data

Defines the data source of the Gantt.

Declaration

cs-api-definition
[Parameter]
public IEnumerable<TItem> Data { get; set; }

Property Value

IEnumerable<TItem>

DependenciesSettings

Declaration

cs-api-definition
public GanttDependencies DependenciesSettings { get; set; }

Property Value

GanttDependencies

DependencyElements

Declaration

cs-api-definition
public List<DependencyElement> DependencyElements { get; set; }

Property Value

List<DependencyElement>

EnableLoaderContainer

Defines if a loading indicator displays in the TreeList during long-running operations. The default value is true. The setting has no effect on initial data load.

Declaration

cs-api-definition
[Parameter]
public bool EnableLoaderContainer { get; set; }

Property Value

bool

EndField

Defines the EndField of the Data. Default value: "End".

Declaration

cs-api-definition
[Parameter]
public string EndField { get; set; }

Property Value

string

FilterMenuType

Defines the filter menu type when "FilterMode" is set to "FilterMenu".

Declaration

cs-api-definition
[Parameter]
public FilterMenuType FilterMenuType { get; set; }

Property Value

FilterMenuType

FilterMode

Defines the Filter Mode of the Component.

Declaration

cs-api-definition
[Parameter]
public GanttFilterMode FilterMode { get; set; }

Property Value

GanttFilterMode

FilterRowDebounceDelay

Time in ms between the last typed symbol and the firing of the internal filter oninput event. Default is 150ms.

Declaration

cs-api-definition
[Parameter]
public int FilterRowDebounceDelay { get; set; }

Property Value

int

GanttSettings

Defines the container for the Gantt Settings such as GanttPopupEditSettings.

Declaration

cs-api-definition
[Parameter]
public RenderFragment GanttSettings { get; set; }

Property Value

RenderFragment

GanttViews

Defines the container for the Gantt views.

Declaration

cs-api-definition
[Parameter]
public RenderFragment GanttViews { get; set; }

Property Value

RenderFragment

HasChildrenField

Defines the HasChildren DataField of the DataSource.

Declaration

cs-api-definition
[Parameter]
public string HasChildrenField { get; set; }

Property Value

string

Height

Defines the height of the Gantt.

Declaration

cs-api-definition
[Parameter]
public string Height { get; set; }

Property Value

string

IdField

Defines the Id DataField of the DataSource.

Declaration

cs-api-definition
[Parameter]
public string IdField { get; set; }

Property Value

string

ItemsField

Defines the Items DataField of the DataSource that contains the child nodes.

Declaration

cs-api-definition
[Parameter]
public string ItemsField { get; set; }

Property Value

string

Navigable

Defines whether the Component is navigable using the keyboard.

Declaration

cs-api-definition
[Parameter]
public bool Navigable { get; set; }

Property Value

bool

OnAdd

Fires when an item is about to be inserted.

Declaration

cs-api-definition
[Parameter]
public EventCallback<GanttAddEventArgs> OnAdd { get; set; }

Property Value

EventCallback<GanttAddEventArgs>

OnCollapse

Fires when a row is collapsed.

Declaration

cs-api-definition
[Parameter]
public EventCallback<GanttCollapseEventArgs> OnCollapse { get; set; }

Property Value

EventCallback<GanttCollapseEventArgs>

OnCreate

Fires when an item is created.

Declaration

cs-api-definition
[Parameter]
public EventCallback<GanttCreateEventArgs> OnCreate { get; set; }

Property Value

EventCallback<GanttCreateEventArgs>

OnDelete

Fires when a task is deleted.

Declaration

cs-api-definition
[Parameter]
public EventCallback<GanttDeleteEventArgs> OnDelete { get; set; }

Property Value

EventCallback<GanttDeleteEventArgs>

OnEdit

Fires when an item is about to be edited.

Declaration

cs-api-definition
[Parameter]
public EventCallback<GanttEditEventArgs> OnEdit { get; set; }

Property Value

EventCallback<GanttEditEventArgs>

OnExpand

Fires when a row is expanded.

Declaration

cs-api-definition
[Parameter]
public EventCallback<GanttExpandEventArgs> OnExpand { get; set; }

Property Value

EventCallback<GanttExpandEventArgs>

OnStateChanged

Fires on user interaction that causes changes in the GanttState<TItem>.

Declaration

cs-api-definition
[Parameter]
public EventCallback<GanttStateEventArgs<TItem>> OnStateChanged { get; set; }

Property Value

EventCallback<GanttStateEventArgs<TItem>>

OnStateInit

Invoked when the Gantt is initializing for the first time and before its initial render. Hook to this event if you would like to provide an initial state through the State field of its event arguments.

Declaration

cs-api-definition
[Parameter]
public EventCallback<GanttStateEventArgs<TItem>> OnStateInit { get; set; }

Property Value

EventCallback<GanttStateEventArgs<TItem>>

OnUpdate

Fires when the Update command is executed.

Declaration

cs-api-definition
[Parameter]
public EventCallback<GanttUpdateEventArgs> OnUpdate { get; set; }

Property Value

EventCallback<GanttUpdateEventArgs>

ParentIdField

Defines the ParentId DataField of the DataSource.

Declaration

cs-api-definition
[Parameter]
public string ParentIdField { get; set; }

Property Value

string

PercentCompleteField

Defines the PercentCompleteField of the Data. Default value: "PercentComplete".

Declaration

cs-api-definition
[Parameter]
public string PercentCompleteField { get; set; }

Property Value

string

RangeSnapTo

Determines what the Gantt range calculation is based on.

Declaration

cs-api-definition
[Parameter]
public GanttRangeSnapTo RangeSnapTo { get; set; }

Property Value

GanttRangeSnapTo

RowHeight

Defines the height of each row in the Gantt. Accepts a number and is applied as pixels.

Declaration

cs-api-definition
[Parameter]
public decimal RowHeight { get; set; }

Property Value

decimal

SelectedView

Declaration

cs-api-definition
public IGanttView SelectedView { get; }

Property Value

IGanttView

ShowColumnMenu

Specifies if header cells will render a button to display a column menu. Use ShowColumnMenu to disable the menu at column level.

Declaration

cs-api-definition
[Parameter]
public bool ShowColumnMenu { get; set; }

Property Value

bool

ShowTooltip

Defines whether a task tooltip is visible for the tasks in the Timeline.

Declaration

cs-api-definition
[Parameter]
public bool ShowTooltip { get; set; }

Property Value

bool

SortMode

Defines the sort mode.

Declaration

cs-api-definition
[Parameter]
public SortMode SortMode { get; set; }

Property Value

SortMode

Sortable

Defines whether the Component is sortable.

Declaration

cs-api-definition
[Parameter]
public bool Sortable { get; set; }

Property Value

bool

StartField

Defines the StartField of the Data. Default value: "Start".

Declaration

cs-api-definition
[Parameter]
public string StartField { get; set; }

Property Value

string

TaskElements

Declaration

cs-api-definition
public List<TaskElement> TaskElements { get; set; }

Property Value

List<TaskElement>

TaskTemplate

Defines the Template that will be used to render items in the timeline view.

Declaration

cs-api-definition
[Parameter]
public RenderFragment<TItem> TaskTemplate { get; set; }

Property Value

RenderFragment<TItem>

TitleField

Defines the TitleField of the Data. Default value: "Title".

Declaration

cs-api-definition
[Parameter]
public string TitleField { get; set; }

Property Value

string

TooltipTemplate

Specifies the template for the content of the task tooltip. The @context of the template contains the model associated with the item.

Declaration

cs-api-definition
[Parameter]
public RenderFragment<object> TooltipTemplate { get; set; }

Property Value

RenderFragment<object>

TreeListEditMode

Defines the EditMode of the TreeList section. Supports None, Inline, Popup and Incell editing. The Default Option is Incell.

Declaration

cs-api-definition
[Parameter]
public GanttTreeListEditMode TreeListEditMode { get; set; }

Property Value

GanttTreeListEditMode

TreeListFilterMode

Declaration

cs-api-definition
protected TreeListFilterMode TreeListFilterMode { get; }

Property Value

TreeListFilterMode

TreeListWidth

Specifies the width of the TreeList panel in pixels or percentages.

Declaration

cs-api-definition
[Parameter]
public string TreeListWidth { get; set; }

Property Value

string

TreeListWidthChanged

Triggers when TreeList width has changed.

Declaration

cs-api-definition
[Parameter]
public EventCallback<string> TreeListWidthChanged { get; set; }

Property Value

EventCallback<string>

View

The currently selected view of the Gantt. Determines the layout of the timeline view.

Declaration

cs-api-definition
[Parameter]
public GanttView View { get; set; }

Property Value

GanttView

ViewChanged

The handler that will be called when the currently selected view is changed.

Declaration

cs-api-definition
[Parameter]
public EventCallback<GanttView> ViewChanged { get; set; }

Property Value

EventCallback<GanttView>

Width

Defines the width of the Gantt.

Declaration

cs-api-definition
[Parameter]
public string Width { get; set; }

Property Value

string

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

cs-api-definition
protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder

RenderTreeBuilder

Overrides ComponentBase.BuildRenderTree(RenderTreeBuilder)

Dispose()

Declaration

cs-api-definition
public override void Dispose()

Overrides BaseComponent.Dispose()

GetState()

Gets the current state of the Gantt. Includes sorting, filtering, edit items, column state, etc.

Declaration

cs-api-definition
public GanttState<TItem> GetState()

Returns

GanttState<TItem>

Instance of a GanttState<TItem> class that contains all data.

GetWidgetOptions()

Declaration

cs-api-definition
protected virtual Dictionary<string, object> GetWidgetOptions()

Returns

Dictionary<string, object>

NavigateToTreeList(TaskElement)

Declaration

cs-api-definition
protected Task NavigateToTreeList(TaskElement item)

Parameters

item

TaskElement

Returns

Task

NavigateToView(GanttView)

Declaration

cs-api-definition
protected void NavigateToView(GanttView view)

Parameters

view

GanttView

OnAfterRenderAsync(bool)

Declaration

cs-api-definition
protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

firstRender

bool

Returns

Task

Overrides BaseComponent.OnAfterRenderAsync(bool)

Rebind()

Processes the available data with applied all data operations. Useful in scenarios where the data might change from an outside source.

Declaration

cs-api-definition
public void Rebind()

RefreshTimeLine()

Declaration

cs-api-definition
protected void RefreshTimeLine()

RefreshTreeList()

Declaration

cs-api-definition
protected void RefreshTreeList()

SetStateAsync(GanttState<TItem>)

Sets the state of the Gantt. Includes sorting, filtering, edit items, column state, etc.

Declaration

cs-api-definition
public Task SetStateAsync(GanttState<TItem> state)

Parameters

state

GanttState<TItem>

Returns

Task