OrgChartBuilder
Properties
WriteAction - Func
Methods
CardsColors(System.String[])
Defines the colors that will be shown in the cards.
Parameters
value - System.String[]
A collection of card colors.
Example
@(Html.Kendo().OrgChart<EmployeeViewModel>()
.Name("orgchart")
.CardsColors(new string[] {"pink", "blue", "orange"})
)
DataSource(System.Action)
Configures the DataSource that will render the OrgChart items.
Parameters
configurator - System.Action<OrgChartAjaxDataSourceBuilder>
Example
@(Html.Kendo().OrgChart<EmployeeViewModel>()
.Name("orgchart")
.DataSource(dataSource => dataSource
.Read(r => r.Action("Read", "Home"))
)
)
DataSource(System.String)
Sets an external DataSource instance as a DataSource of the OrgChart.
Parameters
dataSourceId - System.String
The id of the data source instance.
Example
@(Html.Kendo().DataSource<EmployeeViewModel>()
.Name("dataSource1")
...
)
@(Html.Kendo().OrgChart<EmployeeViewModel>()
.Name("orgchart")
.DataSource("dataSource1")
)
BindTo(System.Collections.IEnumerable)
Binds the OrgChart to an IEnumerable collection.
Parameters
data - System.Collections.IEnumerable
The data collection.
Example
@(Html.Kendo().OrgChart<EmployeeViewModel>()
.Name("orgchart")
.BindTo((IEnumerable)ViewData["Employees"])
)
BindTo(System.Collections.Generic.IEnumerable)
Binds the OrgChart to an IEnumerable collection.
Parameters
data - System.Collections.Generic.IEnumerable<T>
The data collection.
Example
@(Html.Kendo().OrgChart<EmployeeViewModel>()
.Name("orgchart")
.BindTo((IEnumerable<EmployeeViewModel>) ViewData["Employees"])
)
Editable(System.Action)
If set to false, the user will not be able to edit the data to which the OrgChart is bound. By default, editing is enabled.The editable option can also be set to a JavaScript object (which represents the editing configuration).
Parameters
configurator - System.Action<OrgChartEditableSettingsBuilder>
The configurator for the editable setting.
Editable(System.Boolean)
If set to false, the user will not be able to edit the data to which the OrgChart is bound. By default, editing is enabled.The editable option can also be set to a JavaScript object (which represents the editing configuration).
Parameters
enabled - System.Boolean
Enables or disables the editable option.
GroupField(System.String)
Specifies the field the nodes should be grouped by. If any value is passed, the OrgChart uses its grouping rendering mode.
Parameters
value - System.String
The value for GroupField
GroupHeaderTemplate(System.String)
Provides an option to customize the default template for the group label (using the field value and name by default).
Parameters
value - System.String
The value for GroupHeaderTemplate
GroupHeaderTemplateId(System.String)
Provides an option to customize the default template for the group label (using the field value and name by default).
Parameters
templateId - System.String
The ID of the template element for GroupHeaderTemplate
GroupHeaderTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
Provides an option to customize the default template for the group label (using the field value and name by default).
Parameters
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view that contains the template for GroupHeaderTemplate
GroupHeaderTemplateHandler(System.String)
Provides an option to customize the default template for the group label (using the field value and name by default).
Parameters
templateHandler - System.String
The handler that returs the template for GroupHeaderTemplate
GroupHeaderTemplate(Kendo.Mvc.UI.TemplateBuilder)
Provides an option to customize the default template for the group label (using the field value and name by default).
Parameters
template - TemplateBuilder<TModel>
A Template component that configures the groupheadertemplate.
Messages(System.Action)
Provides configuration options for the messages present in the OrgChart widget.
Parameters
configurator - System.Action<OrgChartMessagesSettingsBuilder>
The configurator for the messages setting.
Template(System.String)
Defines a node card template.
Parameters
value - System.String
The value for Template
TemplateId(System.String)
Defines a node card template.
Parameters
templateId - System.String
The ID of the template element for Template
TemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
Defines a node card template.
Parameters
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view that contains the template for Template
TemplateHandler(System.String)
Defines a node card template.
Parameters
templateHandler - System.String
The handler that returs the template for Template
Template(Kendo.Mvc.UI.TemplateBuilder)
Defines a node card template.
Parameters
template - TemplateBuilder<TModel>
A Template component that configures the template.
Events(System.Action)
Configures the client-side events.
Parameters
configurator - System.Action<OrgChartEventBuilder>
The client events action.
Example
@(Html.Kendo().OrgChart()
.Name("OrgChart")
.Events(events => events
.Cancel("onCancel")
)
)
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.