Class StockChartCommonAxis

To specify customization options for stockchart axis.

Inheritance

System.Object

StockChartCommonAxis

StockChartAxis

StockChartPrimaryXAxis

StockChartPrimaryYAxis

Namespace: Syncfusion.Blazor.Charts

Assembly: Syncfusion.Blazor.dll

Syntax

public class StockChartCommonAxis : OwningComponentBase

Constructors

StockChartCommonAxis()

Declaration

public StockChartCommonAxis()

Properties

CrossesAt

Specifies the value at which the axis line has to be intersect with the vertical axis or vice versa.

Declaration

public object CrossesAt { get; set; }

Property Value

Type
System.Object

CrossesInAxis

Specifies axis name with which the axis line has to be crossed.

Declaration

public string CrossesInAxis { get; set; }

Property Value

Type
System.String

Description

Description for axis and its element.

Declaration

public string Description { get; set; }

Property Value

Type
System.String

DesiredIntervals

With this property, you can request axis to calculate intervals approximately equal to your specified interval.

Declaration

public double DesiredIntervals { get; set; }

Property Value

Type
System.Double

EdgeLabelPlacement

Specifies the position of labels at the edge of the axis.They are, None: No action will be performed. Hide: Edge label will be hidden. Shift: Shifts the edge labels.

Declaration

public EdgeLabelPlacement EdgeLabelPlacement { get; set; }

Property Value

Type
EdgeLabelPlacement

EnableAutoIntervalOnZooming

If set to true, axis interval will be calculated automatically with respect to the zoomed range.

Declaration

public bool EnableAutoIntervalOnZooming { get; set; }

Property Value

Type
System.Boolean

EnableTrim

Specifies the Trim property for an axis.

Declaration

public bool EnableTrim { get; set; }

Property Value

Type
System.Boolean

Interval

Specifies the interval for an axis.

Declaration

public double Interval { get; set; }

Property Value

Type
System.Double

IntervalType

Specifies the types like Years, Months, Days, Hours, Minutes, Seconds in date time axis.They are, 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.

Declaration

public IntervalType IntervalType { get; set; }

Property Value

Type
IntervalType

IsInversed

It specifies whether the axis to be rendered in inversed manner or not.

Declaration

public bool IsInversed { get; set; }

Property Value

Type
System.Boolean

LabelFormat

Used to format the axis label that accepts any global string format like 'C', 'n1', 'P' etc. It also accepts placeholder like '{value}°C' in which value represent the axis label, e.g, 20°C.

Declaration

public string LabelFormat { get; set; }

Property Value

Type
System.String

LabelIntersectAction

Specifies the actions like Hide, Rotate45, and Rotate90 when the axis labels intersect with each other.They are, None: Shows all the labels. Hide: Hides the label when it intersects. Rotate45: Rotates the label to 45 degree when it intersects. Rotate90: Rotates the label to 90 degree when it intersects.

Declaration

public LabelIntersectAction LabelIntersectAction { get; set; }

Property Value

Type
LabelIntersectAction

LabelPlacement

Specifies the placement of a label for category axis. They are, betweenTicks: Renders the label between the ticks. onTicks: Renders the label on the ticks.

Declaration

public LabelPlacement LabelPlacement { get; set; }

Property Value

Type
LabelPlacement

LabelPosition

Specifies the placement of a labels to the axis line. They are, inside: Renders the labels inside to the axis line. outside: Renders the labels outside to the axis line.

Declaration

public virtual AxisPosition LabelPosition { get; set; }

Property Value

Type
AxisPosition

LabelRotation

The angle to which the axis label gets rotated.

Declaration

public double LabelRotation { get; set; }

Property Value

Type
System.Double

LogBase

The base value for logarithmic axis. It requires ValueType to be Logarithmic.

Declaration

public double LogBase { get; set; }

Property Value

Type
System.Double

Maximum

Specifies the maximum range of an axis.

Declaration

public object Maximum { get; set; }

Property Value

Type
System.Object

MaximumLabels

The maximum number of label count per 100 pixels with respect to the axis length.

Declaration

public double MaximumLabels { get; set; }

Property Value

Type
System.Double

MaximumLabelWidth

Specifies the maximum width of an axis label.

Declaration

public double MaximumLabelWidth { get; set; }

Property Value

Type
System.Double

Minimum

Specifies the minimum range of an axis.

Declaration

public object Minimum { get; set; }

Property Value

Type
System.Object

MinorTicksPerInterval

Specifies the number of minor ticks per interval.

Declaration

public double MinorTicksPerInterval { get; set; }

Property Value

Type
System.Double

Name

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

Declaration

public virtual string Name { get; set; }

Property Value

Type
System.String

OpposedPosition

If set to true, the axis will render at the opposite side of its default position.

Declaration

public virtual bool OpposedPosition { get; set; }

Property Value

Type
System.Boolean

PlaceNextToAxisLine

Specifies whether axis elements like axis labels, axis title, etc has to be crossed with axis line.

Declaration

public bool PlaceNextToAxisLine { get; set; }

Property Value

Type
System.Boolean

PlotOffset

Left and right padding for the plot area in pixels.

Declaration

public double PlotOffset { get; set; }

Property Value

Type
System.Double

RangePadding

Specifies the padding for the axis range in terms of interval.They are, 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 divided by the interval.

Declaration

public ChartRangePadding RangePadding { get; set; }

Property Value

Type
ChartRangePadding

RowIndex

Specifies the index of the row where the axis is associated, when the chart area is divided into multiple plot areas by using Rows.

Declaration

public int RowIndex { get; set; }

Property Value

Type
System.Int32

Skeleton

Specifies the skeleton format in which the dateTime format will process.

Declaration

public string Skeleton { get; set; }

Property Value

Type
System.String

SkeletonType

It specifies the type of format to be used in dateTime format process.

Declaration

public SkeletonType SkeletonType { get; set; }

Property Value

Type
SkeletonType

Span

Specifies the number of Columns or rows an axis has to span horizontally or vertically.

Declaration

public double Span { get; set; }

Property Value

Type
System.Double

StartAngle

The start angle for the series.

Declaration

public double StartAngle { get; set; }

Property Value

Type
System.Double

TabIndex

TabIndex value for the axis.

Declaration

public double TabIndex { get; set; }

Property Value

Type
System.Double

TickPosition

Specifies the placement of a ticks to the axis line. They are, inside: Renders the ticks inside to the axis line. outside: Renders the ticks outside to the axis line.

Declaration

public AxisPosition TickPosition { get; set; }

Property Value

Type
AxisPosition

Title

Specifies the title of an axis.

Declaration

public string Title { get; set; }

Property Value

Type
System.String

ValueType

Specifies the type of data the axis is handling. Double: Renders a numeric axis. DateTime: Renders a dateTime axis. Category: Renders a category axis. Logarithmic: Renders a log axis.

Declaration

public virtual ValueType ValueType { get; set; }

Property Value

Type
ValueType

Visible

If set to true, axis label will be visible.

Declaration

public bool Visible { get; set; }

Property Value

Type
System.Boolean

ZoomFactor

The axis is scaled by this factor. When zoomFactor is 0.5, the chart is scaled by 200% along this axis. Value ranges from 0 to 1.

Declaration

public double ZoomFactor { get; set; }

Property Value

Type
System.Double

ZoomPosition

Position of the zoomed axis. Value ranges from 0 to 1.

Declaration

public double ZoomPosition { get; set; }

Property Value

Type
System.Double

Methods

Dispose(Boolean)

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

OnParametersSetAsync()

Method invoked when the component has received parameters from its parent in the render tree and the incoming values have been assigned to properties.

Declaration

protected override Task OnParametersSetAsync()

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the asynchronous operation.