SankeyBuilder
Properties
WriteAction - Func
Methods
Theme(System.String)
The Theme configuration options.
Parameters
theme - System.String
The theme name.
Data(System.Action)
The data of the Sankey. The data object contains the Sankey nodes and links configuration.
Parameters
configurator - System.Action<SankeyDataSettingsBuilder>
The configurator for the data setting.
DisableAutoLayout(System.Boolean)
If set to true, the Sankey will not automatically reorder the nodes to reduce the number of links that cross over each other.
Parameters
value - System.Boolean
The value for DisableAutoLayout
DisableAutoLayout()
If set to true, the Sankey will not automatically reorder the nodes to reduce the number of links that cross over each other.
Labels(System.Action)
The default labels configuration of the Sankey. The labels configuration options will be overridden by the data.nodes.label configuration.
Parameters
configurator - System.Action<SankeyLabelsSettingsBuilder>
The configurator for the labels setting.
Legend(System.Action)
The legend configuration options of the Sankey.
Parameters
configurator - System.Action<SankeyLegendSettingsBuilder>
The configurator for the legend setting.
Links(System.Action)
The default links configuration of the Sankey. The links configuration options will be overridden by the data.links configuration.
Parameters
configurator - System.Action<SankeyLinksSettingsBuilder>
The configurator for the links setting.
Messages(System.Action)
The configuration of the messages displayed in the Sankey.
Parameters
configurator - System.Action<SankeyMessagesSettingsBuilder>
The configurator for the messages setting.
Nodes(System.Action)
The default nodes configuration of the Sankey. The nodes configuration options will be overridden by the data.nodes configuration.
Parameters
configurator - System.Action<SankeyNodesSettingsBuilder>
The configurator for the nodes setting.
Title(System.Action)
The Sankey title configuration options.
Parameters
configurator - System.Action<SankeyTitleSettingsBuilder>
The configurator for the title setting.
Tooltip(System.Action)
The tooltip configuration options.
Parameters
configurator - System.Action<SankeyTooltipSettingsBuilder>
The configurator for the tooltip setting.
Events(System.Action)
Configures the client-side events.
Parameters
configurator - System.Action<SankeyEventBuilder>
The client events action.
Example
@(Html.Kendo().Sankey()
.Name("Sankey")
.Events(events => events
.LinkClick("onLinkClick")
)
)
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.