Back to all docs
API Reference / Kendo.Mvc.UI.Fluent / SankeyBuilder
New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

SankeyBuilder

Class

Defines the fluent API for configuring the Kendo Sankey for ASP.NET MVC.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:
C#
public class SankeyBuilder : WidgetBuilderBase<Sankey, SankeyBuilder>, IHtmlString

Inheritance: objectWidgetBuilderBase<Sankey, SankeyBuilder>SankeyBuilder

Implements: IHtmlString

Inherited Members WidgetBuilderBase<Sankey, SankeyBuilder>.ToComponent()WidgetBuilderBase<Sankey, SankeyBuilder>.Name(string)WidgetBuilderBase<Sankey, SankeyBuilder>.Deferred(bool)WidgetBuilderBase<Sankey, SankeyBuilder>.ModelMetadata(ModelMetadata)WidgetBuilderBase<Sankey, SankeyBuilder>.HtmlAttributes(object)WidgetBuilderBase<Sankey, SankeyBuilder>.HtmlAttributes(IDictionary<string, object>)WidgetBuilderBase<Sankey, SankeyBuilder>.AsModule(bool)WidgetBuilderBase<Sankey, SankeyBuilder>.Render()WidgetBuilderBase<Sankey, SankeyBuilder>.ScriptAttributes(object, bool)WidgetBuilderBase<Sankey, SankeyBuilder>.ScriptAttributes(IDictionary<string, object>, bool)WidgetBuilderBase<Sankey, SankeyBuilder>.ToHtmlString()WidgetBuilderBase<Sankey, SankeyBuilder>.ToClientTemplate()WidgetBuilderBase<Sankey, SankeyBuilder>.ToString()WidgetBuilderBase<Sankey, SankeyBuilder>.Componentobject.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

SankeyBuilder(Sankey)

Initializes a new instance of the Sankey class.

C#
public SankeyBuilder(Sankey component)
Parameters:componentSankey

The component.

Methods

Data(Action<SankeyDataSettingsBuilder>)

The data of the Sankey. The data object contains the Sankey nodes and links configuration.

C#
public SankeyBuilder Data(Action<SankeyDataSettingsBuilder> configurator)
Parameters:configuratorAction<SankeyDataSettingsBuilder>

The action that configures the data.

Returns:

SankeyBuilder

DisableAutoLayout(bool)

If set to true, the Sankey will not automatically reorder the nodes to reduce the number of links that cross over each other.

C#
public SankeyBuilder DisableAutoLayout(bool value)
Parameters:valuebool

The value that configures the disableautolayout.

Returns:

SankeyBuilder

DisableKeyboardNavigation(bool)

If set to true, the Sankey keyboard navigation will be disabled.

C#
public SankeyBuilder DisableKeyboardNavigation(bool value)
Parameters:valuebool

The value that configures the disablekeyboardnavigation.

Returns:

SankeyBuilder

Events(Action<SankeyEventBuilder>)

Configures the client-side events.

C#
public SankeyBuilder Events(Action<SankeyEventBuilder> configurator)
Parameters:configuratorAction<SankeyEventBuilder>

The client events action.

Returns:

SankeyBuilder

Example:
C#
@(Html.Kendo().Sankey()
.Name("Sankey")
.Events(events =&gt; events
.LinkClick("onLinkClick")
)
)

Labels(Action<SankeyLabelsSettingsBuilder>)

The default labels configuration of the Sankey. The labels configuration options will be overridden by the data.nodes.label configuration.

C#
public SankeyBuilder Labels(Action<SankeyLabelsSettingsBuilder> configurator)
Parameters:configuratorAction<SankeyLabelsSettingsBuilder>

The action that configures the labels.

Returns:

SankeyBuilder

Legend(Action<SankeyLegendSettingsBuilder>)

The legend configuration options of the Sankey.

C#
public SankeyBuilder Legend(Action<SankeyLegendSettingsBuilder> configurator)
Parameters:configuratorAction<SankeyLegendSettingsBuilder>

The action that configures the legend.

Returns:

SankeyBuilder

Links(Action<SankeyLinksSettingsBuilder>)

The default links configuration of the Sankey. The links configuration options will be overridden by the data.links configuration.

C#
public SankeyBuilder Links(Action<SankeyLinksSettingsBuilder> configurator)
Parameters:configuratorAction<SankeyLinksSettingsBuilder>

The action that configures the links.

Returns:

SankeyBuilder

Messages(Action<SankeyMessagesSettingsBuilder>)

The configuration of the messages displayed in the Sankey.

C#
public SankeyBuilder Messages(Action<SankeyMessagesSettingsBuilder> configurator)
Parameters:configuratorAction<SankeyMessagesSettingsBuilder>

The action that configures the messages.

Returns:

SankeyBuilder

Nodes(Action<SankeyNodesSettingsBuilder>)

The default nodes configuration of the Sankey. The nodes configuration options will be overridden by the data.nodes configuration.

C#
public SankeyBuilder Nodes(Action<SankeyNodesSettingsBuilder> configurator)
Parameters:configuratorAction<SankeyNodesSettingsBuilder>

The action that configures the nodes.

Returns:

SankeyBuilder

Theme(string)

The Theme configuration options.

C#
public SankeyBuilder Theme(string theme)
Parameters:themestringReturns:

SankeyBuilder

Title(Action<SankeyTitleSettingsBuilder>)

The Sankey title configuration options.

C#
public SankeyBuilder Title(Action<SankeyTitleSettingsBuilder> configurator)
Parameters:configuratorAction<SankeyTitleSettingsBuilder>

The action that configures the title.

Returns:

SankeyBuilder

Tooltip(Action<SankeyTooltipSettingsBuilder>)

The tooltip configuration options.

C#
public SankeyBuilder Tooltip(Action<SankeyTooltipSettingsBuilder> configurator)
Parameters:configuratorAction<SankeyTooltipSettingsBuilder>

The action that configures the tooltip.

Returns:

SankeyBuilder

In this article
DefinitionConstructorsSankeyBuilder(Sankey)MethodsData(Action<SankeyDataSettingsBuilder>)DisableAutoLayout(bool)DisableKeyboardNavigation(bool)Events(Action<SankeyEventBuilder>)Labels(Action<SankeyLabelsSettingsBuilder>)Legend(Action<SankeyLegendSettingsBuilder>)Links(Action<SankeyLinksSettingsBuilder>)Messages(Action<SankeyMessagesSettingsBuilder>)Nodes(Action<SankeyNodesSettingsBuilder>)Theme(string)Title(Action<SankeyTitleSettingsBuilder>)Tooltip(Action<SankeyTooltipSettingsBuilder>)
Not finding the help you need?
Contact Support