SankeyBuilder
Properties
WriteAction - Func
Methods
Theme(System.String)
The Theme configuration options.
Parameters
theme - System.String
The theme name.
RETURNS
Returns the current SankeyBuilder instance.
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.
RETURNS
Returns the current instance of SankeyBuilder .
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
RETURNS
Returns the current SankeyBuilder instance.
DisableAutoLayout()
If set to true, the Sankey will not automatically reorder the nodes to reduce the number of links that cross over each other.
RETURNS
Returns the current SankeyBuilder instance.
DisableKeyboardNavigation(System.Boolean)
If set to true, the Sankey keyboard navigation will be disabled.
Parameters
value - System.Boolean
The value for DisableKeyboardNavigation
RETURNS
Returns the current SankeyBuilder instance.
DisableKeyboardNavigation()
If set to true, the Sankey keyboard navigation will be disabled.
RETURNS
Returns the current SankeyBuilder instance.
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.
RETURNS
Returns the current instance of SankeyBuilder .
Legend(System.Action)
The legend configuration options of the Sankey.
Parameters
configurator - System.Action<SankeyLegendSettingsBuilder>
The configurator for the legend setting.
RETURNS
Returns the current instance of SankeyBuilder .
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.
RETURNS
Returns the current instance of SankeyBuilder .
Messages(System.Action)
The configuration of the messages displayed in the Sankey.
Parameters
configurator - System.Action<SankeyMessagesSettingsBuilder>
The configurator for the messages setting.
RETURNS
Returns the current instance of SankeyBuilder .
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.
RETURNS
Returns the current instance of SankeyBuilder .
Title(System.Action)
The Sankey title configuration options.
Parameters
configurator - System.Action<SankeyTitleSettingsBuilder>
The configurator for the title setting.
RETURNS
Returns the current instance of SankeyBuilder .
Tooltip(System.Action)
The tooltip configuration options.
Parameters
configurator - System.Action<SankeyTooltipSettingsBuilder>
The configurator for the tooltip setting.
RETURNS
Returns the current instance of SankeyBuilder .
Events(System.Action)
Configures the client-side events.
Parameters
configurator - System.Action<SankeyEventBuilder>
The client events action.
RETURNS
Returns the current SankeyBuilder instance.
Example
@(Html.Kendo().Sankey()
.Name("Sankey")
.Events(events => events
.LinkClick("onLinkClick")
)
)
ToComponent()
Returns the internal view component.
RETURNS
The instance that represents the component.
Expression(System.String)
Sets the name of the component.
Parameters
modelExpression - System.String
RETURNS
Returns the current instance.
Explorer(Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer)
Sets the name of the component.
Parameters
modelExplorer - Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer
RETURNS
Returns the current instance.
Name(System.String)
Sets the name of the component.
Parameters
componentName - System.String
The name.
RETURNS
Returns the current instance.
Deferred(System.Boolean)
Suppress initialization script rendering. Note that this options should be used in conjunction with
Parameters
deferred - System.Boolean
RETURNS
Returns a DeferredWidgetBuilder instance.
HtmlAttributes(System.Object)
Sets the HTML attributes.
Parameters
attributes - System.Object
The HTML attributes.
RETURNS
Returns the current instance.
HtmlAttributes(System.Collections.Generic.IDictionary)
Sets the HTML attributes.
Parameters
attributes - System.Collections.Generic.IDictionary<String,Object>
The HTML attributes.
RETURNS
Returns the current instance.
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.
RETURNS
Returns the current instance.
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.
RETURNS
Returns the current instance.
Render()
Renders the component in place.
ToHtmlString()
Returns the HTML representation of the component.
WriteTo(System.IO.TextWriter,System.Text.Encodings.Web.HtmlEncoder)
Parameters
writer - System.IO.TextWriter
encoder - System.Text.Encodings.Web.HtmlEncoder
ToClientTemplate()
Returns the client template for the component.
AsModule(System.Boolean)
Specifies whether the initialization script of the component will be rendered as a JavaScript module.
Parameters
value - System.Boolean
RETURNS
Returns the current instance.