SankeyLegendComponent
Represents the configuration options of the Sankey legend (see example).
Definition
Package:@progress/kendo-angular-charts
Selector:kendo-sankey-legend
Inputs
align
"center" | "start" | "end"
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".
'center'
background
string
Sets the background color of the legend. Accepts a valid CSS color string, including hex and rgb.
'white'
height
number
Specifies the height of the legend when legend.orientation is set to "vertical".
Specifies the label configuration of the Chart legend.
Sets the margin of the Sankey legend. A numeric value sets all paddings.
5
Specifies the configuration of the Chart legend markers.
offsetX
number
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.
0
offsetY
number
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.
0
orientation
"vertical" | "horizontal"
Sets the orientation of the legend items.
'vertical'
Sets the padding of the Sankey legend. A numeric value sets all paddings.
5
position
"top" | "bottom" | "left" | "right" | "custom"
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.
'right'
reverse
boolean
Determines if the legend items are reversed.
false
spacing
number
Specifies the distance (in pixels) between the legend items. Defaults to 6.
Specifies the title of the Chart legend. By default, the Chart will not render a legend title.
visible
boolean
Determines if the Sankey displays the legend. By default, the Sankey legend is visible.
true
width
number
Specifies the legend width when the legend.orientation is set to "horizontal".
Methods
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.
An object containing the updated input fields.