Class
StockChartSeries

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Syntax:

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

Inheritance: objectComponentBaseDataVizChildComponentDataVizCollectionItemComponentChartSeriesBaseStockChartSeries

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

StockChartSeries()

Declaration

cs-api-definition
public StockChartSeries()

Properties

Aggregate

The aggregate function to apply for date series.This function is used when a category (an year, month, etc.) contains two or more points. The function return value is displayed instead of the individual points.The supported values are: "avg" - the average of all values for the date period.; "count" - the number of values for the date period.; "max" - the highest value for the date period.; "min" - the lowest value for the date period.; "sum" - the sum of all values for the date period. Defaults to 0 if no data points are defined.; "sumOrNull" - the sum of all values for the date period. Defaults to null if no data points are defined.; "first" - the first value; function(values, series, dataItems, category) - user-defined aggregate function. Returns single value or data item. or object - (compound aggregate) Applicable to "candlestick" and ohlc "series". Specifies the aggregate for each data item field..

Declaration

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

Property Value

ChartSeriesAggregate?

Axis

The name of the value axis to use.** Applicable to area, column, line, ohlc and candlestick series **

Declaration

cs-api-definition
[Parameter]
public string Axis { 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.** Available for candlestick and ohlc series only **

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 field containing the point color.** Applicable for column, candlestick and ohlc series. **

Declaration

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

Property Value

string

DashType

The series line dash type.** Applicable only to line series **

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.** Available for candlestick series only **

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.** Available for candlestick series only **

Declaration

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

Property Value

string

Field

The data field containing the series value.

Declaration

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

Property Value

string

Gap

The distance between category clusters.** Applicable for column, candlestick and ohlc series. **

Declaration

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

Property Value

double?

HighField

The data field containing the high value.** Available for candlestick and ohlc series only **

Declaration

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

Property Value

string

LowField

The data field containing the low value.** Available for candlestick and ohlc series **

Declaration

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

Property Value

string

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 series name visible in the legend.

Declaration

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

Property Value

string

Opacity

The series opacity.

Declaration

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

Property Value

double?

OpenField

The data field containing the open value.** Available for candlestick and ohlc series **

Declaration

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

Property Value

string

Spacing

Space between points as proportion of the point width.Available for column, candlestick and ohlc series.

Declaration

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

Property Value

double?

Style

Specifies the preferred rendering style.

Declaration

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

Property Value

ChartSeriesStyle?

Type

The type of the series.

Declaration

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

Property Value

StockChartSeriesType?

Width

The line width.** Applicable for area and line series. **

Declaration

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

Property Value

double?

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()