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

SankeyLegendSettingsBuilder

Class

Defines the fluent API for configuring the SankeyLegendSettings settings.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class SankeyLegendSettingsBuilder

Inheritance: objectSankeyLegendSettingsBuilder

Inherited Members object.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

SankeyLegendSettingsBuilder(SankeyLegendSettings)

Initialize the SankeyLegendSettingsBuilder

public SankeyLegendSettingsBuilder(SankeyLegendSettings settings)

Parameters:settingsSankeyLegendSettings

The SankeyLegendSettings

Methods

Align(LabelAlign)

The alignment of the legend label.

public SankeyLegendSettingsBuilder Align(LabelAlign value)

Parameters:valueLabelAlign

The value that configures the align.

Returns:

SankeyLegendSettingsBuilder

Background(string)

The background color of the legend.

public SankeyLegendSettingsBuilder Background(string value)

Parameters:valuestring

The value that configures the background.

Returns:

SankeyLegendSettingsBuilder

Border(Action<SankeyLegendBorderSettingsBuilder>)

The border of the legend.

public SankeyLegendSettingsBuilder Border(Action<SankeyLegendBorderSettingsBuilder> configurator)

Parameters:configuratorAction<SankeyLegendBorderSettingsBuilder>

The action that configures the border.

Returns:

SankeyLegendSettingsBuilder

Height(double)

The height of the legend.

public SankeyLegendSettingsBuilder Height(double value)

Parameters:valuedouble

The value that configures the height.

Returns:

SankeyLegendSettingsBuilder

Item(Action<SankeyLegendItemSettingsBuilder>)

The configuration of the legend items.

public SankeyLegendSettingsBuilder Item(Action<SankeyLegendItemSettingsBuilder> configurator)

Parameters:configuratorAction<SankeyLegendItemSettingsBuilder>

The action that configures the item.

Returns:

SankeyLegendSettingsBuilder

Labels(Action<SankeyLegendLabelsSettingsBuilder>)

The Sankey legend label configuration.

public SankeyLegendSettingsBuilder Labels(Action<SankeyLegendLabelsSettingsBuilder> configurator)

Parameters:configuratorAction<SankeyLegendLabelsSettingsBuilder>

The action that configures the labels.

Returns:

SankeyLegendSettingsBuilder

Margin(Action<SankeyLegendMarginSettingsBuilder>)

The margin of the Sankey legend. A numeric value will set all paddings.

public SankeyLegendSettingsBuilder Margin(Action<SankeyLegendMarginSettingsBuilder> configurator)

Parameters:configuratorAction<SankeyLegendMarginSettingsBuilder>

The action that configures the margin.

Returns:

SankeyLegendSettingsBuilder

The X offset of the Sankey legend. The offset is relative to the default position of the legend. For instance, a value of 20 will move the legend 20 pixels to the right of its initial position. A negative value will move the legend to the left of its current position.

public SankeyLegendSettingsBuilder OffsetX(double value)

Parameters:valuedouble

The value that configures the offsetx.

Returns:

SankeyLegendSettingsBuilder

OffsetY(double)

The Y offset of the Sankey legend. The offset is relative to the current position of the legend. For instance, a value of 20 will move the legend 20 pixels down from its initial position. A negative value will move the legend upwards from its current position.

public SankeyLegendSettingsBuilder OffsetY(double value)

Parameters:valuedouble

The value that configures the offsety.

Returns:

SankeyLegendSettingsBuilder

Orientation(Orientation)

The position of the label.

public SankeyLegendSettingsBuilder Orientation(Orientation value)

Parameters:valueOrientation

The value that configures the orientation.

Returns:

SankeyLegendSettingsBuilder

Padding(Action<SankeyLegendPaddingSettingsBuilder>)

The padding of the Sankey legend. A numeric value will set all paddings.

public SankeyLegendSettingsBuilder Padding(Action<SankeyLegendPaddingSettingsBuilder> configurator)

Parameters:configuratorAction<SankeyLegendPaddingSettingsBuilder>

The action that configures the padding.

Returns:

SankeyLegendSettingsBuilder

Position(LegendPosition)

The position of the label.

public SankeyLegendSettingsBuilder Position(LegendPosition value)

Parameters:valueLegendPosition

The value that configures the position.

Returns:

SankeyLegendSettingsBuilder

Reverse(bool)

If set to true the legend items will be reversed.

public SankeyLegendSettingsBuilder Reverse(bool value)

Parameters:valuebool

The value that configures the reverse.

Returns:

SankeyLegendSettingsBuilder

Spacing(double)

The spacing between the labels in pixels when the legend.orientation is "horizontal".

public SankeyLegendSettingsBuilder Spacing(double value)

Parameters:valuedouble

The value that configures the spacing.

Returns:

SankeyLegendSettingsBuilder

Title(Action<SankeyLegendTitleSettingsBuilder>)

The legend title configuration options.

public SankeyLegendSettingsBuilder Title(Action<SankeyLegendTitleSettingsBuilder> configurator)

Parameters:configuratorAction<SankeyLegendTitleSettingsBuilder>

The action that configures the title.

Returns:

SankeyLegendSettingsBuilder

Visible(bool)

If set to false the Sankey will not display the legend.

public SankeyLegendSettingsBuilder Visible(bool value)

Parameters:valuebool

The value that configures the visible.

Returns:

SankeyLegendSettingsBuilder

Width(double)

The legend width when the legend.orientation is set to "horizontal".

public SankeyLegendSettingsBuilder Width(double value)

Parameters:valuedouble

The value that configures the width.

Returns:

SankeyLegendSettingsBuilder