HelpBot Assistant

How can I help you?

SankeyComponent

16 Mar 20264 minutes to read

Sankey Component

<ejs-sankey></ejs-sankey>

Properties

accessibility AccessibilityModel

Accessibility options for the component.

allowExport boolean

Enables export in specific scenarios.

Defaults to false

animation AnimationModel

Options for customizing the animation.

background string

Background color of the sankey diagram. Accepts valid CSS color values.

Defaults to null

backgroundImage string

Background image URL of the sankey diagram.

Defaults to null

border BorderModel

Options to configure the outer border of the component.

enableExport boolean

When set to true, enables export of the diagram into supported formats.

Defaults to true

enablePersistence boolean

Enable or disable persisting component’s state between page reloads.

Defaults to false

enableRtl boolean

Enable or disable rendering component in right to left direction.

Defaults to false

focusBorderColor string

Customize the focus border color.
If not specified, the element will use the default focus border color.

Defaults to null

focusBorderMargin number

Customize the focus border margin.
If not specified, the element will use the default focus border margin.

Defaults to 0

focusBorderWidth number

Customize the focus border width.
If not specified, the element will use the default focus border width.

Defaults to 1.5

height string

The height of the sankey diagram as a string, accepting values like ‘100px’ or ‘100%’.
If specified as ‘100%’, the component renders to the full height of its parent element.

Defaults to null

labelSettings SankeyLabelSettingsModel

Customize labels using labelSettings to improve clarity and alignment with application design.

legendSettings SankeyLegendSettingsModel

Legend configuration for the sankey diagram.

linkStyle SankeyLinkSettingsModel

Link style configuration for the sankey diagram.
Customize link color, opacity, and hover behavior.

links SankeyLinkModel[]

Collection of Sankey links that represent the flow between nodes.
Each link defines properties such as source, target, and value.

Defaults to []

locale string

Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.

Defaults to ’’

margin MarginModel

Options to configure the margins around the component.

nodeLayoutMap { [key: string]: SankeyNodeLayout }

Stores the computed Sankey node layout map keyed by node id.

nodeStyle SankeyNodeSettingsModel

Node style configuration for the sankey diagram.
Customize node appearance, size, opacity, and text alignment.

nodes SankeyNodeModel[]

Collection of Sankey nodes that represent entities in the diagram.
Each node defines properties such as name, color, and position.

Defaults to []

orientation Orientation

Defines the orientation of the Sankey diagram.
The options are:

Horizontal - Renders nodes from left to right.
Vertical - Renders nodes from top to bottom.

Defaults to ‘Horizontal’

subTitle string

The subtitle displayed below the main title.

Defaults to ’’

subTitleStyle SankeyTitleStyleModel

Options to customize the appearance of the subtitle text.

theme ChartTheme

Defines the theme of the component.

Defaults to ‘Material’

title string

The title displayed at the top of the sankey diagram.

Defaults to ’’

titleStyle SankeyTitleStyleModel

Options to customize the appearance of the title text.

Tooltip configuration for displaying details on hover.

width string

The width of the sankey diagram as a string, accepting values like ‘100px’ or ‘100%’.
If specified as ‘100%’, the component renders to the full width of its parent element.

Defaults to null