Class
ChartYAxis

Configures a vertical axis in a Telerik Chart that displays value measurements and provides scale reference for data interpretation. Provides comprehensive control over vertical axis appearance, scaling, labeling, and positioning to enhance chart precision and user understanding. Use this component to create professional value axes that help users accurately read measurements, compare data points, and interpret chart information. Children: ChartYAxisLabels, ChartYAxisLine, ChartYAxisMajorGridLines, ChartYAxisMinorGridLines, ChartYAxisMajorTicks, ChartYAxisMinorTicks, ChartYAxisTitle, ChartYAxisPlotBands.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Syntax:

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

Inheritance: objectComponentBaseDataVizChildComponentDataVizCollectionItemComponentChartYAxis

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

ChartYAxis()

Declaration

cs-api-definition
public ChartYAxis()

Properties

AxisCrossingValue

Defines the value positions where other axes cross this Y-axis for multi-axis chart configurations. For numeric axes, specify numeric values; for date axes, provide DateTime objects; for arrays, use index positions. Use this property to control axis intersection points and create professional multi-axis layouts with proper value alignment. Essential for charts displaying multiple data series with different value scales or measurement units on separate axes.

Declaration

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

Property Value

object[]

Background

Sets the background color of the entire Y-axis area for enhanced visual definition and professional presentation. Accepts any valid CSS color value including hex codes (#F8F8F8), RGB values (rgb(248,248,248)), or color names (whitesmoke). Use subtle background colors to create visual separation between the axis and chart plot area without overwhelming data visibility. Consider using this property to highlight specific axes in multi-axis charts or create branded chart designs.

Declaration

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

Property Value

string

BaseUnit

Specifies the base time interval for date-based Y-axis labels when working with chronological data. Available options include milliseconds, seconds, minutes, hours, days, weeks, months, and years. The system automatically determines the optimal baseUnit from your data range, but you can override for specific needs. Use this property to ensure consistent time intervals and proper date formatting in time-series charts with vertical date axes.

Declaration

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

Property Value

string

Categories

Defines category names for the Y-axis when creating categorical charts such as heatmaps with both X and Y category axes. Provide an array of category labels that will be displayed along the vertical axis for categorical data representation. Use this property for charts where the Y-axis represents discrete categories rather than continuous numeric or date values. Essential for heatmaps, bubble charts, and other visualizations requiring categorical organization on both axes.

Declaration

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

Property Value

object[]

ChildContent

Declaration

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

Property Value

RenderFragment

Color

Specifies the primary color of the Y-axis line and associated elements for consistent visual theming. Accepts any valid CSS color value including hex codes (#333333), RGB values (rgb(51,51,51)), or color names (black). This color affects the main axis line, tick marks, and other axis elements unless specifically overridden in their individual configurations. Use this property to ensure axis colors align with your chart theme and provide sufficient contrast for professional presentation.

Declaration

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

Property Value

string

MajorUnit

Defines the interval between major divisions and reference points along the Y-axis for precise value measurement. For numeric axes, specifies the value increment between major grid lines and tick marks (e.g., 10 for increments of 10). For date axes, represents the number of baseUnits between major divisions (e.g., 7 days for weekly intervals). For logarithmic axes, this value becomes the base of the logarithm for exponential scaling. Use this property to control measurement precision and ensure appropriate value resolution for your data range.

Declaration

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

Property Value

double?

Max

Sets the maximum value displayed on the Y-axis to control the upper limit of the measurement scale. For numeric axes, provide a numeric value; for date axes, use DateTime objects or date strings. When not specified, the maximum is automatically calculated from your data range with appropriate padding. Use this property to ensure consistent scaling across multiple charts or to focus on specific value ranges for detailed analysis.

Declaration

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

Property Value

object

Min

Sets the minimum value displayed on the Y-axis to control the lower limit of the measurement scale. For numeric axes, provide a numeric value; for date axes, use DateTime objects or date strings. When not specified, the minimum is automatically calculated from your data range with appropriate padding. Use this property to ensure consistent scaling across multiple charts or to eliminate unnecessary empty space in the visualization.

Declaration

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

Property Value

object

MinorUnit

Defines the interval between minor divisions for enhanced measurement precision and detailed value reference. Defaults to 1/5 of the majorUnit value to provide appropriate subdivision density without overwhelming the chart. For logarithmic axes, represents the number of divisions between major units (defaults to major unit minus one). Use this property to create finer measurement increments that help users identify precise intermediate values.

Declaration

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

Property Value

double?

Name

Assigns a unique identifier to this Y-axis for multi-axis chart configurations and series association. Use this name to associate specific data series with this axis using the series' yAxis property. Essential for charts displaying multiple datasets with different value scales, units, or measurement ranges on separate vertical axes. Provides the foundation for creating complex charts with multiple measurement systems and professional multi-axis presentations.

Declaration

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

Property Value

string

NarrowRange

Controls whether the automatic axis range snaps to zero for optimized value presentation and measurement accuracy. When set to true, prevents automatic zero-snapping to show focused data ranges without unnecessary empty space. When set to false, forces the axis range to include zero for consistent baseline reference and comparative analysis. Use true for detailed analysis of narrow value ranges, false for charts requiring zero-baseline context and proportional comparison.

Declaration

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

Property Value

bool?

Reverse

Reverses the direction of value progression along the Y-axis for specialized data presentations and analysis needs. When set to true, values decrease from bottom to top instead of the standard bottom-to-top increase. Use this property for specific visualization requirements such as depth charts, inverted rankings, or data that naturally flows downward. Maintains all measurement accuracy and precision while providing alternative visual perspective for your data interpretation.

Declaration

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

Property Value

bool?

Type

Specifies the data type and scaling method for the Y-axis to ensure appropriate value representation and measurement precision. Supported values include "numeric" for standard numerical data, "date" for chronological data with time-based scaling, and "log" for logarithmic scaling of exponential data patterns. Choose the appropriate type to match your data characteristics and ensure optimal value presentation and analysis capabilities.

Declaration

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

Property Value

string

Visible

Controls whether the Y-axis is displayed on the chart for value measurement and data interpretation. Set to true (default) to show the axis with labels, grid lines, and tick marks for precise value reading. Set to false to hide the axis completely for minimalist presentations while maintaining data series positioning. Hidden axes can provide more space for data visualization while relying on tooltips or other means for value 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)

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