New to Kendo UI for AngularStart a free 30-day trial

SankeyLegend

Represents the Sankey legend options.

NameTypeDefaultDescription

align?

"center" | "start" | "end"

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".

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.

markers?

LegendMarkers

The configuration of the Chart legend markers.

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?

"horizontal" | "vertical"

The orientation of the legend items.

padding?

number | Padding

The padding of the Chart legend. A numeric value sets all paddings.

position?

"top" | "bottom" | "left" | "right" | "custom"

The positions of the Chart legend. Setting the legend position to custom allows you to position the legend using the legend.offsetX and legend.offsetY options.

reverse?

boolean

If set to true, the legend items are reversed.

spacing?

number

The distance (in pixels) between the legend items. Defaults to 6.

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. By default, the Chart legend is visible.

width?

number

The legend width when the legend.orientation is set to "horizontal".

Not finding the help you need?
Contact Support