TimelineBuilder
Properties
WriteAction - Func
Methods
EventTemplate(System.String)
Specifies the template used to render the event details.
Parameters
value - System.String
The value for EventTemplate
Example
@(Html.Kendo().Timeline<Event>()
.Name("timeline")
.EventTemplate("#=data.title#")
)
EventTemplateId(System.String)
Specifies the template used to render the event details.
Parameters
templateId - System.String
The ID of the template element for EventTemplate
Example
@(Html.Kendo().Timeline<Event>()
.Name("timeline")
.EventTemplateId("myTemplate")
)
EventTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
Specifies the template used to render the event details.
Parameters
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view which contains the template for EventTemplate
Example
@(Html.Kendo().Timeline<Event>()
.Name("timeline")
.EventTemplateId(Html.Partial("SomePartial"))
)
EventTemplateHandler(System.String)
Specifies the template used to render the event details.
Parameters
templateHandler - System.String
The JavaScript function which contains the template for EventTemplate
Example
@(Html.Kendo().Timeline<Event>()
.Name("timeline")
.EventTemplateHandler("myHandler")
)
EventTemplate(Kendo.Mvc.UI.TemplateBuilder)
Specifies the template used to render the event details.
Parameters
template - TemplateBuilder<TModel>
The Template component which contains the template.
Example
@(Html.Kendo().Timeline<Event>()
.Name("timeline")
.EventTemplate(Html.Kendo().Template()
.AddHtml("<div>Some Content </div>")
)
)
DataSource(System.Action)
Sets the data source configuration of the Timeline.
Parameters
configurator - System.Action<TimelineReadOnlyDataSourceBuilder>
The action that will be used to declare the DataSource.
Example
@(Html.Kendo().Timeline<Event>()
.Name("timeline")
.DataSource(dataSource =>
// configure the data source
dataSource
.Ajax()
.Read(read => read.Action("Events_Read", "Home"))
)
)
DataSource(System.String)
Sets the ID of the DataSource used by the Timeline.
Parameters
dataSourceId - System.String
The DataSource component that will be used to define the DataSource of the Timeline.
Example
@(Html.Kendo().Timeline<Event>()
.Name("timeline")
.DataSource("myDataSource")
)
AutoBind(System.Boolean)
If set to false, the Timeline will not bind to the data source during initialization, i.e. it will not call the fetch method of the dataSource instance. In such scenarios data binding will occur when the change event of the dataSource instance is fired. By default, autoBind is set to true and the widget will bind to the data source specified in the configuration.
Parameters
value - System.Boolean
The value for AutoBind
AlternatingMode(System.Boolean)
Indicates whether events should be positioned on both sides of the timeline axis. By default all events are displayed on the right side of the timeline axis.
Parameters
value - System.Boolean
The value for AlternatingMode
AlternatingMode()
Indicates whether events should be positioned on both sides of the timeline axis. By default all events are displayed on the right side of the timeline axis.
CollapsibleEvents(System.Boolean)
Enables the events in the Kendo UI Timeline to be expandable or collapsible. When enabled initially all events are collapsed.
Parameters
value - System.Boolean
The value for CollapsibleEvents
CollapsibleEvents()
Enables the events in the Kendo UI Timeline to be expandable or collapsible. When enabled initially all events are collapsed.
DataActionsField(System.String)
Sets the field of the data item that provides the actions information for the event.
Parameters
value - System.String
The value for DataActionsField
DataDescriptionField(System.String)
Sets the field of the data item that provides the description information for the event.
Parameters
value - System.String
The value for DataDescriptionField
DataDateField(System.String)
Sets the field of the data item that provides information when the given event happened in time.
Parameters
value - System.String
The value for DataDateField
DataImagesAltField(System.String)
Sets the field of the data item that provides the value for the alt attribute of the images.
Parameters
value - System.String
The value for DataImagesAltField
DataImagesField(System.String)
Sets the field of the data item that provides the images information for the event.
Parameters
value - System.String
The value for DataImagesField
DataSubtitleField(System.String)
Sets the field of the data item that provides the subtitle information for the event.
Parameters
value - System.String
The value for DataSubtitleField
DataTitleField(System.String)
Sets the field of the data item that provides the title information for the event.
Parameters
value - System.String
The value for DataTitleField
DateFormat(System.String)
Sets the date format used to display the date in the event's label
Parameters
value - System.String
The value for DateFormat
EventHeight(System.Double)
Sets specific height for the event in horizontal mode.
Parameters
value - System.Double
The value for EventHeight
EventWidth(System.Double)
Sets specific width for the event in vertical mode.
Parameters
value - System.Double
The value for EventWidth
Navigatable(System.Boolean)
If set to true, will enable the keyboard navigation for the component.
Parameters
value - System.Boolean
The value for Navigatable
Navigatable()
If set to true, will enable the keyboard navigation for the component.
ShowDateLabels(System.Boolean)
If set to false, the event's date label will be hidden.
Parameters
value - System.Boolean
The value for ShowDateLabels
Orientation(Kendo.Mvc.UI.TimelineOrientation)
Defines the orientation of the Timeline widget
Parameters
value - TimelineOrientation
The value for Orientation
Events(System.Action)
Configures the client-side events.
Parameters
configurator - System.Action<TimelineEventBuilder>
The client events action.
Example
@(Html.Kendo().Timeline()
.Name("Timeline")
.Events(events => events
.Change("onChange")
)
)
ToComponent()
Returns the internal view component.
Expression(System.String)
Sets the name of the component.
Parameters
modelExpression - System.String
Explorer(Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer)
Sets the name of the component.
Parameters
modelExplorer - Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer
Name(System.String)
Sets the name of the component.
Parameters
componentName - System.String
The name.
Deferred(System.Boolean)
Suppress initialization script rendering. Note that this options should be used in conjunction with
Parameters
deferred - System.Boolean
HtmlAttributes(System.Object)
Sets the HTML attributes.
Parameters
attributes - System.Object
The HTML attributes.
HtmlAttributes(System.Collections.Generic.IDictionary)
Sets the HTML attributes.
Parameters
attributes - System.Collections.Generic.IDictionary<String,Object>
The HTML attributes.
ScriptAttributes(System.Object,System.Boolean)
Sets the JavaScript attributes to the initialization script.
Parameters
attributes - System.Object
The JavaScript attributes.
overrideAttributes - System.Boolean
Argument which determines whether attributes should be overriden.
ScriptAttributes(System.Collections.Generic.IDictionary,System.Boolean)
Sets the JavaScript attributes to the initialization script.
Parameters
attributes - System.Collections.Generic.IDictionary<String,Object>
The JavaScript attributes.
overrideAttributes - System.Boolean
Argument which determines whether attributes should be overriden.
Render()
Renders the component in place.
ToHtmlString()
WriteTo(System.IO.TextWriter,System.Text.Encodings.Web.HtmlEncoder)
Parameters
writer - System.IO.TextWriter
encoder - System.Text.Encodings.Web.HtmlEncoder
ToClientTemplate()
AsModule(System.Boolean)
Specifies whether the initialization script of the component will be rendered as a JavaScript module.