SankeyLegend

Premium

Represents the Sankey legend options.

Name	Type	Default	Description
align?	"center" | "end" | "start"		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". The supported values are: "start"—The legend is aligned to the start. "center"—The legend is aligned to the center. "end"—The legend is aligned to the end.
background?	string		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".
item?	SankeyLegendItem		The configuration of the legend items.
labels?	LegendLabels		The label configuration of the Chart legend.
margin?	number | Margin		The margin of the Chart legend. A numeric value sets all paddings.
offsetX?	number		The X offset of the Chart 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		The Y offset of the chart 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?	"vertical" | "horizontal"		The orientation of the legend items. The supported values are: "vertical"—The legend items are added vertically. "horizontal"—The legend items are added horizontally.
padding?	number | Padding		The padding of the Chart legend. A numeric value sets all paddings.
position?	"left" | "right" | "top" | "bottom" | "custom"		The positions of the Chart legend. The supported values are: "top"—The legend is positioned on the top. "bottom"—The legend is positioned on the bottom. "left"—The legend is positioned on the left. "right"—The legend is positioned on the right. "custom"—The legend is positioned by using legend.offsetX and legend.offsetY.
reverse?	boolean		If set to true, the legend items are reversed.
title?	LegendTitle		The title of the Chart legend. By default, the Chart will not render a legend title.
visible?	boolean		If set to true, the Chart displays the legend (see example). By default, the Chart legend is visible.
width?	number		The legend width when the legend.orientation is set to "horizontal".