DxSankey.Exported Event

Fires after the Sankey is exported.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v24.2.dll

NuGet Package: DevExpress.Blazor

Declaration

[Parameter]
public EventCallback Exported { get; set; }

Remarks

The Exported event fires after the Sankey component exports its data:

• You call the ExportToAsync(String, DataExportFormat) method.
• A user clicks one of the export commands in the Export hamburger menu.

Example

The following code snippet handles the Exported event to display information about the exported file:

Razor

@inject IJSRuntime JSRuntime

<DxSankey Data="@Data"
          @ref=@Sankey
          Exported="@OnExported"
          Width="100%"
          Height="440px"
          SourceFieldName="Source"
          TargetFieldName="Target"
          WeightFieldName="Weight">
    <DxSankeyNodeSettings Width="8" Spacing="30" />
    <DxTitleSettings Text="Commodity Turnover" />
</DxSankey>

<DxButton Text="Export to PDF" Click="@ExportToPdf" />

@code {
    DxSankey Sankey;
    string fileName = "Custom PDF";

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

    async Task ExportToPdf() {
        await Sankey.ExportToAsync(fileName, DataExportFormat.Pdf);
    }
    async Task OnExported() {
        await JSRuntime.InvokeVoidAsync("alert", $"The Sankey is exported to the {fileName} file.");
    }
}

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;
    }
}