SankeyComponent
Represents the Kendo UI for Angular Sankey diagram component.
The Sankey diagram visualizes flow data between different categories or stages. It displays nodes connected by links where the thickness of each link represents the flow value.
Definition
Package:@progress/kendo-angular-charts
Selector:kendo-sankey
Export Name:Accessible in templates as #kendoSankeyInstance="kendoSankey"
Syntax:
import { Component } from '@angular/core';
@Component({
selector: 'my-app',
template: `
<kendo-sankey [data]="data">
</kendo-sankey>
`,
})
export class AppComponent {
public data: SankeyData = {
nodes: [
{ id: 1, label: { text: 'Linux' } },
{ id: 0, label: { text: 'iOS'} },
{ id: 2, label: { text: 'Mobile' } },
{ id: 3, label: { text: 'Desktop' } },
],
links: [
{ sourceId: 0, targetId: 2, value: 1 },
{ sourceId: 1, targetId: 2, value: 2 },
{ sourceId: 1, targetId: 3, value: 3 },
],
};
}Inputs
Specifies the data for the Sankey component containing the links and nodes.
The data object defines the structure and relationships of your flow diagram.
disableAutoLayout?
boolean
Determines whether the Sankey component performs automatic layout.
When set to true, the component will not arrange nodes and links automatically.
false
Specifies the default configuration for labels.
The settings are applied to all labels unless overridden by individual data items.
Specifies the legend configuration for the Sankey component.
Specifies the default configuration for links.
The settings are applied to all links unless overridden by individual data items.
navigable?
boolean
Determines whether keyboard navigation is enabled for the Sankey component.
When set to false, the keyboard navigation will be disabled.
true
Specifies the default configuration for nodes.
The settings are applied to all nodes unless overridden by individual data items.
Specifies the settings for the tooltip popup.
Specifies the title configuration for the Sankey component.
Specifies the configuration for the Sankey tooltip.
Events
Fires when the user clicks a link.
Fires when the user hovers over a link.
Similar to the mouseenter event.
Fires when the user stops hovering over a link.
Similar to the mouseleave event.
Fires when the user clicks a node.
Fires when the user hovers over a node.
Similar to the mouseenter event.
Fires when the user stops hovering over a node.
Similar to the mouseleave event.
Methods
Exports the Sankey diagram as an image.
The export operation is asynchronous and returns a promise.
The configuration options for the exported image.
Returns:Promise<string>
- A promise that resolves with a PNG image encoded as a Data URI.
Exports the Sankey diagram as an SVG document.
The export operation is asynchronous and returns a promise.
The parameters for the exported file.
Returns:Promise<string>
A promise that will be resolved with an SVG document that is encoded as a Data URI.
Exports the visual of the Sankey component to a drawing group.
The parameters for the export operation.
Returns:The root Group of the scene.
Updates the component fields with the specified values and refreshes the component.
Use this method when you cannot set configuration values through the template.
An object containing the updated input fields.
Reloads the Sankey appearance settings from the current Kendo UI Theme.
Call this method after loading a different theme stylesheet.