RadzenSankeyDiagram<TItem> Class

RadzenSankeyDiagram component.

Inheritance

Object

ComponentBase

RadzenComponent

RadzenSankeyDiagram<TItem>

Implements

IComponent

IHandleEvent

IHandleAfterRender

Namespace: Radzen.Blazor

Assembly: Radzen.Blazor.dll

Syntax

public class RadzenSankeyDiagram<TItem> : RadzenComponent, IComponent, IHandleEvent, IHandleAfterRender

Type Parameters

Name Description
TItemThe type of data item.

Constructors

RadzenSankeyDiagram<TItem>link

RadzenSankeyDiagram component.

Declaration
public RadzenSankeyDiagram<TItem>()

Properties

Animatedlink

Gets or sets whether to animate the flow in the links.

Declaration
public bool Animated { get; set; }
Property Value
Type Description
boolGets or sets whether to animate the flow in the links.

ColorSchemelink

Gets or sets the color scheme of the chart.

Declaration
public ColorScheme ColorScheme { get; set; }
Property Value
Type Description
ColorSchemeGets or sets the color scheme of the chart.

Datalink

Gets or sets the data. Each item represents a link/flow in the diagram.

Declaration
public IEnumerable<TItem> Data { get; set; }
Property Value
Type Description
IEnumerable<TItem>Gets or sets the data. Each item represents a link/flow in the diagram.

FlowTextlink

Gets or sets the tooltip text for "Flow".

Declaration
public string FlowText { get; set; }
Property Value
Type Description
stringGets or sets the tooltip text for "Flow".

IncomingTextlink

Gets or sets the tooltip text for "Incoming".

Declaration
public string IncomingText { get; set; }
Property Value
Type Description
stringGets or sets the tooltip text for "Incoming".

LinkFillslink

Gets or sets the link fill colors. If not specified, inherits from source node.

Declaration
public IList<string> LinkFills { get; set; }
Property Value
Type Description
IList<string>Gets or sets the link fill colors. If not specified, inherits from source node.

NodeAlignmentlink

Gets or sets the node alignment.

Declaration
public SankeyAlignment NodeAlignment { get; set; }
Property Value
Type Description
SankeyAlignmentGets or sets the node alignment.

NodeFillslink

Gets or sets the node fill colors. If not specified, uses color scheme.

Declaration
public IList<string> NodeFills { get; set; }
Property Value
Type Description
IList<string>Gets or sets the node fill colors. If not specified, uses color scheme.

NodePaddinglink

Gets or sets the node padding.

Declaration
public double NodePadding { get; set; }
Property Value
Type Description
doubleGets or sets the node padding.

NodeWidthlink

Gets or sets the node width.

Declaration
public double NodeWidth { get; set; }
Property Value
Type Description
doubleGets or sets the node width.

OutgoingTextlink

Gets or sets the tooltip text for "Outgoing".

Declaration
public string OutgoingText { get; set; }
Property Value
Type Description
stringGets or sets the tooltip text for "Outgoing".

SourceLabelPropertylink

Specifies the property of TItem which provides the source node label.

Declaration
public string SourceLabelProperty { get; set; }
Property Value
Type Description
stringSpecifies the property of TItem which provides the source node label.

SourcePropertylink

Specifies the property of TItem which provides the source node ID.

Declaration
public string SourceProperty { get; set; }
Property Value
Type Description
stringSpecifies the property of TItem which provides the source node ID.

TargetLabelPropertylink

Specifies the property of TItem which provides the target node label.

Declaration
public string TargetLabelProperty { get; set; }
Property Value
Type Description
stringSpecifies the property of TItem which provides the target node label.

TargetPropertylink

Specifies the property of TItem which provides the target node ID.

Declaration
public string TargetProperty { get; set; }
Property Value
Type Description
stringSpecifies the property of TItem which provides the target node ID.

TooltipServicelink

Gets or sets the tooltip service.

Declaration
public TooltipService TooltipService { get; set; }
Property Value
Type Description
TooltipServiceGets or sets the tooltip service.

TooltipStylelink

Gets or sets the CSS style of the tooltip.

Declaration
public string TooltipStyle { get; set; }
Property Value
Type Description
stringGets or sets the CSS style of the tooltip.

ValueFormatterlink

Gets or sets the value formatter for tooltip display.

Declaration
public Func<double, string> ValueFormatter { get; set; }
Property Value
Type Description
Func<double, string>Gets or sets the value formatter for tooltip display.

ValuePropertylink

Specifies the property of TItem which provides the flow value.

Declaration
public string ValueProperty { get; set; }
Property Value
Type Description
stringSpecifies the property of TItem which provides the flow value.

ValueTextlink

Gets or sets the tooltip text for "Value".

Declaration
public string ValueText { get; set; }
Property Value
Type Description
stringGets or sets the tooltip text for "Value".

Methods

BuildRenderTreelink

Declaration
protected override void BuildRenderTree(Rendering.RenderTreeBuilder __builder)
Parameters
Type Name Description
Rendering.RenderTreeBuilder __builder

Disposelink

Declaration
public override void Dispose()

GetComponentCssClasslink

Declaration
protected override string GetComponentCssClass()
Returns
Type Description
string

OnAfterRenderAsynclink

Declaration
protected override Task OnAfterRenderAsync(bool firstRender)
Parameters
Type Name Description
bool firstRender
Returns
Type Description
Task

Reloadlink

Causes the component to re-render. Use it when Data has changed.

Declaration
public void Reload()

Resizelink

Called by JavaScript when the chart container is resized.

Declaration
public Task Resize(double width, double height)
Parameters
Type Name Description
double width
double height
Returns
Type Description
Task

SetParametersAsynclink

Declaration
public override Task SetParametersAsync(ParameterView parameters)
Parameters
Type Name Description
ParameterView parameters
Returns
Type Description
Task
An error has occurred. This app may no longer respond until reloaded. Reload 🗙