SankeyLegendComponent

The configuration options of the Sankey legend (see example).

Selector

kendo-sankey-legend

Inputs

Name	Type	Default	Description
align	"center" | "start" | "end"	'center'	The legend is horizontally aligned when legend.position is set to "top" or "bottom". The legend is vertically aligned when legend.position is set to "left" or "right".
background	string	'white'	The background color of the legend. Accepts a valid CSS color string, including hex and rgb.
border	Border		The border of the legend.
height	number		The height of the legend when legend.orientation is set to "vertical".
labels	LegendLabels		The label configuration of the Chart legend.
margin	number | Margin	5	The margin of the Sankey legend. A numeric value sets all paddings.
markers	LegendMarkers		The configuration of the Chart legend markers.
offsetX	number	0	The X offset of the Sankey legend. The offset is relative to the default position of the legend. For example, a value of 20 moves the legend 20 pixels to the right of its initial position. Negative values move the legend to the left of its current position.
offsetY	number	0	The Y offset of the Sankey legend. The offset is relative to the current position of the legend. For example, a value of 20 moves the legend 20 pixels down from its initial position. Negative values move the legend upwards from its current position.
orientation	"horizontal" | "vertical"	'vertical'	The orientation of the legend items.
padding	number | Padding	5	The padding of the Sankey legend. A numeric value sets all paddings.
position	"top" | "bottom" | "left" | "right" | "custom"	'right'	The position of the Sankey legend. Setting the legend position to custom allows you to position the legend using the legend.offsetX and legend.offsetY options.
reverse	boolean	false	If set to true, the legend items are reversed.
spacing	number		The distance (in pixels) between the legend items. Defaults to 6.
title	LegendTitle		The title of the Chart legend. By default, the Chart will not render a legend title.
visible	boolean	true	If set to true, the Sankey displays the legend. By default, the Sankey legend is visible.
width	number		The legend width when the legend.orientation is set to "horizontal".

Methods

notifyChanges
Updates the component fields with the specified values and refreshes the Chart. Use this method when the configuration values cannot be set through the template. ts item.notifyChanges({ visible: true });
Parameters changes any An object containing the updated input fields.