DxSparkline.ExportToAsync(String, DataExportFormat) Method
Exports sparkline 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 |
---|---|---|
file |
String | The name of the exported file. |
#Optional Parameters
Name | Type | Default | Description |
---|---|---|---|
format | Data |
Png | The format of the exported file. |
#Returns
Type | Description |
---|---|
Value |
A structure that stores an awaitable result of an asynchronous operation. |
#Remarks
Call the ExportToAsync()
method to export sparkline data to a file in the specified format: PNG, PDF, JPEG, or SVG.
The following code snippet displays a custom Export to PDF button that exports component data to a PDF file. The button appears after the Sparkline is completely loaded. For demo purposes, the example imitates a time-consuming operation.
<DxSparkline Data="@DataSource"
@ref=@Sparkline
ArgumentFieldName="Month"
ValueFieldName="VisitorCount"
Rendered="@SparklineRendered"
Height="50px"
Width="200px">
</DxSparkline>
<DxButton Text="Export to PDF" Visible="@buttonVisible" Click="ExportToPdf" />
@code {
bool buttonVisible;
DxSparkline Sparkline;
IEnumerable<SparklineDataPoint> DataSource = Enumerable.Empty<SparklineDataPoint>();
protected override void OnInitialized() {
DataSource = GenerateData();
}
async Task SparklineRendered() {
await Task.Delay(2000);
buttonVisible = true;
}
async Task ExportToPdf () {
await Sparkline.ExportToAsync("Custom file", DataExportFormat.Pdf);
}
}