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

ChartSubtitle

Class

Configures the chart subtitle display and styling to provide additional context and information below the main chart title. Controls subtitle text, appearance, positioning, and layout to enhance chart communication and provide supplementary details for comprehensive data presentation. Children: ChartSubtitleBorder, ChartSubtitleMargin, ChartSubtitlePadding.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Syntax:

public class ChartSubtitle : DataVizChildComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseDataVizChildComponentChartSubtitle

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

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

ChartSubtitle()

public ChartSubtitle()

Methods

BuildRenderTree(RenderTreeBuilder)

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters:__builderRenderTreeBuilder

Overrides: ComponentBase.BuildRenderTree(RenderTreeBuilder)

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

Serialize()

Dictionary<string, object>

public Dictionary<string, object> Serialize()

Returns:

Dictionary<string, object>

Properties

Align

ChartSubtitleAlign?

Determines the horizontal text alignment for the subtitle using ChartSubtitleAlign values. Choose from left, center, or right alignment to match the overall chart layout and design requirements for professional presentation.

[Parameter]
public ChartSubtitleAlign? Align { get; set; }

Background

string

Sets the background color for the chart subtitle using any valid CSS color value. Accepts hex codes (#F5F5F5), RGB values (rgb(245, 245, 245)), named colors (lightgray, white), or HSL values. Use subtle background colors to enhance subtitle visibility without overwhelming the chart content.

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

Color

string

Sets the text color for the chart subtitle using any valid CSS color value. Accepts hex codes (#616161), RGB values (rgb(97, 97, 97)), named colors (gray, black), or HSL values. Choose colors that provide good contrast and maintain the subtitle's secondary role to the main title.

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

Font

string

Defines the font styling for the subtitle text using CSS font notation. Specify font size, family, and style like "14px Arial", "16px 'Segoe UI'", or "italic 15px sans-serif". Subtitle fonts are typically smaller than main titles but larger than body text.

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

Position

ChartSubtitlePosition?

Specifies the positioning of the subtitle relative to the chart using ChartSubtitlePosition values. Control whether the subtitle appears above or below the chart content for optimal layout and visual hierarchy in chart presentations.

[Parameter]
public ChartSubtitlePosition? Position { get; set; }

Text

string

Specifies the subtitle text content to display below the main chart title. Use concise, descriptive text that provides additional context, data source information, time periods, or other relevant details that enhance chart understanding without cluttering the visualization.

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

Visible

bool?

Controls the visibility of the chart subtitle. Set to true to display the subtitle, false to hide it, or leave null for default behavior. Subtitles provide valuable context but can be hidden for cleaner presentations when additional information isn't needed.

[Parameter]
public bool? Visible { get; set; }