Class
ChartCategoryAxisPlotBandLabelBorder

Configures the border appearance around plot band labels in ChartCategoryAxisPlotBandLabel. Use this component to add visual emphasis to plot band label text by defining border color, style pattern, and thickness. Borders improve label readability when the label overlaps with complex chart backgrounds or plot band colors, and help distinguish plot band annotations from other chart elements.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Syntax:

cs-api-definition
public class ChartCategoryAxisPlotBandLabelBorder : DataVizChildComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseDataVizChildComponentChartCategoryAxisPlotBandLabelBorder

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

ChartCategoryAxisPlotBandLabelBorder()

Declaration

cs-api-definition
public ChartCategoryAxisPlotBandLabelBorder()

Properties

ChildContent

Declaration

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

Property Value

RenderFragment

Color

Sets the border color around plot band labels. Accepts any valid CSS color including hex codes (#333333), RGB values (rgb(51,51,51)), named colors (darkgray), or HSL values. Use borders to create visual emphasis around plot band labels, improve readability against complex backgrounds, or establish visual hierarchy in charts with multiple plot bands.

Declaration

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

Property Value

string

DashType

Defines the line style pattern for the plot band label border using DashType values. Choose from various patterns: Solid for continuous borders, Dash for dashed outlines, Dot for dotted borders, DashDot for alternating dashes and dots, LongDash for longer dash segments, LongDashDot for long dashes with dots, and LongDashDotDot for complex patterns. Different patterns help distinguish plot band labels from other chart elements.

Declaration

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

Property Value

DashType?

Width

Controls the thickness of the plot band label border in pixels. Set to 0 (default) to hide the border completely, or use positive values like 1-2 pixels for subtle outlines, or larger values for prominent borders. Combine with Color and DashType to create custom label styling that enhances plot band identification.

Declaration

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

Property Value

double?

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>