Skip to main content
All docs
V24.2

DxSankey Members

A component that depicts value flow between two entity sets.

Constructors

Name Description
DxSankey() Initializes a new instance of the DxSankey class.

Properties

Name Description
ChangeStyleOnHover Specifies whether the DxSankey component changes the node or link appearance on hover.
CssClass Assigns a CSS class to the DxSankey component.
Data Specifies an object that supplies Sankey data.
Enabled Specifies whether the Sankey component responds to user interaction.
Height Specifies the component height.
Id Specifies the component’s unique identifier.
Palette Specifies the color scheme for Sankey nodes.
PaletteExtensionMode Specifies how to extend the component’s palette when the number of colors is less than the number of nodes.
RedrawOnResize Specifies whether to redraw the Sankey component when its container’s size changes.
SortOrder Specifies the sort order of Sankey nodes in corresponding columns.
SourceFieldName Specifies the data source field that contains data for source nodes.
TargetFieldName Specifies the data source field that contains data for target nodes.
VerticalAlignment Specifies the vertical alignment of node columns.
WeightFieldName Specifies the data source field that populates links with weights.
Width Specifies the component width.

Methods

Name Description
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
ExportToAsync(String, DataExportFormat) Exports Sankey data to a file in the specified format.
GetAllLinksAsync() Returns all DxSankey links.
GetAllNodesAsync() Returns all DxSankey nodes.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetSvgMarkupAsync() Obtains the component’s SVG markup.
GetType() Gets the Type of the current instance. Inherited from Object.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
PrintAsync() Invokes the browser’s Print dialog.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
ToString() Returns a string that represents the current object. Inherited from Object.

Events

Name Description
Exported Fires after the Sankey is exported.
LinkClick Fires when a user clicks a DxSankey link.
NodeClick Fires when a user clicks a DxSankey node.
Rendered Fires after the Sankey component is rendered.
See Also