SankeyLegendSettingsBuilder

Methods

Background(System.String)

The background color of the legend.

Parameters

value - System.String

The value for Background

RETURNS

Returns the current SankeyLegendSettingsBuilder instance.

Border(System.Action)

The border of the legend.

Parameters

configurator - System.Action<SankeyLegendBorderSettingsBuilder>

The configurator for the border setting.

RETURNS

Returns the current instance of SankeyLegendSettingsBuilder .

Height(System.Double)

The height of the legend.

Parameters

value - System.Double

The value for Height

RETURNS

Returns the current SankeyLegendSettingsBuilder instance.

Item(System.Action)

The configuration of the legend items.

Parameters

configurator - System.Action<SankeyLegendItemSettingsBuilder>

The configurator for the item setting.

RETURNS

Returns the current instance of SankeyLegendSettingsBuilder .

Labels(System.Action)

The Sankey legend label configuration.

Parameters

configurator - System.Action<SankeyLegendLabelsSettingsBuilder>

The configurator for the labels setting.

RETURNS

Returns the current instance of SankeyLegendSettingsBuilder .

Margin(System.Action)

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

Parameters

configurator - System.Action<SankeyLegendMarginSettingsBuilder>

The configurator for the margin setting.

RETURNS

Returns the current instance of SankeyLegendSettingsBuilder .

OffsetX(System.Double)

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.

Parameters

value - System.Double

The value for OffsetX

RETURNS

Returns the current SankeyLegendSettingsBuilder instance.

OffsetY(System.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.

Parameters

value - System.Double

The value for OffsetY

RETURNS

Returns the current SankeyLegendSettingsBuilder instance.

Padding(System.Action)

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

Parameters

configurator - System.Action<SankeyLegendPaddingSettingsBuilder>

The configurator for the padding setting.

RETURNS

Returns the current instance of SankeyLegendSettingsBuilder .

Reverse(System.Boolean)

If set to true the legend items will be reversed.

Parameters

value - System.Boolean

The value for Reverse

RETURNS

Returns the current SankeyLegendSettingsBuilder instance.

Reverse()

If set to true the legend items will be reversed.

RETURNS

Returns the current SankeyLegendSettingsBuilder instance.

Spacing(System.Double)

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

Parameters

value - System.Double

The value for Spacing

RETURNS

Returns the current SankeyLegendSettingsBuilder instance.

Title(System.Action)

The legend title configuration options.

Parameters

configurator - System.Action<SankeyLegendTitleSettingsBuilder>

The configurator for the title setting.

RETURNS

Returns the current instance of SankeyLegendSettingsBuilder .

Visible(System.Boolean)

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

Parameters

value - System.Boolean

The value for Visible

RETURNS

Returns the current SankeyLegendSettingsBuilder instance.

Width(System.Double)

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

Parameters

value - System.Double

The value for Width

RETURNS

Returns the current SankeyLegendSettingsBuilder instance.

Align(Kendo.Mvc.UI.LabelAlign)

The alignment of the legend label.

Parameters

value - LabelAlign

The value for Align

RETURNS

Returns the current SankeyLegendSettingsBuilder instance.

Orientation(Kendo.Mvc.UI.Orientation)

The position of the label.

Parameters

value - Orientation

The value for Orientation

RETURNS

Returns the current SankeyLegendSettingsBuilder instance.

Position(Kendo.Mvc.UI.LegendPosition)

The position of the label.

Parameters

value - LegendPosition

The value for Position

RETURNS

Returns the current SankeyLegendSettingsBuilder instance.