DxSankey.ExportToAsync(String, DataExportFormat) Method

Exports Sankey data to a file in the specified format.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v25.1.dll

NuGet Package: DevExpress.Blazor

Declaration

public ValueTask ExportToAsync(
    string fileName,
    DataExportFormat format = DataExportFormat.Png
)

Parameters

Name	Type	Description
fileName	String	The name of the exported file.

Optional Parameters

Name	Type	Default	Description
format	DataExportFormat	Png	The format of the exported file.

Returns

Type	Description
ValueTask	A structure that stores an awaitable result of an asynchronous operation.

Remarks

Call the ExportToAsync() method to export Sankey data to a file in the specified format: PNG, PDF, JPEG, or SVG.

After you call the ExportToAsync() method, the component raises the Exported event.

Example

The following code snippet displays a custom Export to PDF button that exports Sankey data to a PDF file. The button appears after the component is completely loaded. For demo purposes, the example imitates a time-consuming operation.

Razor

<DxSankey Data="@Data"
          @ref=@Sankey
          Rendered="@SankeyRendered"
          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" Visible="@buttonVisible" Click="@ExportToPdf" />

@code {
    DxSankey Sankey;
    bool buttonVisible;

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

    async Task SankeyRendered() {
        await Task.Delay(2000);
        buttonVisible = true;
    }
    async Task ExportToPdf() {
        await Sankey.ExportToAsync("Custom file", DataExportFormat.Pdf);
    }
}

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