Class Sankey
Inheritance
Namespace: Syncfusion.EJ2.Charts
Assembly: Syncfusion.EJ2.dll
Syntax
public class Sankey : EJTagHelperConstructors
Sankey()
Declaration
public Sankey()Properties
Accessibility
Accessibility options for the component.
Declaration
public object Accessibility { get; set; }Property Value
| Type | Description |
|---|---|
| System.Object | The default value is null |
AfterExport
Triggers after the export completed.
Declaration
public string AfterExport { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
AllowExport
Enables export in specific scenarios.
Declaration
public bool AllowExport { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is false |
Animation
Options for customizing the animation.
Declaration
public object Animation { get; set; }Property Value
| Type | Description |
|---|---|
| System.Object | The default value is null |
Background
Background color of the sankey diagram. Accepts valid CSS color values.
Declaration
public string Background { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
BackgroundImage
Background image URL of the sankey diagram.
Declaration
public string BackgroundImage { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
BeforeExport
Triggers before the export gets started.
Declaration
public string BeforeExport { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
BeforePrint
Triggers before the prints gets started.
Declaration
public string BeforePrint { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
Border
Options to configure the outer border of the component.
Declaration
public SankeyBorder Border { get; set; }Property Value
| Type | Description |
|---|---|
| SankeyBorder | The default value is null |
EnableExport
When set to true, enables export of the diagram into supported formats.
Declaration
public bool EnableExport { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is true |
EnablePersistence
Enable or disable persisting component's state between page reloads.
Declaration
public bool EnablePersistence { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is false |
EnableRtl
Enable or disable rendering component in right to left direction.
Declaration
public bool EnableRtl { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is false |
ExportCompleted
Triggers after the chart export is completed.
Declaration
public string ExportCompleted { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
FocusBorderColor
Customize the focus border color. If not specified, the element will use the default focus border color.
Declaration
public string FocusBorderColor { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
FocusBorderMargin
Customize the focus border margin. If not specified, the element will use the default focus border margin.
Declaration
public double FocusBorderMargin { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double | The default value is 0 |
FocusBorderWidth
Customize the focus border width. If not specified, the element will use the default focus border width.
Declaration
public double FocusBorderWidth { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double | The default value is 1.5 |
Height
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.
Declaration
public string Height { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
HtmlAttributes
Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.
Declaration
public object HtmlAttributes { get; set; }Property Value
| Type |
|---|
| System.Object |
LabelRendering
Triggers before a label is rendered. Allows customization of label text and style.
Declaration
public string LabelRendering { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
LabelSettings
Customize labels using labelSettings to improve clarity and alignment with application design.
Declaration
public SankeyChartLabelSettings LabelSettings { get; set; }Property Value
| Type | Description |
|---|---|
| SankeyChartLabelSettings | The default value is null |
LegendItemHover
Triggers when the mouse hovers over a legend item.
Declaration
public string LegendItemHover { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
LegendItemRendering
Triggers before a legend item is rendered. Allows customization of legend text and shape color.
Declaration
public string LegendItemRendering { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
LegendSettings
Legend configuration for the sankey diagram.
Declaration
public SankeyChartLegendSettings LegendSettings { get; set; }Property Value
| Type | Description |
|---|---|
| SankeyChartLegendSettings | The default value is null |
LinkClick
Triggers when a link is clicked.
Declaration
public string LinkClick { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
LinkEnter
Triggers when the mouse enters a link.
Declaration
public string LinkEnter { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
LinkLeave
Triggers when the mouse leaves a link.
Declaration
public string LinkLeave { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
LinkRendering
Triggers before a link is rendered. Allows customization of link appearance.
Declaration
public string LinkRendering { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
Links
Collection of Sankey links that represent the flow between nodes. Each link defines properties such as source, target, and value.
Declaration
public List<SankeyLink> Links { get; set; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.List<SankeyLink> | The default value is null |
LinkStyle
Link style configuration for the sankey diagram. Customize link color, opacity, and hover behavior.
Declaration
public SankeyChartLinkSettings LinkStyle { get; set; }Property Value
| Type | Description |
|---|---|
| SankeyChartLinkSettings | The default value is null |
Load
Triggers before the sankey loads. This event allows for customization and configuration before the sankey is rendered.
Declaration
public string Load { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
Loaded
Triggers after the sankey has fully loaded.
Declaration
public string Loaded { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
Locale
Overrides the global culture and localization value for this component. Default global culture is 'en-US'.
Declaration
public string Locale { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is "" |
Margin
Options to configure the margins around the component.
Declaration
public SankeyMargin Margin { get; set; }Property Value
| Type | Description |
|---|---|
| SankeyMargin | The default value is null |
NodeClick
Triggers when a node is clicked.
Declaration
public string NodeClick { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
NodeEnter
Triggers when the mouse enters a node.
Declaration
public string NodeEnter { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
NodeLeave
Triggers when the mouse leaves a node.
Declaration
public string NodeLeave { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
NodeRendering
Triggers before a node is rendered. Allows customization of node appearance.
Declaration
public string NodeRendering { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
Nodes
Collection of Sankey nodes that represent entities in the diagram. Each node defines properties such as name, color, and position.
Declaration
public List<SankeyNode> Nodes { get; set; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.List<SankeyNode> | The default value is null |
NodeStyle
Node style configuration for the sankey diagram. Customize node appearance, size, opacity, and text alignment.
Declaration
public SankeyChartNodeSettings NodeStyle { get; set; }Property Value
| Type | Description |
|---|---|
| SankeyChartNodeSettings | The default value is null |
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.
Declaration
public Orientation Orientation { get; set; }Property Value
| Type | Description |
|---|---|
| Orientation | The default value is Orientation.Horizontal |
SizeChanged
Triggers when the chart size changes.
Declaration
public string SizeChanged { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
SubTitle
The subtitle displayed below the main title.
Declaration
public string SubTitle { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is "" |
SubTitleStyle
Options to customize the appearance of the subtitle text.
Declaration
public SankeySankeyTitleStyle SubTitleStyle { get; set; }Property Value
| Type | Description |
|---|---|
| SankeySankeyTitleStyle | The default value is null |
Theme
Defines the theme of the component.
Declaration
public ChartTheme Theme { get; set; }Property Value
| Type | Description |
|---|---|
| ChartTheme | The default value is ChartTheme.Material |
Title
The title displayed at the top of the sankey diagram.
Declaration
public string Title { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is "" |
TitleStyle
Options to customize the appearance of the title text.
Declaration
public SankeySankeyTitleStyle TitleStyle { get; set; }Property Value
| Type | Description |
|---|---|
| SankeySankeyTitleStyle | The default value is null |
Tooltip
Tooltip configuration for displaying details on hover.
Declaration
public SankeyChartTooltipSettings Tooltip { get; set; }Property Value
| Type | Description |
|---|---|
| SankeyChartTooltipSettings | The default value is null |
TooltipRendering
Triggers before a tooltip is rendered. Allows customization of tooltip text.
Declaration
public string TooltipRendering { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
Width
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.
Declaration
public string Width { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |