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

ChartXAxisPlotBand

Class

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

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Syntax:

public class ChartXAxisPlotBand : DataVizCollectionItemComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseDataVizChildComponentDataVizCollectionItemComponentChartXAxisPlotBand

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

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

ChartXAxisPlotBand()

public ChartXAxisPlotBand()

Methods

BuildRenderTree(RenderTreeBuilder)

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters:__builderRenderTreeBuilder

Overrides: ComponentBase.BuildRenderTree(RenderTreeBuilder)

Dispose(bool)

protected override void Dispose(bool disposing)

Parameters:disposingbool

Overrides: DataVizChildComponent.Dispose(bool)

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

Properties

ChildContent

RenderFragment

The content of the ChartXAxisPlotBand component. Children: ChartXAxisPlotBandLabel.

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

Color

string

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

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

From

object

Defines the starting position of the plot band along the X-axis in axis units. For category axes, specify the category index or name where the plot band begins. 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 range that will be highlighted by the plot band.

[Parameter]
public object From { get; set; }

Opacity

double?

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. Higher opacity values (0.5-0.8) create more prominent emphasis zones for critical ranges. Balance opacity with color choice to achieve the desired visual impact while maintaining chart readability.

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

To

object

Defines the ending position of the plot band along the X-axis in axis units. For category axes, specify the category index or name where the plot band ends. 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 range that will be highlighted by the plot band.

[Parameter]
public object To { get; set; }