New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

Sankey

Class

Kendo UI Sankey component

Definition

Namespace:Kendo.Mvc.UI

Assembly:Kendo.Mvc.dll

Syntax:

public class Sankey : WidgetBase, IWidget, IHtmlAttributesContainer, IScriptableComponent

Inheritance: objectWidgetBaseSankey

Implements: IHtmlAttributesContainerIScriptableComponentIWidget

Inherited Members WidgetBase.Render()WidgetBase.VerifySettings()WidgetBase.ToHtmlString()WidgetBase.GetHtml(bool)WidgetBase.GetInitializator()WidgetBase.WriteLicensingScript(TextWriter)WidgetBase.SerializeSettings()WidgetBase.WriteDeferredStyles(TextWriter)WidgetBase.DeferStyles()WidgetBase.ToClientTemplate()WidgetBase.WriteTrialMessage(HtmlTextWriter)WidgetBase.InitializerWidgetBase.EventsWidgetBase.NameWidgetBase.IdWidgetBase.ShouldSanitezeIdWidgetBase.ModelMetadataWidgetBase.HtmlAttributesWidgetBase.ScriptAttributesWidgetBase.ViewContextWidgetBase.ViewDataWidgetBase.IsSelfInitializedWidgetBase.IsInClientTemplateWidgetBase.HasDeferredInitializationWidgetBase.SelectorWidgetBase.HasClientComponentobject.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

Sankey(ViewContext, IJavaScriptInitializer, IUrlGenerator)

Initializes a new instance of the Sankey class.

public Sankey(ViewContext viewContext, IJavaScriptInitializer initializer, IUrlGenerator urlGenerator)

Parameters:viewContextViewContext

The view context

initializerIJavaScriptInitializer

The JavaScriptInitializer

urlGeneratorIUrlGenerator

The URL generator.

Properties

Data

SankeyDataSettings

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

public SankeyDataSettings Data { get; set; }

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.

public bool? DisableAutoLayout { get; set; }

DisableKeyboardNavigation

bool?

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

public bool? DisableKeyboardNavigation { get; set; }

Labels

SankeyLabelsSettings

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

public SankeyLabelsSettings Labels { get; set; }

Legend

SankeyLegendSettings

The legend configuration options of the Sankey.

public SankeyLegendSettings Legend { get; set; }

Links

SankeyLinksSettings

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

public SankeyLinksSettings Links { get; set; }

Messages

SankeyMessagesSettings

The configuration of the messages displayed in the Sankey.

public SankeyMessagesSettings Messages { get; set; }

Nodes

SankeyNodesSettings

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

public SankeyNodesSettings Nodes { get; set; }

Theme

string

The theme configuration options.

public string Theme { get; set; }

Title

SankeyTitleSettings

The Sankey title configuration options.

public SankeyTitleSettings Title { get; set; }

SankeyTooltipSettings

The tooltip configuration options.

public SankeyTooltipSettings Tooltip { get; set; }

Methods

Serialize()

public override IDictionary<string, object> Serialize()

Returns:

IDictionary<string, object>

Overrides: WidgetBase.Serialize()

WriteHtml(HtmlTextWriter)

Writes the HTML.

protected override void WriteHtml(HtmlTextWriter writer)

Parameters:writerHtmlTextWriter

The HtmlTextWriter.

Overrides: WidgetBase.WriteHtml(HtmlTextWriter)

WriteInitializationScript(TextWriter)

Writes the initialization script.

public override void WriteInitializationScript(TextWriter writer)

Parameters:writerTextWriter

The TextWriter.

Overrides: WidgetBase.WriteInitializationScript(TextWriter)