Class
ChartXAxis

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Syntax:

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

Inheritance: objectComponentBaseDataVizChildComponentDataVizCollectionItemComponentChartXAxis

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

Inherited Members ComponentBase.OnInitializedAsync()ComponentBase.OnParametersSetAsync()ComponentBase.StateHasChanged()ComponentBase.ShouldRender()ComponentBase.OnAfterRenderAsync(bool)ComponentBase.InvokeAsync(Action)ComponentBase.InvokeAsync(Func<Task>)ComponentBase.SetParametersAsync(ParameterView)

Constructors

ChartXAxis()

Declaration

cs-api-definition
public ChartXAxis()

Properties

AxisCrossingValue

Value at which the Y axis crosses this axis. (Only for object)Value indices at which the Y axes cross the value axis. (Only for array)Date at which the Y axis crosses this axis. (Only for date)

Declaration

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

Property Value

object[]

Background

The background color of the axis.

Declaration

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

Property Value

string

BaseUnit

The base time interval for the axis labels. The default baseUnit is determined automatically from the value range. Available options: milliseconds; seconds; minutes; hours; days; weeks; months or years.

Declaration

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

Property Value

string

Categories

The category names. Applicable for charts with X and Y category axes (heatmap).

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

The color of the axis. Accepts a valid CSS color string, including hex and rgb.

Declaration

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

Property Value

string

MajorUnit

The interval between major divisions. If this is a date axis the value represents the number of xAxis.baseUnits between major divisions. If the xAxis.type is set to "log", the majorUnit value will be used for the base of the logarithm.

Declaration

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

Property Value

double?

Max

The maximum value of the axis.

Declaration

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

Property Value

object

Min

The minimum value of the axis.

Declaration

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

Property Value

object

MinorUnit

The interval between minor divisions. It defaults to 1/5 of the xAxis.majorUnit. If the xAxis.type is set to "log", the minorUnit value represents the number of divisions between two major units and defaults to the major unit minus one.

Declaration

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

Property Value

double?

Name

The unique axis name. Used to associate a series with a x axis using the series.xAxis option.

Declaration

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

Property Value

string

NarrowRange

If set to true the chart will prevent the automatic axis range from snapping to 0. Setting it to false will force the automatic axis range to snap to 0.

Declaration

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

Property Value

bool?

Reverse

If set to true the value axis direction will be reversed. By default values increase from left to right and from bottom to top.

Declaration

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

Property Value

bool?

StartAngle

The angle (degrees) where the 0 value is placed. Applicable to polar series.Angles increase counterclockwise and zero is to the right. Negative values are acceptable.

Declaration

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

Property Value

double?

Type

The axis type.The supported values are: "numeric" - numeric axis.; "date" - specialized axis for displaying chronological data. or "log" - logarithmic axis..

Declaration

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

Property Value

string

Visible

If set to true the chart will display the x axis. By default the x axis is visible.

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

Declaration

cs-api-definition
public override void Dispose()

Overrides DataVizChildComponent.Dispose()

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