SankeyLegendComponent

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

Selector

kendo-sankey-legend

Inputs

Name	Type	Default	Description
align	"center" | "start" | "end"	'center'	Aligns the legend horizontally when legend.position is set to "top" or "bottom". Aligns the legend vertically when legend.position is set to "left" or "right".
background	string	'white'	Sets the background color of the legend. Accepts a valid CSS color string, including hex and rgb.
border	Border		Specifies the border of the legend.
height	number		Specifies the height of the legend when legend.orientation is set to "vertical".
labels	LegendLabels		Specifies the label configuration of the Chart legend.
margin	number | Margin	5	Sets the margin of the Sankey legend. A numeric value sets all paddings.
markers	LegendMarkers		Specifies the configuration of the Chart legend markers.
offsetX	number	0	Sets 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	Sets 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'	Sets the orientation of the legend items.
padding	number | Padding	5	Sets the padding of the Sankey legend. A numeric value sets all paddings.
position	"top" | "bottom" | "left" | "right" | "custom"	'right'	Sets 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	Determines if the legend items are reversed.
spacing	number		Specifies the distance (in pixels) between the legend items. Defaults to 6.
title	LegendTitle		Specifies the title of the Chart legend. By default, the Chart will not render a legend title.
visible	boolean	true	Determines if the Sankey displays the legend. By default, the Sankey legend is visible.
width	number		Specifies 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.