Class
ChartSeries

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Syntax:

cs-api-definition
public class ChartSeries : ChartSeriesBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseDataVizChildComponentDataVizCollectionItemComponentChartSeriesBaseChartSeries

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

Inherited Members ComponentBase.OnInitializedAsync()ComponentBase.OnParametersSetAsync()ComponentBase.StateHasChanged()ComponentBase.ShouldRender()ComponentBase.OnAfterRenderAsync(bool)ComponentBase.InvokeAsync(Action)ComponentBase.InvokeAsync(Func<Task>)ComponentBase.SetParametersAsync(ParameterView)

Constructors

ChartSeries()

Declaration

cs-api-definition
public ChartSeries()

Properties

Aggregate

Specifies the preferred series aggregate.

Declaration

cs-api-definition
[Parameter]
public ChartSeriesAggregate? Aggregate { get; set; }

Property Value

ChartSeriesAggregate?

AutoFit

If set to true, the Chart automatically scales down to fit the content area. Applicable for the Pie and Donut series.

Declaration

cs-api-definition
[Parameter]
public bool? AutoFit { get; set; }

Property Value

bool?

Axis

The name of the value axis to use.

Declaration

cs-api-definition
[Parameter]
public string Axis { get; set; }

Property Value

string

CategoryAxis

The name of the category axis to use for the series.The first axis will be used if no categoryAxis is specified.

Declaration

cs-api-definition
[Parameter]
public string CategoryAxis { get; set; }

Property Value

string

CategoryField

The data item field which contains the category name or date.

Declaration

cs-api-definition
[Parameter]
public string CategoryField { get; set; }

Property Value

string

ChildContent

Declaration

cs-api-definition
[Parameter]
public RenderFragment ChildContent { get; set; }

Property Value

RenderFragment

CloseField

The data field containing the close value.

Declaration

cs-api-definition
[Parameter]
public string CloseField { get; set; }

Property Value

string

Color

The series base color. The supported values are: CSS color string, including hex and rgb or function(point) - user-defined function that will be evaluated for each point. Returning undefined will assume the default series color..

Declaration

cs-api-definition
[Parameter]
public string Color { get; set; }

Property Value

string

ColorField

The data item field which contains the series color.

Declaration

cs-api-definition
[Parameter]
public string ColorField { get; set; }

Property Value

string

DashType

The dash type of line chart.The following dash types are supported: "dash" - a line consisting of dashes; "dashDot" - a line consisting of a repeating pattern of dash-dot; "dot" - a line consisting of dots; "longDash" - a line consisting of a repeating pattern of long-dash; "longDashDot" - a line consisting of a repeating pattern of long-dash-dot; "longDashDotDot" - a line consisting of a repeating pattern of long-dash-dot-dot or "solid" - a solid line.

Declaration

cs-api-definition
[Parameter]
public DashType? DashType { get; set; }

Property Value

DashType?

DownColor

The series color when the open value is greater than the close value.

Declaration

cs-api-definition
[Parameter]
public string DownColor { get; set; }

Property Value

string

DownColorField

The data field containing the color applied when the open value is greater than the close value.

Declaration

cs-api-definition
[Parameter]
public string DownColorField { get; set; }

Property Value

string

DrilldownField

The data field which contains the value to use to drill down into detailed data for the point.

Declaration

cs-api-definition
[Parameter]
public string DrilldownField { get; set; }

Property Value

string

ExplodeField

The data item field which contains a boolean value indicating whether the sector is exploded.

Declaration

cs-api-definition
[Parameter]
public string ExplodeField { get; set; }

Property Value

string

Field

The data item field which contains the series value. The field name should be a valid Javascript identifier and should contain only alphanumeric characters (or "$" or "_"), and may not start with a digit.

Declaration

cs-api-definition
[Parameter]
public string Field { get; set; }

Property Value

string

For

The name of the parent series of the trendline.

Declaration

cs-api-definition
[Parameter]
public string For { get; set; }

Property Value

string

FromField

The data item field which contains the series from value.

Declaration

cs-api-definition
[Parameter]
public string FromField { get; set; }

Property Value

string

Gap

The distance between categories expressed as a percentage of the bar width.See the related spacing setting.

Declaration

cs-api-definition
[Parameter]
public double? Gap { get; set; }

Property Value

double?

HighField

The data field containing the high value.

Declaration

cs-api-definition
[Parameter]
public string HighField { get; set; }

Property Value

string

HoleSize

The radius of the donut hole in pixels.

Declaration

cs-api-definition
[Parameter]
public double? HoleSize { get; set; }

Property Value

double?

LowField

The data field containing the low value.

Declaration

cs-api-definition
[Parameter]
public string LowField { get; set; }

Property Value

string

Margin

The margin around each donut series (ring). A numeric value will set all margins.

Declaration

cs-api-definition
[Parameter]
public double? Margin { get; set; }

Property Value

double?

MissingValues

Specifies the behavior for handling missing values in the series.

Declaration

cs-api-definition
[Parameter]
public ChartSeriesMissingValues? MissingValues { get; set; }

Property Value

ChartSeriesMissingValues?

Name

The name of the chart series which is visible in the legend.

Declaration

cs-api-definition
[Parameter]
public string Name { get; set; }

Property Value

string

NegativeColor

The color to use for bar, column or waterfall series with negative values. Accepts a valid CSS color string, including hex and rgb.

Declaration

cs-api-definition
[Parameter]
public string NegativeColor { get; set; }

Property Value

string

Opacity

The series opacity. By default the series are opaque.

Declaration

cs-api-definition
[Parameter]
public double? Opacity { get; set; }

Property Value

double?

OpenField

The data field containing the open value.

Declaration

cs-api-definition
[Parameter]
public string OpenField { get; set; }

Property Value

string

Padding

The padding around the chart (equal on all sides).

Declaration

cs-api-definition
[Parameter]
public double? Padding { get; set; }

Property Value

double?

Size

The or radius of the chart donut series in pixels. If not set, the available space is split evenly between the series.

Declaration

cs-api-definition
[Parameter]
public double? Size { get; set; }

Property Value

double?

SizeField

The data field containing the bubble size value.

Declaration

cs-api-definition
[Parameter]
public string SizeField { get; set; }

Property Value

string

Spacing

The distance between series points within a category. Expressed as a percentage of the bar width.See the related gap setting.

Declaration

cs-api-definition
[Parameter]
public double? Spacing { get; set; }

Property Value

double?

StartAngle

The start angle (degrees) of the first donut or pie segment.Angles increase clockwise and zero is to the left. Negative values are acceptable.

Declaration

cs-api-definition
[Parameter]
public double? StartAngle { get; set; }

Property Value

double?

Style

Specifies the preferred rendering style.

Declaration

cs-api-definition
[Parameter]
public ChartSeriesStyle? Style { get; set; }

Property Value

ChartSeriesStyle?

SummaryField

The data item field which contains the summary type for waterfall series. Summary columns are optional and can be one of two types: "runningTotal" - Displays the sum of all items since the last "runningTotal" point. or "total" - Displays the sum of all previous items..

Declaration

cs-api-definition
[Parameter]
public string SummaryField { get; set; }

Property Value

string

ToField

The data item field which contains the series to value.

Declaration

cs-api-definition
[Parameter]
public string ToField { get; set; }

Property Value

string

Type

The type of the series.

Declaration

cs-api-definition
[Parameter]
public ChartSeriesType? Type { get; set; }

Property Value

ChartSeriesType?

Visible

Sets the visible property of a chart series

Declaration

cs-api-definition
[Parameter]
public bool? Visible { get; set; }

Property Value

bool?

VisibleInLegend

A value indicating whether to show the point category name (for funnel, donut and pie series) or series name (for other available series types) in the legend.

Declaration

cs-api-definition
[Parameter]
public bool? VisibleInLegend { get; set; }

Property Value

bool?

VisibleInLegendField

The data item field which indicates whether to show the point category name in the legend.

Declaration

cs-api-definition
[Parameter]
public string VisibleInLegendField { get; set; }

Property Value

string

Width

The line width.

Declaration

cs-api-definition
[Parameter]
public double? Width { get; set; }

Property Value

double?

XAxis

The name of the X axis to use.For polar series the xAxis range is expressed in degrees.

Declaration

cs-api-definition
[Parameter]
public string XAxis { get; set; }

Property Value

string

XField

The data item field containing the X value.

Declaration

cs-api-definition
[Parameter]
public string XField { get; set; }

Property Value

string

YAxis

The name of the Y axis to use.** Available for bubble, scatter, scatterLine and polar series. **

Declaration

cs-api-definition
[Parameter]
public string YAxis { get; set; }

Property Value

string

YField

The data item field containing the Y value.

Declaration

cs-api-definition
[Parameter]
public string YField { get; set; }

Property Value

string

ZIndex

An optional Z-index that can be used to change the default stacking order of series.The series with the highest Z-index will be placed on top.Series with no Z-index will use the default stacking order based on series type. For example line series will be on top with bar and area following below.

Declaration

cs-api-definition
[Parameter]
public double? ZIndex { get; set; }

Property Value

double?

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

cs-api-definition
protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder

RenderTreeBuilder

Overrides ComponentBase.BuildRenderTree(RenderTreeBuilder)

Dispose()

Declaration

cs-api-definition
public override void Dispose()

Overrides DataVizChildComponent.Dispose()

OnAfterRender(bool)

Declaration

cs-api-definition
protected override void OnAfterRender(bool firstRender)

Parameters

firstRender

bool

Overrides ComponentBase.OnAfterRender(bool)

OnInitialized()

Declaration

cs-api-definition
protected override void OnInitialized()

Overrides DataVizChildComponent.OnInitialized()

OnParametersSet()

Declaration

cs-api-definition
protected override void OnParametersSet()

Overrides ComponentBase.OnParametersSet()