Class
ChartYAxisPlotBand

Represents a plot band that highlights specific value ranges on the Y-axis with colored background areas. Provides comprehensive configuration for creating visual emphasis zones that help users identify important value ranges, thresholds, or measurement limits. Use this component to highlight critical ranges, mark target zones, or create visual indicators that enhance value interpretation and analysis.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Syntax:

cs-api-definition
public class ChartYAxisPlotBand : DataVizCollectionItemComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseDataVizChildComponentDataVizCollectionItemComponentChartYAxisPlotBand

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

ChartYAxisPlotBand()

Declaration

cs-api-definition
public ChartYAxisPlotBand()

Properties

ChildContent

The content of the ChartYAxisPlotBand component. Children: ChartYAxisPlotBandLabel.

Declaration

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

Property Value

RenderFragment

Color

Specifies the background color of the plot band area on the Y-axis. Accepts any valid CSS color value including hex codes (#E6FFE6), RGB values (rgb(230,255,230)), or color names (lightgreen). Use colors that provide sufficient contrast for readability while highlighting the intended value range without overwhelming chart data. Consider using semi-transparent colors or subtle tints to maintain data visibility within the highlighted measurement area.

Declaration

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

Property Value

string

From

Defines the starting value position of the plot band along the Y-axis in axis units. For numeric axes, specify the numeric value where the plot band begins (e.g., 10 for value-based highlighting). For date axes, provide a DateTime value or date string for the start position. This property works with the To property to define the complete value range that will be highlighted by the plot band.

Declaration

cs-api-definition
[Parameter]
public object From { get; set; }

Property Value

object

Opacity

Sets the transparency level of the plot band from 0 (completely transparent) to 1 (completely opaque). Use values between 0.1-0.3 for subtle highlighting that doesn't interfere with data visibility and value reading. Higher opacity values (0.5-0.8) create more prominent emphasis zones for critical value ranges or thresholds. Balance opacity with color choice to achieve the desired visual impact while maintaining chart readability and data clarity.

Declaration

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

Property Value

double?

To

Defines the ending value position of the plot band along the Y-axis in axis units. For numeric axes, specify the numeric value where the plot band ends (e.g., 50 for value-based highlighting). For date axes, provide a DateTime value or date string for the end position. This property works with the From property to define the complete value range that will be highlighted by the plot band.

Declaration

cs-api-definition
[Parameter]
public object To { get; set; }

Property Value

object

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

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

Parameters

__builder

RenderTreeBuilder

Overrides ComponentBase.BuildRenderTree(RenderTreeBuilder)

Dispose(bool)

Declaration

cs-api-definition
protected override void Dispose(bool disposing)

Parameters

disposing

bool

Overrides DataVizChildComponent.Dispose(bool)

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