ClassTelerikGantt<TItem>
The class for the Telerik Gantt component.
Definition
Namespace:Telerik.Blazor.Components
Assembly:Telerik.Blazor.dll
Type Parameters:
TItem
Syntax:
public class TelerikGantt<TItem> : BaseComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable
Inheritance: objectComponentBaseBaseComponentTelerikGantt<TItem>
Implements:
Inherited Members
Constructors
TelerikGantt()
Declaration
public TelerikGantt()
Properties
ColumnReorderable
Defines whether the columns of the TreeList can be reordered.
Declaration
[Parameter]
public bool ColumnReorderable { get; set; }
Property Value
ColumnResizable
Defines whether the columns of the TreeList can be resized.
Declaration
[Parameter]
public bool ColumnResizable { get; set; }
Property Value
ConvertedTreeListEditMode
Declaration
protected TreeListEditMode ConvertedTreeListEditMode { get; }
Property Value
Data
Defines the data source of the Gantt.
Declaration
[Parameter]
public IEnumerable<TItem> Data { get; set; }
Property Value
IEnumerable<TItem>
DependenciesSettings
Declaration
public GanttDependencies DependenciesSettings { get; set; }
Property Value
DependencyElements
Declaration
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
[Parameter]
public bool EnableLoaderContainer { get; set; }
Property Value
EndField
Defines the EndField of the Data. Default value: "End".
Declaration
[Parameter]
public string EndField { get; set; }
Property Value
FilterMenuType
Defines the filter menu type when "FilterMode" is set to "FilterMenu".
Declaration
[Parameter]
public FilterMenuType FilterMenuType { get; set; }
Property Value
FilterMenuType
FilterMode
Defines the Filter Mode of the Component.
Declaration
[Parameter]
public GanttFilterMode FilterMode { get; set; }
Property Value
FilterRowDebounceDelay
Time in ms between the last typed symbol and the firing of the internal filter oninput event. Default is 150ms.
Declaration
[Parameter]
public int FilterRowDebounceDelay { get; set; }
Property Value
GanttSettings
Defines the container for the Gantt Settings such as GanttPopupEditSettings.
Declaration
[Parameter]
public RenderFragment GanttSettings { get; set; }
Property Value
GanttViews
Defines the container for the Gantt views.
Declaration
[Parameter]
public RenderFragment GanttViews { get; set; }
Property Value
HasChildrenField
Defines the HasChildren DataField of the DataSource.
Declaration
[Parameter]
public string HasChildrenField { get; set; }
Property Value
Height
Defines the height of the Gantt.
IdField
Defines the Id DataField of the DataSource.
ItemsField
Defines the Items DataField of the DataSource that contains the child nodes.
Declaration
[Parameter]
public string ItemsField { get; set; }
Property Value
Navigable
Defines whether the Component is navigable using the keyboard.
OnAdd
Fires when an item is about to be inserted.
Declaration
[Parameter]
public EventCallback<GanttAddEventArgs> OnAdd { get; set; }
Property Value
OnCollapse
Fires when a row is collapsed.
Declaration
[Parameter]
public EventCallback<GanttCollapseEventArgs> OnCollapse { get; set; }
Property Value
OnCreate
Fires when an item is created.
Declaration
[Parameter]
public EventCallback<GanttCreateEventArgs> OnCreate { get; set; }
Property Value
OnDelete
Fires when a task is deleted.
Declaration
[Parameter]
public EventCallback<GanttDeleteEventArgs> OnDelete { get; set; }
Property Value
OnEdit
Fires when an item is about to be edited.
Declaration
[Parameter]
public EventCallback<GanttEditEventArgs> OnEdit { get; set; }
Property Value
OnExpand
Fires when a row is expanded.
Declaration
[Parameter]
public EventCallback<GanttExpandEventArgs> OnExpand { get; set; }
Property Value
OnStateChanged
Fires on user interaction that causes changes in the GanttState<TItem>.
Declaration
[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
[Parameter]
public EventCallback<GanttStateEventArgs<TItem>> OnStateInit { get; set; }
Property Value
EventCallback<GanttStateEventArgs<TItem>>
OnUpdate
Fires when the Update command is executed.
Declaration
[Parameter]
public EventCallback<GanttUpdateEventArgs> OnUpdate { get; set; }
Property Value
ParentIdField
Defines the ParentId DataField of the DataSource.
Declaration
[Parameter]
public string ParentIdField { get; set; }
Property Value
PercentCompleteField
Defines the PercentCompleteField of the Data. Default value: "PercentComplete".
Declaration
[Parameter]
public string PercentCompleteField { get; set; }
Property Value
RangeSnapTo
Determines what the Gantt range calculation is based on.
Declaration
[Parameter]
public GanttRangeSnapTo RangeSnapTo { get; set; }
Property Value
RowHeight
Defines the height of each row in the Gantt. Accepts a number and is applied as pixels.
Declaration
[Parameter]
public decimal RowHeight { get; set; }
Property Value
SelectedView
Declaration
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
[Parameter]
public bool ShowColumnMenu { get; set; }
Property Value
ShowTooltip
Defines whether a task tooltip is visible for the tasks in the Timeline.
SortMode
Defines the sort mode.
Declaration
[Parameter]
public SortMode SortMode { get; set; }
Property Value
Sortable
Defines whether the Component is sortable.
StartField
Defines the StartField of the Data. Default value: "Start".
Declaration
[Parameter]
public string StartField { get; set; }
Property Value
TaskElements
Declaration
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
[Parameter]
public RenderFragment<TItem> TaskTemplate { get; set; }
Property Value
RenderFragment<TItem>
TitleField
Defines the TitleField of the Data. Default value: "Title".
Declaration
[Parameter]
public string TitleField { get; set; }
Property Value
TooltipTemplate
Specifies the template for the content of the task tooltip. The @context of the template contains the model associated with the item.
Declaration
[Parameter]
public RenderFragment<object> TooltipTemplate { get; set; }
Property Value
TreeListEditMode
Defines the EditMode of the TreeList section. Supports None, Inline, Popup and Incell editing. The Default Option is Incell.
Declaration
[Parameter]
public GanttTreeListEditMode TreeListEditMode { get; set; }
Property Value
TreeListFilterMode
Declaration
protected TreeListFilterMode TreeListFilterMode { get; }
Property Value
TreeListWidth
Specifies the width of the TreeList panel in pixels or percentages.
Declaration
[Parameter]
public string TreeListWidth { get; set; }
Property Value
TreeListWidthChanged
Triggers when TreeList width has changed.
Declaration
[Parameter]
public EventCallback<string> TreeListWidthChanged { get; set; }
Property Value
View
The currently selected view of the Gantt. Determines the layout of the timeline view.
Declaration
[Parameter]
public GanttView View { get; set; }
Property Value
ViewChanged
The handler that will be called when the currently selected view is changed.
Declaration
[Parameter]
public EventCallback<GanttView> ViewChanged { get; set; }
Property Value
Methods
BuildRenderTree(RenderTreeBuilder)
Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
__builder
Overrides
Dispose()
Declaration
public override void Dispose()
Overrides
GetState()
Gets the current state of the Gantt. Includes sorting, filtering, edit items, column state, etc.
Declaration
public GanttState<TItem> GetState()
Returns
GanttState<TItem>
Instance of a GanttState<TItem> class that contains all data.
GetWidgetOptions()
Declaration
protected virtual Dictionary<string, object> GetWidgetOptions()
Returns
NavigateToTreeList(TaskElement)
Declaration
protected Task NavigateToTreeList(TaskElement item)
Parameters
item
TaskElement
Returns
NavigateToView(GanttView)
Declaration
protected void NavigateToView(GanttView view)
Parameters
view
Rebind()
Processes the available data with applied all data operations. Useful in scenarios where the data might change from an outside source.
Declaration
public void Rebind()
RefreshTimeLine()
Declaration
protected void RefreshTimeLine()
RefreshTreeList()
Declaration
protected void RefreshTreeList()
SetStateAsync(GanttState<TItem>)
Sets the state of the Gantt. Includes sorting, filtering, edit items, column state, etc.
Declaration
public Task SetStateAsync(GanttState<TItem> state)
Parameters
state
GanttState<TItem>
Returns