New to Kendo UI for jQuery? Start a free 30-day trial

Legend.title

configuration

The legend title configuration options.

legend.title

Object

<div id="sankey"></div>
<script>
$("#sankey").kendoSankey({
    data: {
        nodes: [
            { id: 1, label: { text: "Solar" } },
            { id: 2, label: { text: "Electricity" } }
        ],
        links: [
            { sourceId: 1, targetId: 2, value: 40 }
        ]
    },
    legend: {
        visible: true,
        title: {
            text: "Legend Title"
        }
    }
});
</script>

legend.title.align

String

The alignment of the title.

"center" - the text is aligned to the middle.
"left" - the text is aligned to the left.
"right" - the text is aligned to the right.

Default: "center"

<div id="sankey"></div>
<script>
$("#sankey").kendoSankey({
    data: {
        nodes: [
            { id: 1, label: { text: "Solar" } },
            { id: 2, label: { text: "Electricity" } }
        ],
        links: [
            { sourceId: 1, targetId: 2, value: 40 }
        ]
    },
    legend: {
        visible: true,
        title: {
            text: "Legend Title",
            align: "left"
        }
    }
});
</script>

legend.title.background

String

The background color of the title. Accepts a valid CSS color string, including hex and rgb.

Default: "white"

<div id="sankey"></div>
<script>
$("#sankey").kendoSankey({
    data: {
        nodes: [
            { id: 1, label: { text: "Solar" } },
            { id: 2, label: { text: "Electricity" } }
        ],
        links: [
            { sourceId: 1, targetId: 2, value: 40 }
        ]
    },
    legend: {
        visible: true,
        title: {
            text: "Legend Title",
            background: "#f0f0f0"
        }
    }
});
</script>

legend.title.border

Object

The border of the title.

<div id="sankey"></div>
<script>
$("#sankey").kendoSankey({
    data: {
        nodes: [
            { id: 1, label: { text: "Solar" } },
            { id: 2, label: { text: "Electricity" } }
        ],
        links: [
            { sourceId: 1, targetId: 2, value: 40 }
        ]
    },
    legend: {
        visible: true,
        title: {
            text: "Legend Title",
            border: {
                color: "#000000",
                width: 1
            }
        }
    }
});
</script>

legend.title.color

String

The text color of the title. Accepts a valid CSS color string, including hex and rgb.

<div id="sankey"></div>
<script>
$("#sankey").kendoSankey({
    data: {
        nodes: [
            { id: 1, label: { text: "Solar" } },
            { id: 2, label: { text: "Electricity" } }
        ],
        links: [
            { sourceId: 1, targetId: 2, value: 40 }
        ]
    },
    legend: {
        visible: true,
        title: {
            text: "Legend Title",
            color: "#ff6358"
        }
    }
});
</script>

legend.title.font

String

The font of the title.

Default: "16px Arial,Helvetica,sans-serif"

<div id="sankey"></div>
<script>
$("#sankey").kendoSankey({
    data: {
        nodes: [
            { id: 1, label: { text: "Solar" } },
            { id: 2, label: { text: "Electricity" } }
        ],
        links: [
            { sourceId: 1, targetId: 2, value: 40 }
        ]
    },
    legend: {
        visible: true,
        title: {
            text: "Legend Title",
            font: "18px Arial, sans-serif"
        }
    }
});
</script>

legend.title.margin

Number|Object

The margin of the title. A numeric value will set all margins.

Default: 5

<div id="sankey"></div>
<script>
$("#sankey").kendoSankey({
    data: {
        nodes: [
            { id: 1, label: { text: "Solar" } },
            { id: 2, label: { text: "Electricity" } }
        ],
        links: [
            { sourceId: 1, targetId: 2, value: 40 }
        ]
    },
    legend: {
        visible: true,
        title: {
            text: "Legend Title",
            margin: 15
        }
    }
});
</script>

legend.title.padding

Number|Object

The padding of the title. A numeric value will set all margins.

Default: 5

<div id="sankey"></div>
<script>
$("#sankey").kendoSankey({
    data: {
        nodes: [
            { id: 1, label: { text: "Solar" } },
            { id: 2, label: { text: "Electricity" } }
        ],
        links: [
            { sourceId: 1, targetId: 2, value: 40 }
        ]
    },
    legend: {
        visible: true,
        title: {
            text: "Legend Title",
            padding: 10
        }
    }
});
</script>

legend.title.position

String

The position of the title.

"bottom" - the title is positioned on the bottom.
"top" - the title is positioned on the top.

Default: "top"

<div id="sankey"></div>
<script>
$("#sankey").kendoSankey({
    data: {
        nodes: [
            { id: 1, label: { text: "Solar" } },
            { id: 2, label: { text: "Electricity" } }
        ],
        links: [
            { sourceId: 1, targetId: 2, value: 40 }
        ]
    },
    legend: {
        visible: true,
        title: {
            text: "Legend Title",
            position: "bottom"
        }
    }
});
</script>

legend.title.text

String

The text of the legend title. You can also set the text directly for a title with default options.

The text can be split into multiple lines by using line feed characters ("\n").

<div id="sankey"></div>
<script>
$("#sankey").kendoSankey({
    data: {
        nodes: [
            { id: 1, label: { text: "Solar" } },
            { id: 2, label: { text: "Electricity" } }
        ],
        links: [
            { sourceId: 1, targetId: 2, value: 40 }
        ]
    },
    legend: {
        visible: true,
        title: {
            text: "Energy Sources\nLegend"
        }
    }
});
</script>

legend.title.visible

Boolean

If set to false the Sankey will not display the legend title.

Default: true

<div id="sankey"></div>
<script>
$("#sankey").kendoSankey({
    data: {
        nodes: [
            { id: 1, label: { text: "Solar" } },
            { id: 2, label: { text: "Electricity" } }
        ],
        links: [
            { sourceId: 1, targetId: 2, value: 40 }
        ]
    },
    legend: {
        visible: true,
        title: {
            text: "Legend Title",
            visible: false
        }
    }
});
</script>

Related Members