Components / Charts / API / SankeyLabel /

SankeyLabel

Represents the Sankey label options.

Name	Type	Default	Description
align?	`"center" \| "left" \| "right"`	`'left'`	The alignment of the label.
border?	`{ color?: string; dashType?: string; opacity?: number; width?: number; }`	`{ width: 0 }`	The border of the label.
color?	`string`		The color of the label.
font?	`string`		The font of the label.
margin?	`{ left?: number; right?: number; }`	`{ left: 8, right: 8 }`	The margin of the label.
offset?	`SankeyOffset`	`{ top: 0, left: 0 }`	The offset applied to the label's position.
opacity?	`number`	`1`	The opacity of the label.
padding?	`number \| { bottom?: number; left?: number; right?: number; top?: number; }`	`0`	The padding of the label.
position?	`"inside" \| "after" \| "before"`	`'inside'`	The position of the label. The supported values are: `inside`—The label is positioned after the node, except for the nodes at the end of the Sankey, that are placed before the node. `before`—The label is positioned before the node. `after`—The label is positioned after the node.
text?	`string`		The text of the label.
visible?	`boolean`	`true`	The visibility of the label.