Class RadzenSankeyDiagram<TItem>

RadzenSankeyDiagram component.

Inheritance

object

ComponentBase

RadzenComponent

RadzenSankeyDiagram<TItem>

Implements

IComponent

IHandleEvent

IHandleAfterRender

IDisposable

Inherited Members

RadzenComponent.OnMouseEnter()

RadzenComponent.OnMouseLeave()

RadzenComponent.OnContextMenu(MouseEventArgs)

RadzenComponent.GetCssClass()

RadzenComponent.GetId()

RadzenComponent.Debounce(Func<Task>, int)

RadzenComponent.RaiseContextMenu(MouseEventArgs)

RadzenComponent.RaiseMouseEnter()

RadzenComponent.RaiseMouseLeave()

RadzenComponent.Attributes

RadzenComponent.Element

RadzenComponent.MouseEnter

RadzenComponent.MouseLeave

RadzenComponent.ContextMenu

RadzenComponent.Culture

RadzenComponent.DefaultCulture

RadzenComponent.Style

RadzenComponent.Visible

RadzenComponent.UniqueID

RadzenComponent.JSRuntime

RadzenComponent.IsJSRuntimeAvailable

RadzenComponent.Reference

RadzenComponent.CurrentStyle

ComponentBase.OnInitializedAsync()

ComponentBase.OnParametersSet()

ComponentBase.OnParametersSetAsync()

ComponentBase.StateHasChanged()

ComponentBase.ShouldRender()

ComponentBase.OnAfterRender(bool)

ComponentBase.InvokeAsync(Action)

ComponentBase.InvokeAsync(Func<Task>)

ComponentBase.DispatchExceptionAsync(Exception)

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Radzen.Blazor

Assembly: Radzen.Blazor.dll

Syntax

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

Type Parameters

Name	Description
TItem	The type of data item.

Constructors

RadzenSankeyDiagram()

RadzenSankeyDiagram component.

Declaration

public RadzenSankeyDiagram()

Properties

Animated

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

Declaration

[Parameter]
public bool Animated { get; set; }

Property Value

Type	Description
bool

ColorScheme

Gets or sets the color scheme of the chart.

Declaration

[Parameter]
public ColorScheme ColorScheme { get; set; }

Property Value

Type	Description
ColorScheme

Data

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

Declaration

[Parameter]
public IEnumerable<TItem> Data { get; set; }

Property Value

Type	Description
IEnumerable<TItem>

FlowText

Gets or sets the tooltip text for "Flow".

Declaration

[Parameter]
public string FlowText { get; set; }

Property Value

Type	Description
string

IncomingText

Gets or sets the tooltip text for "Incoming".

Declaration

[Parameter]
public string IncomingText { get; set; }

Property Value

Type	Description
string

LinkFills

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

Declaration

[Parameter]
public IList<string> LinkFills { get; set; }

Property Value

Type	Description
IList<string>

NodeAlignment

Gets or sets the node alignment.

Declaration

[Parameter]
public SankeyAlignment NodeAlignment { get; set; }

Property Value

Type	Description
SankeyAlignment

NodeFills

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

Declaration

[Parameter]
public IList<string> NodeFills { get; set; }

Property Value

Type	Description
IList<string>

NodePadding

Gets or sets the node padding.

Declaration

[Parameter]
public double NodePadding { get; set; }

Property Value

Type	Description
double

NodeWidth

Gets or sets the node width.

Declaration

[Parameter]
public double NodeWidth { get; set; }

Property Value

Type	Description
double

OutgoingText

Gets or sets the tooltip text for "Outgoing".

Declaration

[Parameter]
public string OutgoingText { get; set; }

Property Value

Type	Description
string

SourceLabelProperty

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

Declaration

[Parameter]
public string SourceLabelProperty { get; set; }

Property Value

Type	Description
string

SourceProperty

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

Declaration

[Parameter]
public string SourceProperty { get; set; }

Property Value

Type	Description
string

TargetLabelProperty

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

Declaration

[Parameter]
public string TargetLabelProperty { get; set; }

Property Value

Type	Description
string

TargetProperty

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

Declaration

[Parameter]
public string TargetProperty { get; set; }

Property Value

Type	Description
string

TooltipService

Gets or sets the tooltip service.

Declaration

[Inject]
public TooltipService TooltipService { get; set; }

Property Value

Type	Description
TooltipService

TooltipStyle

Gets or sets the CSS style of the tooltip.

Declaration

[Parameter]
public string TooltipStyle { get; set; }

Property Value

Type	Description
string

ValueFormatter

Gets or sets the value formatter for tooltip display.

Declaration

[Parameter]
public Func<double, string> ValueFormatter { get; set; }

Property Value

Type	Description
Func<double, string>

ValueProperty

Specifies the property of TItem which provides the flow value.

Declaration

[Parameter]
public string ValueProperty { get; set; }

Property Value

Type	Description
string

ValueText

Gets or sets the tooltip text for "Value".

Declaration

[Parameter]
public string ValueText { get; set; }

Property Value

Type	Description
string

Methods

BuildRenderTree(RenderTreeBuilder)

RadzenSankeyDiagram component.

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
RenderTreeBuilder	__builder

Overrides

ComponentBase.BuildRenderTree(RenderTreeBuilder)

Dispose()

Detaches event handlers and disposes Reference.

Declaration

public override void Dispose()

Overrides

RadzenComponent.Dispose()

GetComponentCssClass()

Gets the component CSS class.

Declaration

protected override string GetComponentCssClass()

Returns

Type	Description
string

Overrides

RadzenComponent.GetComponentCssClass()

OnAfterRenderAsync(bool)

Called by the Blazor runtime.

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Type	Name	Description
bool	firstRender

Returns

Type	Description
Task

Overrides

RadzenComponent.OnAfterRenderAsync(bool)

OnInitialized()

Called by the Blazor runtime.

Declaration

protected override void OnInitialized()

Overrides

RadzenComponent.OnInitialized()

Resize(double, double)

Called by JavaScript when the chart container is resized.

Declaration

[JSInvokable]
public Task Resize(double width, double height)

Parameters

Type	Name	Description
double	width
double	height

Returns

Type	Description
Task

SetParametersAsync(ParameterView)

Called by the Blazor runtime when parameters are set.

Declaration

public override Task SetParametersAsync(ParameterView parameters)

Parameters

Type	Name	Description
ParameterView	parameters	The parameters.

Returns

Type	Description
Task

Overrides

RadzenComponent.SetParametersAsync(ParameterView)

Implements

IComponent

IHandleEvent

IHandleAfterRender

IDisposable