Class
ChartSeriesLabels

Telerik UI ChartSeriesLabels.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Syntax:

cs-api-definition
public class ChartSeriesLabels : DataVizChildComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseDataVizChildComponentChartSeriesLabels

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

ChartSeriesLabels()

Declaration

cs-api-definition
public ChartSeriesLabels()

Properties

Align

Specifies the alignment of the labels.

Declaration

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

Property Value

ChartSeriesLabelsAlign?

AriaTemplate

The name of the JS function, which returns the ARIA content of the series point.

Declaration

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

Property Value

string

Background

The background color of the labels. Accepts a valid CSS color string, including hex and rgb.

Declaration

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

Property Value

string

ChildContent

Declaration

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

Property Value

RenderFragment

Color

The text color of the labels. Accepts a valid CSS color string, including hex and rgb.

Declaration

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

Property Value

string

Distance

The distance of the labels when series.type is set to "donut" or "pie".

Declaration

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

Property Value

double?

Font

The font style of the labels. Accepts a valid CSS font string, for example "20px Courier New'".

Declaration

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

Property Value

string

Format

The format of the labels. Uses kendo.format.Format placeholders: Area, bar, column, line, pie, radarArea, radarColumn and radarLine{0} - value; Bubble{0} - x value{1} - y value{2} - size value{3} - category name; Bullet{0} - value{1} - target value; Scatter, scatterLine{0} - x value{1} - y value; PolarArea, polarLine and polarScatter{0} - x value (degrees){1} - y value; Candlestick and OHLC{0} - open value{1} - high value{2} - low value{3} - close value{4} - category name or RangeArea, rangeBar, rangeColumn{0} - from value{1} - to value.

Declaration

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

Property Value

string

Position

Specifies the position of the labels.

Declaration

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

Property Value

ChartSeriesLabelsPosition?

Rotation

The rotation angle of the labels. By default, the labels are not rotated.

Declaration

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

Property Value

string

Template

The template which renders the chart series label.The fields which can be used in the template are: category - the category name. Available for area, bar, column, bubble, donut, line, pie and waterfall series.; dataItem - the original data item used to construct the point. Will be null if binding to array.; percentage - the point value represented as a percentage value. Available only for donut, pie and 100% stacked charts.; series - the data series; stackValue - the cumulative point value on the stack. Available only for stackable series.; value - the point value. Can be a number or object containing each bound field.; runningTotal - the sum of point values since the last "runningTotal" summary point. Available for waterfall series. or total - the sum of all previous series values. Available for waterfall series..

Declaration

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

Property Value

string

Visible

If set to true the chart will display the series labels. By default chart series labels are not displayed.

Declaration

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

Property Value

bool?

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

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

Parameters

__builder

RenderTreeBuilder

Overrides ComponentBase.BuildRenderTree(RenderTreeBuilder)

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

Serialize()

Declaration

cs-api-definition
public Dictionary<string, object> Serialize()

Returns

Dictionary<string, object>