Class
ChartValueAxisPlotBandLabel

Configures the text label displayed within or adjacent to value axis plot bands for descriptive annotations. Provides comprehensive control over label appearance, positioning, and styling to clearly identify and describe plot band purposes. Use this component to add informative text labels to plot bands, explaining their significance such as "Target Range" or "Warning Zone".

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Syntax:

cs-api-definition

public class ChartValueAxisPlotBandLabel : DataVizChildComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseDataVizChildComponentChartValueAxisPlotBandLabel

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

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

Constructors

ChartValueAxisPlotBandLabel()

Declaration

cs-api-definition

public ChartValueAxisPlotBandLabel()

Properties

Align

The position of the plotband label.The supported values are: "left" - the plotband label is positioned on the left; "right" - the plotband label is positioned on the right or "center" - the plotband label is positioned in the center.

Declaration

cs-api-definition

[Parameter]
public ChartAxisPlotBandsLabelAlign? Align { get; set; }

Property Value

ChartAxisPlotBandsLabelAlign?

Background

The background color of the label. 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 label. Accepts a valid CSS color string, including hex and rgb.

Declaration

cs-api-definition

[Parameter]
public string Color { get; set; }

Property Value

string

Font

The font style of the label.

Declaration

cs-api-definition

[Parameter]
public string Font { get; set; }

Property Value

string

Position

The position of the label.The supported values are: "top" - the axis label is positioned on the top; "bottom" - the axis label is positioned on the bottom or "center" - the axis label is positioned in the center.

Declaration

cs-api-definition

[Parameter]
public ChartAxisPlotBandsLabelPosition? Position { get; set; }

Property Value

ChartAxisPlotBandsLabelPosition?

Rotation

The rotation angle of the label. By default the label is not rotated.

Declaration

cs-api-definition

[Parameter]
public double? Rotation { get; set; }

Property Value

double?

Text

The text of the label.

Declaration

cs-api-definition

[Parameter]
public string Text { get; set; }

Property Value

string

Visible

If set to false the chart will not display the label.

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>

ClassChartValueAxisPlotBandLabel

Class
ChartValueAxisPlotBandLabel