Class
ChartCategoryAxisPlotBand

Defines a highlighted region (plot band) on the category axis in ChartCategoryAxisPlotBands. Use this component to visually emphasize specific ranges of categories or time periods, such as weekends, holidays, target zones, or normal operating ranges. Plot bands appear as colored background regions that help users identify important data patterns or contextual information. Configure the range using From/To positions and customize appearance with colors, opacity, and optional labels. Children: ChartCategoryAxisPlotBandLabel.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Syntax:

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

Inheritance: objectComponentBaseDataVizChildComponentDataVizCollectionItemComponentChartCategoryAxisPlotBand

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

ChartCategoryAxisPlotBand()

Declaration

cs-api-definition
public ChartCategoryAxisPlotBand()

Properties

ChildContent

The content of the ChartCategoryAxisPlotBand component. Children: ChartCategoryAxisPlotBandLabel.

Declaration

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

Property Value

RenderFragment

Color

Sets the background color of the plot band. Accepts any valid CSS color including hex codes (#F0F8FF), RGB values (rgb(240,248,255)), named colors (lightblue), or HSL values. Plot bands are typically semi-transparent colored regions that highlight specific ranges of data, such as target zones, normal ranges, or time periods of interest.

Declaration

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

Property Value

string

From

Defines the starting position of the plot band along the category axis. Use category values for categorical data (like "January", "Product A") or date/time values for time-based axes. The plot band will extend from this position to the To position, creating a highlighted region across the specified range.

Declaration

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

Property Value

object

Opacity

Controls the transparency of the plot band using values from 0.0 (completely transparent) to 1.0 (completely opaque). Common values include 0.1-0.3 for subtle background highlighting, 0.5 for moderate emphasis, or 0.7-0.9 for strong visual distinction. Lower opacity allows underlying chart elements to remain visible.

Declaration

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

Property Value

double?

To

Defines the ending position of the plot band along the category axis. Use category values for categorical data (like "December", "Product Z") or date/time values for time-based axes. The plot band will extend from the From position to this position, creating a highlighted region that spans the specified range.

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