Class RadzenChart
Displays line, area, donut, pie, bar or column series.
Inherited Members
Namespace: Radzen.Blazor
Assembly: Radzen.Blazor.dll
Syntax
public class RadzenChart : RadzenComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposableExamples
<RadzenChart>
<RadzenColumnSeries Data=@revenue CategoryProperty="Quarter" ValueProperty="Revenue" />
</RadzenChart>
@code {
class DataItem
{
public string Quarter { get; set; }
public double Revenue { get; set; }
}
DataItem[] revenue = new DataItem[]
{
new DataItem { Quarter = "Q1", Revenue = 234000 },
new DataItem { Quarter = "Q2", Revenue = 284000 },
new DataItem { Quarter = "Q3", Revenue = 274000 },
new DataItem { Quarter = "Q4", Revenue = 294000 }
};
}Constructors
RadzenChart()
Displays line, area, donut, pie, bar or column series.
Declaration
public RadzenChart()Examples
<RadzenChart>
<RadzenColumnSeries Data=@revenue CategoryProperty="Quarter" ValueProperty="Revenue" />
</RadzenChart>
@code {
class DataItem
{
public string Quarter { get; set; }
public double Revenue { get; set; }
}
DataItem[] revenue = new DataItem[]
{
new DataItem { Quarter = "Q1", Revenue = 234000 },
new DataItem { Quarter = "Q2", Revenue = 284000 },
new DataItem { Quarter = "Q3", Revenue = 274000 },
new DataItem { Quarter = "Q4", Revenue = 294000 }
};
}Properties
ChildContent
Gets or sets the child content. Used to specify series and other configuration.
Declaration
[Parameter]
public RenderFragment ChildContent { get; set; }Property Value
| Type | Description |
|---|---|
| RenderFragment | The child content. |
ClickTolerance
The minimum pixel distance from a data point to the mouse cursor required for the SeriesClick event to fire. Set to 25 by default.
Declaration
[Parameter]
public int ClickTolerance { get; set; }Property Value
| Type | Description |
|---|---|
| int |
ColorScheme
Gets or sets the color scheme used to render the series.
Declaration
[Parameter]
public ColorScheme ColorScheme { get; set; }Property Value
| Type | Description |
|---|---|
| ColorScheme | The color scheme. |
Height
Gets the runtime height of the chart.
Declaration
protected double? Height { get; set; }Property Value
| Type | Description |
|---|---|
| double? |
LegendClick
A callback that will be invoked when the user clicks on a legend.
Declaration
[Parameter]
public EventCallback<LegendClickEventArgs> LegendClick { get; set; }Property Value
| Type | Description |
|---|---|
| EventCallback<LegendClickEventArgs> |
MarginBottom
Gets or sets the bottom margin of the plot area.
Declaration
protected double MarginBottom { get; set; }Property Value
| Type | Description |
|---|---|
| double |
MarginLeft
Gets or sets the left margin of the plot area.
Declaration
protected double MarginLeft { get; set; }Property Value
| Type | Description |
|---|---|
| double |
MarginRight
Gets or sets the right margin of the plot area.
Declaration
protected double MarginRight { get; set; }Property Value
| Type | Description |
|---|---|
| double |
MarginTop
Gets or sets the top margin of the plot area.
Declaration
protected double MarginTop { get; set; }Property Value
| Type | Description |
|---|---|
| double |
SeriesClick
A callback that will be invoked when the user clicks on a series.
Declaration
[Parameter]
public EventCallback<SeriesClickEventArgs> SeriesClick { get; set; }Property Value
| Type | Description |
|---|---|
| EventCallback<SeriesClickEventArgs> |
TooltipTolerance
The minimum pixel distance from a data point to the mouse cursor required by the tooltip to show. Set to 25 by default.
Declaration
[Parameter]
public int TooltipTolerance { get; set; }Property Value
| Type | Description |
|---|---|
| int |
Width
Gets the runtime width of the chart.
Declaration
protected double? Width { get; set; }Property Value
| Type | Description |
|---|---|
| double? |
Methods
BuildRenderTree(RenderTreeBuilder)
Displays line, area, donut, pie, bar or column series.
Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)Parameters
| Type | Name | Description |
|---|---|---|
| RenderTreeBuilder | __builder |
Overrides
Click(double, double)
Invoked via interop when the user clicks the RadzenChart. Raises the SeriesClick handler.
Declaration
[JSInvokable]
public Task Click(double x, double y)Parameters
| Type | Name | Description |
|---|---|---|
| double | x | The x. |
| double | y | The y. |
Returns
| Type | Description |
|---|---|
| Task |
DisplayTooltipFor(IChartSeries, object)
Displays a Tooltip on a chart without user interaction, given a series, and the data associated with it.
Declaration
public Task DisplayTooltipFor(IChartSeries series, object data)Parameters
| Type | Name | Description |
|---|---|---|
| IChartSeries | series | |
| object | data |
Returns
| Type | Description |
|---|---|
| Task |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException |
Dispose()
Detaches event handlers and disposes Reference.
Declaration
public override void Dispose()Overrides
GetComponentCssClass()
Gets the component CSS class.
Declaration
protected override string GetComponentCssClass()Returns
| Type | Description |
|---|---|
| string |
Overrides
GetSeries()
Returns the Series used by the Chart.
Declaration
public IReadOnlyList<IChartSeries> GetSeries()Returns
| Type | Description |
|---|---|
| IReadOnlyList<IChartSeries> |
MouseMove(double, double)
Invoked via interop when the user moves the mouse over the RadzenChart. Displays the tooltip.
Declaration
[JSInvokable]
public Task MouseMove(double x, double y)Parameters
| Type | Name | Description |
|---|---|---|
| double | x | The x. |
| double | y | The y. |
Returns
| Type | Description |
|---|---|
| Task |
OnAfterRenderAsync(bool)
Called by the Blazor runtime.
Declaration
protected override Task OnAfterRenderAsync(bool firstRender)Parameters
| Type | Name | Description |
|---|---|---|
| bool | firstRender |
Returns
| Type | Description |
|---|---|
| Task |
Overrides
OnInitialized()
Called by the Blazor runtime.
Declaration
protected override void OnInitialized()Overrides
Reload()
Causes all series to refresh. Use it when Data has changed.
Declaration
public Task Reload()Returns
| Type | Description |
|---|---|
| Task |
Resize(double, double)
Invoked via interop when the RadzenChart resizes. Display the series with the new dimensions.
Declaration
[JSInvokable]
public Task Resize(double width, double height)Parameters
| Type | Name | Description |
|---|---|---|
| double | width | The width. |
| double | height | The height. |
Returns
| Type | Description |
|---|---|
| Task |
SetParametersAsync(ParameterView)
Called by the Blazor runtime when parameters are set.
Declaration
public override Task SetParametersAsync(ParameterView parameters)Parameters
| Type | Name | Description |
|---|---|---|
| ParameterView | parameters | The parameters. |
Returns
| Type | Description |
|---|---|
| Task |
Overrides
ShouldRenderAxes()
Returns whether the chart should render axes.
Declaration
protected bool ShouldRenderAxes()Returns
| Type | Description |
|---|---|
| bool |
UpdateScales()
Updates the scales based on the configuration.
Declaration
protected virtual bool UpdateScales()Returns
| Type | Description |
|---|---|
| bool |