Class ChartSettings

Provides options to customize the appearance and behavior of the chart rendered within the Chart Wizard.

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

This component is used within the SfChartWizard to define specific properties governing the chart's visual representation and data mapping.

Constructors

ChartSettings()

Declaration
public ChartSettings()

Properties

CategoryFields

Gets or sets the data fields used to group data along the category axis.

Declaration
[Parameter]
public List<string>? CategoryFields { get; set; }
Property Value
Type Description
List<string>

A List<T> of strings, where each string corresponds to a field name in the Datasource. The default value is null.
Remarks

These field names are used to categorize the data points along the chart's primary axis.

Examples
<SfChartWizard>
    <ChartWizardChartSettings CategoryFields="@CategoryFields" />
</SfChartWizard>
// Where @CategoryFields is new List<string> { "Region" }

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.

Datasource

Gets or sets the data source for the chart.

Declaration
[Parameter]
public IEnumerable<object>? Datasource { get; set; }
Property Value
Type Description
IEnumerable<object>

An IEnumerable<T> of objects. The default value is null.
Remarks

This data source will be used to populate the chart series. Each object in the collection typically contains fields that correspond to the CategoryFields and SeriesFields properties.

Examples
<SfChartWizard>
    <ChartWizardChartSettings Datasource="@ChartData" />
</SfChartWizard>
// Where @ChartData is an IEnumerable<object> or similar

SeriesFields

Gets or sets the list of field names from the Datasource property that will be mapped to individual series in the chart.

Declaration
[Parameter]
public List<string>? SeriesFields { get; set; }
Property Value
Type Description
List<string>

A List<T> of strings, where each string corresponds to a field name in the Datasource. The default value is null.
Remarks

Each item in this list will typically generate a separate series in the chart, mapping data columns to visual series.

Examples
<SfChartWizard>
    <ChartWizardChartSettings SeriesFields="@SeriesFields" />
</SfChartWizard>
// Where @SeriesFields is new List<string> { "Sales", "Profit" }

SeriesType

Gets or sets the series type used in the chart to render the data within the SfChartWizard component.

Declaration
[Parameter]
public ChartWizardSeriesType SeriesType { get; set; }
Property Value
Type Description
ChartWizardSeriesType

A ChartWizardSeriesType enum value. The default value is Line.
Remarks

This property determines the visual representation of the data in the generated chart, defining how data points are displayed (e.g., line, column, bar, area). The available series types are:

  • Line - Renders the chart using line series.
  • StackingLine - Renders the chart using StackingLine series, where data points are stacked cumulatively.
  • StackingLine100 - Renders the chart using 100% StackingLine series, where data points are stacked cumulatively to represent a percentage of the total.
  • Column - Renders the chart using Column series, with vertical bars representing data.
  • StackingColumn - Renders the chart using StackingColumn series, where columns are stacked cumulatively.
  • StackingColumn100 - Renders the chart using 100% StackingColumn series, where columns are stacked cumulatively to represent a percentage of the total.
  • Bar - Renders the chart using Bar series, with horizontal bars representing data.
  • StackingBar - Renders the chart using StackingBar series, where bars are stacked cumulatively.
  • StackingBar100 - Renders the chart using 100% StackingBar series, where bars are stacked cumulatively to represent a percentage of the total.
  • Area - Renders the chart using Area series, with the area beneath the line filled.
  • StackingArea - Renders the chart using StackingArea series, where areas are stacked cumulatively.
  • StackingArea100 - Renders the chart using 100% StackingArea series, where areas are stacked cumulatively to represent a percentage of the total.
  • Scatter - Renders the chart using Scatter series, with individual data points plotted as markers.
  • Pie - Renders the chart using Pie chart, representing proportions of a whole.
Examples
<SfChartWizard>
    <ChartSettings SeriesType="ChartWizardSeriesType.Column" />
</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