DxSankeyLabelSettings.UseNodeColors Property

Specifies whether to apply the node color to the node label’s text.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v24.2.dll

NuGet Package: DevExpress.Blazor

Declaration

[DefaultValue(false)]
[Parameter]
public bool UseNodeColors { get; set; }

Property Value

Type	Default	Description
Boolean	false	true to apply node colors to corresponding label captions; false to use the DxFontSettings.Color property value as the label text color.

Remarks

The DxSankey component uses the DxFontSettings.Color property to determine the label text color.

<DxSankey Data="@Data"
          SourceFieldName="Source"
          TargetFieldName="Target"
          WeightFieldName="Weight">
    <DxSankeyLabelSettings HorizontalOffset="20">
        <DxFontSettings Color="white"/>
    </DxSankeyLabelSettings>
    @* ... *@
</DxSankey>

You can set the UseNodeColors property to true to apply node colors to corresponding node label captions. The DxSankey component allows you to specify node colors through the DxSankey.Palette or DxSankeyNodeSettings.Color property.

<DxSankey Data="@Data"
          SourceFieldName="Source"
          TargetFieldName="Target"
          WeightFieldName="Weight"
          Palette="@(new string[]{"red", "blue", "green"})">
    @* Or *@
    <DxSankeyNodeSettings Color="red" />
</DxSankey>

Example

The following code snippet applies node colors to corresponding node label captions:

Razor

<DxSankey Data="@Data"
          Width="100%"
          Height="440px"
          SourceFieldName="Source"
          TargetFieldName="Target"
          WeightFieldName="Weight">
    <DxSankeyNodeSettings Width="8" Spacing="30" />
    <DxSankeyLabelSettings UseNodeColors="true"/>
    <DxSankeyLinkSettings ColorMode="SankeyLinkColorMode.Gradient" />
    <DxTitleSettings Text="Commodity Turnover" />
</DxSankey>

@code {
    IEnumerable<SankeyDataPoint> Data = Enumerable.Empty<SankeyDataPoint>();
    protected override void OnInitialized() {
        Data = GenerateData();
    }
}

DataSource

public List<SankeyDataPoint> GenerateData() {
    return new List<SankeyDataPoint>() {
        new SankeyDataPoint("Spain", "United States of America", 2),
        new SankeyDataPoint("Germany", "United States of America", 8),
        new SankeyDataPoint("France", "United States of America", 4),
        new SankeyDataPoint("Germany", "Great Britain", 2),
        new SankeyDataPoint("France", "Great Britain", 4),
        new SankeyDataPoint("United States of America", "Australia", 6),
        new SankeyDataPoint("United States of America", "New Zealand", 5),
        new SankeyDataPoint("United States of America", "Japan", 3),
        new SankeyDataPoint("Great Britain", "New Zealand", 4),
        new SankeyDataPoint("Great Britain", "Japan", 1),
    };
}
public class SankeyDataPoint {
    public string Source { get; set; }
    public string Target { get; set; }
    public int Weight { get; set; }
    public SankeyDataPoint(string source, string target, int weight) {
        Source = source;
        Target = target;
        Weight = weight;
    }
}