New to Telerik UI for Blazor? Start a free 30-day trial
Sankey Legend
Updated on Oct 1, 2026
The Telerik Sankey Diagram for Blazor can show a legend, which is a visual guide with details about the nodes. This article explores how to customize the Sankey legend.
Basic Customization
To customize the legend in the Sankey chart, declare a <SankeyLegend> tag as a direct child of <TelerikSankey>. The <SankeyLegend> tag has the following parameters:
| Parameter | Type and Default Value | Description |
|---|---|---|
Align | SankeyLegendAlign enum ( Start) | The alignment of the legend. |
Background | string | The background color of the legend. |
Height | double? | The height of the legend. |
OffsetX | double? | The X offset of the legend. The offset is relative to the current position of the legend. |
OffsetY | double? | The Y offset of the legend. The offset is relative to the current position of the legend. |
Orientation | SankeyLegendOrientation enum ( Horizontal) | The orientation of the legend. |
Position | SankeyLegendPosition enum ( Bottom) | The position of the legend. |
Reverse | double? | Whether the legend items are reversed. |
Spacing | double? | The spacing between the labels of the legend. |
Visible | bool? ( true) | Whether the legend is visible. |
Width | double? | The width of the legend. Applies when Orientation="SankeyLegendOrientation.Horizontal". |
Nested Customization Tags
The <SankeyLegend> tag exposes nested tags for further customization of the separate legend elements. The structure of the nested tags is <SankeyLegend*Specifics*>, where the specifics can be:
BorderItemLabels- exposes additional nested options. The structure of the nested tags is<SankeyLegendLabels*Specifics*>, where the specifics can be:MarginPaddingTitle- exposes additional nested options. The structure of the nested tags is<SankeyLegendTitle*Specifics*>, where the specifics can be:
Use the IntelliSense to explore the nested tags and their properties.
Example
Customizing the Sankey legend by using nested tag settings
Loading ...