Class
ChartYAxisTitle

Configures the title displayed along the Y-axis to describe the vertical measurement scale and data context. Provides comprehensive control over title appearance, positioning, and styling to enhance chart understanding and accessibility. Use this component to add descriptive titles that explain the Y-axis values, units, or measurement context for improved data interpretation. Children: ChartYAxisTitleBorder, ChartYAxisTitleMargin, ChartYAxisTitlePadding.

Definition

Constructors

ChartYAxisTitle()

Declaration

cs-api-definition
public ChartYAxisTitle()

Properties

Background

Sets the background color behind the Y-axis title for enhanced visibility and professional presentation. Accepts any valid CSS color value including hex codes (#F8F8F8), RGB values (rgb(248,248,248)), or color names (lightgray). Use background colors to improve title readability over complex chart backgrounds or when the title needs to stand out clearly. Consider using semi-transparent or subtle colors that enhance readability while complementing the overall chart design and measurement context.

Declaration

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

Property Value

string

ChildContent

The content of the ChartYAxisTitle component. Children: ChartYAxisTitleBorder, ChartYAxisTitleMargin, ChartYAxisTitlePadding.

Declaration

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

Property Value

RenderFragment

Color

Specifies the text color of the Y-axis title for optimal readability and visual consistency with chart theming. Accepts any valid CSS color value including hex codes (#333333), RGB values (rgb(51,51,51)), or color names (black). Use colors that provide sufficient contrast against the chart background and title background for accessibility. Consider the overall chart color scheme to ensure the title integrates well with the visualization design and measurement presentation.

Declaration

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

Property Value

string

Font

Defines the font styling for the Y-axis title including size, family, and weight for professional typography. Accepts valid CSS font declarations such as "14px Arial", "bold 16px 'Segoe UI'", or "italic 12px sans-serif". Use appropriate font sizes that ensure readability and maintain visual hierarchy with other chart elements. Consider font consistency with your application's design system and ensure the title remains legible for measurement context and data interpretation.

Declaration

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

Property Value

string

Position

Defines the positioning of the Y-axis title relative to the axis and chart area for optimal placement and readability. Use this property to control whether the title appears at the top, center, or bottom of the axis area. Title positioning affects chart layout and can help balance the visual composition while maintaining clear measurement context. See ChartAxisTitlePosition for available positioning options and their appropriate use cases for vertical axis labeling.

Declaration

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

Property Value

ChartAxisTitlePosition?

Rotation

Sets the rotation angle for the Y-axis title in degrees to optimize space utilization and readability. Positive values rotate the title clockwise, negative values rotate counter-clockwise. Default is 0 (no rotation). Common angles include 90 degrees for vertical text along the axis, -90 degrees for inverted vertical text, or custom angles for unique presentations. Use rotation to accommodate space constraints while maintaining title readability and professional measurement context presentation.

Declaration

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

Property Value

double?

Text

Sets the text content to display as the Y-axis title for describing the vertical measurement scale and data context. Supports plain text strings that describe the data being plotted on the vertical axis such as "Value", "Amount", or "Temperature (°C)". Use descriptive titles that help users understand the meaning and units of the Y-axis values for improved chart accessibility. Clear axis titles enhance data interpretation and make measurement context more intuitive for analysis and decision-making.

Declaration

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

Property Value

string

Visible

Controls whether the Y-axis title is visible on the chart for measurement context identification and accessibility. Set to true (default) to display the title that describes the vertical axis values and measurement units. Set to false to hide the title completely for minimalist chart designs when the axis meaning is obvious from context. Hidden titles can provide more space for the plot area while relying on other means for value context and measurement identification.

Declaration

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

Property Value

bool?

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>