New to Telerik UI for Blazor? Start a free 30-day trial

ChartValueAxisPlotBandLabel

Class

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:

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

Inheritance: objectComponentBaseDataVizChildComponentChartValueAxisPlotBandLabel

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

Inherited Members DataVizChildComponent.Dispose()DataVizChildComponent.Dispose(bool)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()

public ChartValueAxisPlotBandLabel()

Methods

BuildRenderTree(RenderTreeBuilder)

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters:__builderRenderTreeBuilder

Overrides: ComponentBase.BuildRenderTree(RenderTreeBuilder)

OnAfterRender(bool)

protected override void OnAfterRender(bool firstRender)

Parameters:firstRenderbool

Overrides: ComponentBase.OnAfterRender(bool)

OnInitialized()

protected override void OnInitialized()

Overrides: DataVizChildComponent.OnInitialized()

OnParametersSet()

protected override void OnParametersSet()

Overrides: ComponentBase.OnParametersSet()

Serialize()

Dictionary<string, object>

public Dictionary<string, object> Serialize()

Returns:

Dictionary<string, object>

Properties

Align

ChartAxisPlotBandsLabelAlign?

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.

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

Background

string

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

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

ChildContent

RenderFragment

[Parameter]
public RenderFragment ChildContent { get; set; }

Color

string

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

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

Font

string

The font style of the label.

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

Position

ChartAxisPlotBandsLabelPosition?

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.

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

Rotation

double?

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

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

Text

string

The text of the label.

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

Visible

bool?

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

[Parameter]
public bool? Visible { get; set; }