DxSankey.ExportToAsync(String, DataExportFormat) Method
Exports Sankey data to a file in the specified format.
Namespace: DevExpress.Blazor
Assembly: DevExpress.Blazor.v24.2.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.
<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);
}
}