Class
ChartXAxisPlotBandLabelBorder

Configures the border styling for X-axis plot band labels. Provides comprehensive control over border appearance including color, line style, and thickness to enhance label visibility and professional presentation. Use this component to create clear visual separation between labels and plot band backgrounds, improving readability and chart aesthetics.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Syntax:

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

Inheritance: objectComponentBaseDataVizChildComponentChartXAxisPlotBandLabelBorder

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

ChartXAxisPlotBandLabelBorder()

Declaration

cs-api-definition
public ChartXAxisPlotBandLabelBorder()

Properties

ChildContent

Declaration

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

Property Value

RenderFragment

Color

Specifies the color of the plot band label border. Accepts any valid CSS color value including hex codes (#000000), RGB values (rgb(0,0,0)), or color names (black). Use colors that provide sufficient contrast against both the label background and plot band color for optimal readability. Consider using darker colors for borders to create clear definition around label text.

Declaration

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

Property Value

string

DashType

Defines the line pattern for the plot band label border using predefined dash styles. Available options include solid lines for standard professional borders, dashed patterns for stylized presentations, and dotted lines for subtle label definition. Choose dash types that complement the overall chart design while ensuring clear label boundary definition. See DashType for all available line pattern options.

Declaration

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

Property Value

DashType?

Width

Sets the thickness of the plot band label border in pixels. Use thin borders (1-2 pixels) for subtle label definition or thicker borders (2-3 pixels) for more prominent label emphasis. A value of 0 removes the border entirely, which is useful when relying on background color contrast for label visibility. Balance border width with label size and chart scale for optimal visual hierarchy.

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>