Skip to main content
All docs
V25.1
  • DxSankey.Palette Property

    Specifies the color scheme for Sankey nodes.

    Namespace: DevExpress.Blazor

    Assembly: DevExpress.Blazor.v25.1.dll

    NuGet Package: DevExpress.Blazor

    Declaration

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

    Property Value

    Type Description
    String[]

    An array of colors.

    Remarks

    The DxSankey component allows you to create a custom palette for nodes. To apply a palette, assign it to the Palette property.

    The Palette property accepts the following formats:

    • Longhand and shorthand hexadecimal color values: #ffff00, #ff0.
    • RGB and RGBA color codes: rgb(255, 0, 0), rgba(0, 230, 0, 0.3).
    • HTML color name (case-insensitive): red, DarkGreen.

    When the number of nodes exceeds the number of palette colors, you can use the PaletteExtensionMode property to specify how to extend the palette.

    The DxSankey component also allows you to customize the node color through the DxSankeyNodeSettings.Color property.

    <DxSankey Data="@Data"
              SourceFieldName="Source"
              TargetFieldName="Target"
              WeightFieldName="Weight">
        <DxSankeyNodeSettings Color="red" />
        @* ... *@
    </DxSankey>
    

    Note that the DxSankeyNodeSettings.Color property has priority over DxSankey.Palette.

    Example

    The following code snippet applies a custom palette to Sankey nodes and changes the palette’s extension mode:

    DxSankey - Apply a custom palette

    <DxSankey Data="@Data"
              Width="100%"
              Height="440px"
              SourceFieldName="Source"
              TargetFieldName="Target"
              WeightFieldName="Weight"
              Palette="@(new string[]{"red", "blue"})"
              PaletteExtensionMode="PaletteExtensionMode.Blend">
        <DxSankeyNodeSettings Width="8" Spacing="30" />
        <DxTitleSettings Text="Commodity Turnover" />
    </DxSankey>
    
    @code {
        IEnumerable<SankeyDataPoint> Data = Enumerable.Empty<SankeyDataPoint>();
        protected override void OnInitialized() {
            Data = GenerateData();
        }
    }
    
    See Also