Class ChartExportSettings

Provides options to customize the export behavior of the chart within the Chart Wizard.

Inheritance
object
ComponentBase
OwningComponentBase
SfOwningComponentBase
SfBaseComponent
SfDataBoundComponent
ChartExportSettings
Implements
Inherited Members
Namespace: Syncfusion.Blazor.ChartWizard
Assembly: Syncfusion.Blazor.dll
Syntax
public class ChartExportSettings : SfDataBoundComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable
Remarks

This component is used within the SfChartWizard to configure export-specific properties such as file name, image dimensions, and PDF orientation.

Constructors

ChartExportSettings()

Declaration
public ChartExportSettings()

Properties

ChildContent

Sets and gets the content of the UI element.

Declaration
[Parameter]
[JsonIgnore]
public RenderFragment? ChildContent { get; set; }
Property Value
Type Description
RenderFragment

A RenderFragment representing the child content. The default value is null.

FileName

Gets or sets the name for the exported file.

Declaration
[Parameter]
public string FileName { get; set; }
Property Value
Type Description
string

A string representing the file name. The default value is string.Empty.
Remarks

The specified name will be used as the filename when the chart is exported.

Examples
<ChartExportSettings FileName="SalesReport" />

Height

Gets or sets the height of the exported image dimension for the SfChartWizard component.

Declaration
[Parameter]
public double Height { get; set; }
Property Value
Type Description
double

A double value representing the height in pixels. The default value is double.NaN.
Remarks

This property specifies the height of the chart when it is exported. If the value is set to double.NaN (the default), the exported file will have the chart's default rendered height. Changing this value updates the chart’s height in the exported file. Note that this property is not applicable for XLSX and CSV export formats.

Examples
<SfChartWizard>
    <ChartExportSettings Height="768" />
</SfChartWizard>

Orientation

Gets or sets the orientation to export the PDF file for the SfChartWizard component.

Declaration
[Parameter]
public PageOrientation Orientation { get; set; }
Property Value
Type Description
PageOrientation

A PageOrientation enum value. The default value is Portrait.
Remarks

This property is applicable only when exporting the chart to a PDF format. This enumeration controls how the chart is laid out when exported to PDF. The available orientations are:

  • Portrait - Specifies that the PDF page is oriented vertically.
  • Landscape - Specifies that the PDF page is oriented horizontally.
As noted, the default orientation is Portrait.
Examples
<SfChartWizard>
    <ChartExportSettings Orientation="PageOrientation.Landscape" />
</SfChartWizard>

Width

Gets or sets the width of the exported image dimension for the SfChartWizard component.

Declaration
[Parameter]
public double Width { get; set; }
Property Value
Type Description
double

A double value representing the width in pixels. The default value is double.NaN.
Remarks

This property specifies the width of the chart when it is exported. If the value is set to double.NaN (the default), the exported file will have the chart's default rendered width. Changing this value updates the chart’s width in the exported file. Note that this property is not applicable for XLSX and CSV export formats.

Examples
<SfChartWizard>
    <ChartExportSettings Width="1024" />
</SfChartWizard>

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
RenderTreeBuilder __builder
Overrides

OnParametersSetAsync()

Executes when component parameters are set.

Declaration
protected override Task OnParametersSetAsync()
Returns
Type Description
Task

A task that represents the asynchronous operation.
Overrides

Implements