Class ChartAxis

Inheritance

System.Object

ChartSubComponent

ChartAxis

ChartPrimaryXAxis

ChartPrimaryYAxis

Inherited Members

ChartSubComponent.BuildRenderTree(RenderTreeBuilder)

ChartSubComponent.ChildContent

ChartSubComponent.Dispose(Boolean)

ChartSubComponent.PopSubcomponent()

ChartSubComponent.PushSubcomponent()

Namespace: Syncfusion.Blazor.Charts

Assembly: Syncfusion.Blazor.dll

Syntax

public class ChartAxis : ChartSubComponent, ISubcomponentTracker, IChartElement

Constructors

ChartAxis()

Declaration

public ChartAxis()

Properties

Border

Gets or sets an instance of ChartAxisLabelBorder that specifies the border for the axis labels.

Declaration

public ChartAxisLabelBorder Border { get; set; }

Property Value

Type	Description
ChartAxisLabelBorder	An instance of ChartAxisLabelBorder.

Remarks

This property can be used to customize the border for axis labels.

Coefficient

Gets or sets the radius for polar and radar series charts.

Declaration

public double Coefficient { get; set; }

Property Value

Type	Description
System.Double	The double value represents the radius for polar and radar series charts. The default value is 100.

Remarks

Applicable only for Polar and Radar series type charts.

ColumnIndex

Gets or sets the index of the column with which the axis is associated.

Declaration

public double ColumnIndex { get; set; }

Property Value

Type	Description
System.Double	The index of the column associated with the axis. The default value is 0.

Remarks

This property is applicable only when the chart area is divided into multiple plot areas using the ChartColumns. To bind a horizonatal axis to a specific column, set the axis’s ColumnIndex property to that column’s index.

CrossesAt

Gets or sets the value (numeric, datetime, or logarithmic) at which the horizontal axis line intersects with the vertical axis or vice versa.

Declaration

public object CrossesAt { get; set; }

Property Value

Type	Description
System.Object	The value at which the horizontal axis line intersects with the vertical axis or vice versa. The default value is null.

Remarks

If the ValueType of the horizontal axis is ValueType.Category, the CrossesAt value for the vertical axis is accepted as a numeric value, which will be considered as the index of horizontal axis labels.

CrossesInAxis

Gets or sets the name of the axis with which the axis line is to be crossed.

Declaration

public string CrossesInAxis { get; set; }

Property Value

Type	Description
System.String	The name of the axis with which the axis line is crossed.

Remarks

Applicable only when CrossesAt is provided with a value.

CrosshairTooltip

Gets or sets an instance of ChartAxisCrosshairTooltip that controls the customization of the axis crosshair tooltip.

Declaration

public ChartAxisCrosshairTooltip CrosshairTooltip { get; set; }

Property Value

Type	Description
ChartAxisCrosshairTooltip	An instance of ChartAxisCrosshairTooltip.

Remarks

This property can be used to customize the fill and text style of the axis crosshair tooltip.

Description

Gets or sets the description about the axis and its elements for accessibility purposes.

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String	A string representing the description about the axis and its elements for accessibility. The default value is an empty string.

Remarks

Accepts the values in string.

DesiredIntervals

Gets or sets a value that indicates the approximate interval count for axis interval calculation.

Declaration

public double DesiredIntervals { get; set; }

Property Value

Type	Description
System.Double	The desired interval count for axis interval calculation. The default value is System.Double.NaN.

Remarks

Not applicable when ValueType of the axis is ValueType.Category.

EdgeLabelPlacement

Gets or sets the placement of labels at the edge of the axis.

Declaration

public EdgeLabelPlacement EdgeLabelPlacement { get; set; }

Property Value

Type	Description
EdgeLabelPlacement	One of the EdgeLabelPlacement enumerations that specify the edge label placement for the axis. The options include: None: No action will be performed, and the label will be rendered as it is. Hide: Hides the edge label if it exceeds the chart area. Shift: Shifts the edge labels within the chart area. The default mode is EdgeLabelPlacement.None.

Remarks

The longer text labels at the axis edges may only be partially visible in the chart. Utilize this property to place the edge labels efficiently for a better user experience.

EnableAutoIntervalOnZooming

Gets or sets a value indicating whether the axis interval should be calculated automatically with respect to the zoomed range.

Declaration

public bool EnableAutoIntervalOnZooming { get; set; }

Property Value

Type	Description
System.Boolean	true if automatic interval calculation is enabled during zooming; otherwise, false. The default value is true.

Remarks

This property affects axis intervals only when the chart is zoomed.

EnableScrollbarOnZooming

Gets or sets a value indicating whether the scrollbar for zooming is enabled.

Declaration

public bool EnableScrollbarOnZooming { get; set; }

Property Value

Type	Description
System.Boolean	true if the scrollbar for zooming is enabled; otherwise, false. The default value is true.

Remarks

If set to true, the axis will be rendered with a scrollbar when the chart is zoomed.

EnableTrim

Gets or sets a value indicating whether axis labels should be trimmed when they exceed the MaximumLabelWidth.

Declaration

public bool EnableTrim { get; set; }

Property Value

Type	Description
System.Boolean	true if axis labels should be trimmed; otherwise, false. The default value is false.

Remarks

If set to true, axis labels which exceed the MaximumLabelWidth will be trimmed regardless of the LabelIntersectAction applied.

Format

Gets or sets the DateTime format in which the labels of the elements such as Axis label, Data label, and Tooltip in the chart component will be processed.

Declaration

public string Format { get; set; }

Property Value

Type	Description
System.String	A string representing the DateTime format for processing label values. The default value is an empty string.

Remarks

This property is applicable only for DateTime-based axis types.

Interval

Gets or sets the interval for the axis.

Declaration

public double Interval { get; set; }

Property Value

Type	Description
System.Double	The numeric value representing the interval for the axis. The default value is System.Double.NaN.

Remarks

The interval can be customized using IntervalType for DateTime-based axis and LogBase for logarithmic-based axis. For example, if the interval is set to 2 and the IntervalType is set to Years, it considers 2 years to be the interval.

IntervalType

Gets or sets the interval type for the DateTime-based axis.

Declaration

public IntervalType IntervalType { get; set; }

Property Value

Type

Description

IntervalType

One of the IntervalType enumerations that specifies the interval type for the DateTime-based axis. The options include: Auto: Defines the interval of the axis based on data. Years: Defines the interval of the axis in years. Months: Defines the interval of the axis in months. Days: Defines the interval of the axis in days. Hours: Defines the interval of the axis in hours. Minutes: Defines the interval of the axis in minutes. The default value is IntervalType.Auto.

IsIndexed

Gets or sets a value indicating whether the category axis should be rendered using the data source index values.

Declaration

public bool IsIndexed { get; set; }

Property Value

Type	Description
System.Boolean	true if the category axis should be rendered based on the data source index values; otherwise, false. The default value is false.

Remarks

If set to true, multiple series will be rendered based on their data source index values.

IsInversed

Gets or sets a value indicating whether the axis should be rendered in an inversed manner.

Declaration

public bool IsInversed { get; set; }

Property Value

Type	Description
System.Boolean	true if the axis should be rendered in an inversed manner; otherwise, false. The default value is false.

Remarks

If set to true, the axis will be rendered with the greatest value on the axis moving closer to the origin, and vice versa.

LabelFormat

Gets or sets a value that is used to format the numeric, logarithmic, and datetime labels to all globalize formats. Axis also supports custom label format using placeholders such as {value}K, where the value represents the axis label.

Declaration

public string LabelFormat { get; set; }

Property Value

Type	Description
System.String	A string representing the format for processing numeric, logarithmic, and datetime labels.

Remarks

This property is used to globalize the numeric, logarithmic, and datetime labels value of the elements such as Axis label, Data label, and Tooltip in the Chart component. This property is not applicable to Category axis.

LabelIntersectAction

Gets or sets a value that specifies how to arrange axis labels intelligently when they intersect with each other.

Declaration

public LabelIntersectAction LabelIntersectAction { get; set; }

Property Value

Type

Description

LabelIntersectAction

One of the LabelIntersectAction enumerations that specifies the alignment of axis labels when they intersect. The options include: None: Show all labels, regardless of intersections. Hide: Hide labels that intersect with each other. Trim: Trim labels to fit within the available space when they intersect. Wrap: Wrap labels to multiple lines when they intersect. MultipleRows: Display labels in multiple rows when they intersect. Rotate45: Rotate labels by 45 degrees when they intersect. Rotate90: Rotate labels by 90 degrees when they intersect. The default LabelIntersectAction is LabelIntersectAction.Trim.

Remarks

Note: For the vertical axis, the Hide option is the only applicable choice.

LabelPadding

Gets or sets the padding for axis labels from the axis line in pixels.

Declaration

public double LabelPadding { get; set; }

Property Value

Type	Description
System.Double	The numeric value representing the label padding from the axis line in pixels. The default value is 5.

Remarks

Accepts values in numerical form.

LabelPlacement

Gets or sets a value that specifies the placement of axis labels with respect to the axis tick lines.

Declaration

public LabelPlacement LabelPlacement { get; set; }

Property Value

Type	Description
LabelPlacement	One of the LabelPlacement enumerations that specifies the placement for the axis labels. The options include: BetweenTicks: Renders the label between the ticks. OnTicks: Renders the label on the ticks. The default value is LabelPlacement.BetweenTicks.

LabelPosition

Gets or sets the position of axis labels relative to the axis line.

Declaration

public AxisPosition LabelPosition { get; set; }

Property Value

Type	Description
AxisPosition	One of the AxisPosition enumerations that specifies the position of labels relative to the axis line. The options include: Inside: Renders the labels inside the axis line. Outside: Renders the labels outside the axis line. The default value is AxisPosition.Outside.

LabelRotation

Gets or sets the angle to which the axis labels get rotated.

Declaration

public double LabelRotation { get; set; }

Property Value

Type	Description
System.Double	The numeric value representing the rotation angle of the axis labels. The default value is 0.

Remarks

This property specifies the rotation angle applied to axis labels, enhancing their orientation for better readability. It accepts numerical values from 0 to 360, with negative values representing angles calculated from 360.

LabelStyle

Gets or sets an instance of ChartAxisLabelStyle that specifies the text style of axis labels.

Declaration

public ChartAxisLabelStyle LabelStyle { get; set; }

Property Value

Type	Description
ChartAxisLabelStyle	An instance of ChartAxisLabelStyle.

Remarks

This property can be used to customize the color and font properties such as size, font-family, font-weight and font-style of axis labels.

LineStyle

Gets or sets an instance of ChartAxisLineStyle that controls the customization of axis line.

Declaration

public ChartAxisLineStyle LineStyle { get; set; }

Property Value

Type	Description
ChartAxisLineStyle	An instance of ChartAxisLineStyle.

Remarks

This property can be used to customize the color, width, and dash array of the axis line.

LogBase

Gets or sets the base value for the logarithmic axis.

Declaration

public double LogBase { get; set; }

Property Value

Type	Description
System.Double	The numeric value representing the base value for the logarithmic axis. The default value is 10.

Remarks

This property is applicable only when the ValueType of the axis is set to Logarithmic.
For example, when the logarithmic base is 10 and Interval is 2, then the axis labels are placed at an interval of 10^2.

MajorGridLines

Gets or sets an instance of ChartAxisMajorGridLines that controls the customization of major grid lines.

Declaration

public ChartAxisMajorGridLines MajorGridLines { get; set; }

Property Value

Type	Description
ChartAxisMajorGridLines	An instance of ChartAxisMajorGridLines.

Remarks

This property can be used to customize the color, width, and dash array of the major grid lines.

MajorTickLines

Gets or sets an instance of ChartAxisMajorTickLines that controls the customization of major tick lines.

Declaration

public ChartAxisMajorTickLines MajorTickLines { get; set; }

Property Value

Type	Description
ChartAxisMajorTickLines	An instance of ChartAxisMajorTickLines.

Remarks

This property can be used to customize the color, width, and height of the major tick lines.

Maximum

Gets or sets the maximum range of an axis.

Declaration

public object Maximum { get; set; }

Property Value

Type	Description
System.Object	The value representing the maximum range of an axis. The default value is derived from the values of corresponding data source points.

Remarks

This property specifies the maximum range for the axis. It determines the upper limit of the visible range on the axis.

MaximumLabels

Gets or sets the maximum number of labels per 100 pixels with respect to the axis length.

Declaration

public double MaximumLabels { get; set; }

Property Value

Type	Description
System.Double	The numeric value representing the maximum label count. The default value is 3.

Remarks

Accepts the values in numerical forms.

MaximumLabelWidth

Gets or sets the maximum width for an axis label.

Declaration

public double MaximumLabelWidth { get; set; }

Property Value

Type	Description
System.Double	The numeric value representing the maximum width for an axis label. The default value is 34.

Remarks

If EnableTrim is set to true, axis labels which exceed the MaximumLabelWidth will be trimmed.

Minimum

Gets or sets the minimum range of an axis.

Declaration

public object Minimum { get; set; }

Property Value

Type	Description
System.Object	The value representing the minimum range of an axis. The default value is derived from the values of corresponding data source points.

Remarks

This property specifies the minimum range for the axis. It determines the lower limit of the visible range on the axis.

MinorGridLines

Gets or sets an instance of ChartAxisMinorGridLines that controls the customization of minor grid lines.

Declaration

public ChartAxisMinorGridLines MinorGridLines { get; set; }

Property Value

Type	Description
ChartAxisMinorGridLines	An instance of ChartAxisMinorGridLines.

Remarks

This property can be used to customize the color, width, and dash array of the minor grid lines.
Note: Minor grid lines will be rendered only when MinorTicksPerInterval is provided with a value greater than zero.

MinorTickLines

Gets or sets an instance of ChartAxisMinorTickLines that controls the customization of minor tick lines.

Declaration

public ChartAxisMinorTickLines MinorTickLines { get; set; }

Property Value

Type	Description
ChartAxisMinorTickLines	An instance of ChartAxisMinorTickLines.

Remarks

This property can be used to customize the color, width, and dash array of the minor tick lines.
Note: Minor tick lines will be rendered only when MinorTicksPerInterval is provided with a value greater than zero.

MinorTicksPerInterval

Gets or sets the number of minor ticks to be rendered per interval.

Declaration

public double MinorTicksPerInterval { get; set; }

Property Value

Type	Description
System.Double	The numeric value representing the number of minor ticks per interval.

Remarks

Note: Minor grid lines and minor tick lines will be rendered only when this property is provided with a value greater than zero.

MultiLevelLabels

Gets or sets a collection of ChartMultiLevelLabel representing the multilevel labels for the axis.

Declaration

public List<ChartMultiLevelLabel> MultiLevelLabels { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<ChartMultiLevelLabel>	A list of ChartMultiLevelLabel.

Remarks

This property allows adding any number of layers of labels to the axis.

Name

Gets or sets the unique identifier name of an axis.

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String	A string representing the unique identifier name of the axis. The default value is an empty string.

Remarks

To associate an axis with the series, set this name to the xAxisName/yAxisName properties of the series.

OpposedPosition

Gets or sets a value indicating whether to place an axis in the opposite position of its original position.

Declaration

public bool OpposedPosition { get; set; }

Property Value

Type	Description
System.Boolean	true if the axis should render at the opposite position; otherwise, false. The default value is false.

Remarks

For a horizontal axis, setting OpposedPosition to true will position the axis at the top of the chart. For a vertical axis, setting OpposedPosition to true will position the axis at the right side of the chart.

PlaceNextToAxisLine

gets or sets a value that specifies whether axis elements such as axis labels, and axis title should be placed next to the axis line when axis crossing occurs.

Declaration

public bool PlaceNextToAxisLine { get; set; }

Property Value

Type	Description
System.Boolean	true if axis elements should be placed next to the axis line; otherwise, false. The default value is true.

Remarks

This property is applicable only when axis crossing occurs.

PlotOffset

Gets or sets the padding for the plot area in pixels.

Declaration

public double PlotOffset { get; set; }

Property Value

Type	Description
System.Double	The numeric value representing the padding for the plot area.

Remarks

This property defines the top and bottom padding of the plot area for the vertical axis, and left and right padding of the plot area for the horizontal axis. Adjusting the PlotOffset property allows customization of the spacing around the plot area.

PlotOffsetBottom

Gets or sets the bottom padding for the plot area in pixels.

Declaration

public double PlotOffsetBottom { get; set; }

Property Value

Type	Description
System.Double	The numeric value representing the bottom padding for the plot area. The default value is System.Double.NaN.

Remarks

Applicable only for the vertical axis.

PlotOffsetLeft

Gets or sets the left padding for the plot area in pixels.

Declaration

public double PlotOffsetLeft { get; set; }

Property Value

Type	Description
System.Double	The numeric value representing the left padding for the plot area. The default value is System.Double.NaN.

Remarks

Applicable only for the horizontal axis.

PlotOffsetRight

Gets or sets the right padding for the plot area in pixels.

Declaration

public double PlotOffsetRight { get; set; }

Property Value

Type	Description
System.Double	The numeric value representing the right padding for the plot area. The default value is System.Double.NaN.

Remarks

Applicable only for the horizontal axis.

PlotOffsetTop

Gets or sets the top padding for the plot area in pixels.

Declaration

public double PlotOffsetTop { get; set; }

Property Value

Type	Description
System.Double	The numeric value representing the top padding for the plot area. The default value is System.Double.NaN.

Remarks

Applicable only for the vertical axis.

RangePadding

Gets or sets a value that specifies the padding for the axis range in terms of interval.

Declaration

public ChartRangePadding RangePadding { get; set; }

Property Value

Type

Description

ChartRangePadding

One of the ChartRangePadding enumerations that specifies the range padding of the axis. The options include: None: Padding cannot be applied to the axis. Normal: Padding is applied to the axis based on the range calculation. Additional: Interval of the axis is added as padding to the minimum and maximum values of the range. Round: Axis range is rounded to the nearest possible value divisible by the interval. The default value is ChartRangePadding.Auto.

RendererKey

Declaration

public string RendererKey { get; set; }

Property Value

Type
System.String

RendererType

Declaration

public Type RendererType { get; set; }

Property Value

Type
System.Type

RowIndex

Gets or sets a value that specifies the index of the row with which the axis is associated.

Declaration

public double RowIndex { get; set; }

Property Value

Type	Description
System.Double	A numeric value representing the index of the row associated with the axis. The default value is 0.

Remarks

This property is applicable only when the chart area is divided into multiple plot areas using Rows. To bind a vertical axis to a specific row, set the axis’s RowIndex property to that row’s index.

ScrollbarSettings

Gets or sets an instance of ChartAxisScrollbarSettings that controls the customization of the axis scrollbar.

Declaration

public ChartAxisScrollbarSettings ScrollbarSettings { get; set; }

Property Value

Type	Description
ChartAxisScrollbarSettings	An instance of ChartAxisScrollbarSettings.

Remarks

This property can be used to customize the visibility, pointslength and range for the axis scrollbar.

Span

Specifies the number of columns or rows an axis must span horizontally or vertically.

Declaration

public int Span { get; set; }

Property Value

Type	Description
System.Int32	An integer representing the number of columns or rows the axis spans. The default value is 1.

Remarks

This property is applicable only when the chart area is divided into multiple panes using “Rows” or “Columns”.

StartAngle

Gets or sets the start angle for the series.

Declaration

public double StartAngle { get; set; }

Property Value

Type	Description
System.Double	The numeric value representing the start angle for the series.

Remarks

This property is applicable only for customizing series in Polar and Radar series type charts.

StartFromZero

Gets or sets a value indicating whether the numeric axis should start from zero.

Declaration

public bool StartFromZero { get; set; }

Property Value

Type	Description
System.Boolean	true if the numeric axis starts from zero; otherwise, false. The default value is true.

Remarks

This property is only applicable for numeric axes.

StripLines

Gets or sets a collection of strip lines for the axis.

Declaration

public List<ChartStripline> StripLines { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<ChartStripline>	A list containing instances of ChartStripline representing the strip lines for the axis.

Remarks

This property allows the addition of strip lines to the axis. The strip lines in the list will be rendered on the respective axis.

TabIndex

Gets or sets the tabindex value for the axis for accessibility purposes.

Declaration

public double TabIndex { get; set; }

Property Value

Type	Description
System.Double	A numeric value representing the tabindex for the axis. The default value is 2.

TickPosition

Gets or sets the placement of ticks on the axis line.

Declaration

public AxisPosition TickPosition { get; set; }

Property Value

Type	Description
AxisPosition	One of the AxisPosition enumeration that specifies the placement of ticks with respect to the axis line. Options include: Inside: Renders the ticks inside the axis line. Outside: Renders the ticks outside the axis line. The default mode is AxisPosition.Outside.

Title

Gets or sets the title of an axis.

Declaration

public string Title { get; set; }

Property Value

Type	Description
System.String	A string representing the title of the axis. The default value is an empty string.

Remarks

The axis title provides a quick information to the user about the data plotted in the axis.

TitleStyle

Gets or sets an instance of ChartAxisTitleStyle that specifies the style of the axis title.

Declaration

public ChartAxisTitleStyle TitleStyle { get; set; }

Property Value

Type	Description
ChartAxisTitleStyle	An instance of ChartAxisTitleStyle.

Remarks

This property allows customization of the visual style, including color and font properties enhancing the visual appeal of the axis title.

ValueType

Gets or sets the type of data the axis is handling.

Declaration

public ValueType ValueType { get; set; }

Property Value

Type	Description
ValueType	One of the ValueType enumerations that specifies the value type of the axis. Options include: Double: Renders a numeric axis. DateTime: Renders a date time axis. Category: Renders a category axis. Logarithmic: Renders a logarithmic axis. DateTimeCategory : Renders a date time category axis. The default value is ValueType.Double.

Remarks

This property determines the type of data the axis is handling, and it affects the way axis values are interpreted and displayed on the chart.
It is essential to set this property correctly based on the nature of the data being plotted.

Visible

Gets or sets a value indicating whether the axis elements such as axis labels, tick lines, grid lines, and axis title should be visible.

Declaration

public bool Visible { get; set; }

Property Value

Type	Description
System.Boolean	true if the axis and its associated elements are visible; otherwise, false. The default value is true.

Remarks

Set this property to control the visibility of various axis elements. When set to false, the axis and its associated elements will not be rendered on the chart.

ZoomFactor

Gets or sets the scaling factor for the axis during zoom operations.

Declaration

public double ZoomFactor { get; set; }

Property Value

Type	Description
System.Double	The scaling factor for the axis, which ranges from 0 to 1. The default value is 1.

Remarks

When ZoomFactor is set to 0.5, the chart is scaled by 200% along this axis.

ZoomPosition

Gets or sets the position of the zoomed axis during zoom operations.

Declaration

public double ZoomPosition { get; set; }

Property Value

Type	Description
System.Double	The position of the zoomed axis, which ranges from 0 to 1.

Remarks

The ZoomPosition property determines the relative position of the zoomed axis during zoom operations. A value of 0 represents the start of the axis, and a value of 1 represents the end of the axis. This property is used in conjunction with the ZoomFactor property to control the zoom behavior along the axis.

Methods

GetName()

Gets the name of the axis.

Declaration

public virtual string GetName()

Returns

Type	Description
System.String	A string representing the name of the axis.

Examples

This example demonstrates how to get axis name using button click in a Blazor component.

 

<SfButton OnClick="GetAxisName">Get AxisName</SfButton> 
<SfChart> 
<ChartPrimaryXAxis @ref="@chartaxis" ValueType="Syncfusion.Blazor.Charts.ValueType.Category"/> 
…   
</SfChart> 

@code {   
 public ChartAxis chartaxis; 
 public void GetAxisName() 
 { 
   string axisName = chartaxis.GetName(); 
 } 
}   

OnInitialized()

Declaration

protected override void OnInitialized()

OnParametersSet()

Declaration

protected override void OnParametersSet()

Overrides

ChartSubComponent.OnParametersSet()