Class ChartAxis

Inheritance

System.Object

TagHelper

EJTagHelper

ChartAxis

ChartPrimaryXAxisChart

ChartPrimaryYAxisChart

Inherited Members

EJTagHelper.GetList()

EJTagHelper.GetSerializedProperties()

EJTagHelper.GetScriptString()

EJTagHelper.GetHtmlAttrString(IDictionary<String, Object>)

EJTagHelper.TagName

EJTagHelper.Id

EJTagHelper.NameSpace

EJTagHelper.ClassName

EJTagHelper.IsFor

EJTagHelper.IsChild

EJTagHelper.IsCollection

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Syncfusion.EJ2.Charts

Assembly: Syncfusion.EJ2.dll

Syntax

public class ChartAxis : EJTagHelper

Constructors

ChartAxis()

Declaration

public ChartAxis()

Properties

Border

Border of the multi level labels.

Declaration

[HtmlAttributeName("border")]
public ChartLabelBorder Border { get; set; }

Property Value

Type	Description
ChartLabelBorder	The default value is null

Coefficient

The polar radar radius position.

Declaration

[HtmlAttributeName("coefficient")]
public double Coefficient { get; set; }

Property Value

Type	Description
System.Double	The default value is 100

ColumnIndex

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

Declaration

[HtmlAttributeName("columnIndex")]
public double ColumnIndex { get; set; }

Property Value

Type	Description
System.Double	The default value is 0

CrossesAt

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

Declaration

[HtmlAttributeName("crossesAt")]
public object CrossesAt { get; set; }

Property Value

Type	Description
System.Object	The default value is null

CrossesInAxis

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

Declaration

[HtmlAttributeName("crossesInAxis")]
public string CrossesInAxis { get; set; }

Property Value

Type	Description
System.String	The default value is null

CrosshairTooltip

Options to customize the crosshair ToolTip.

Declaration

[HtmlAttributeName("crosshairTooltip")]
public ChartCrosshairTooltip CrosshairTooltip { get; set; }

Property Value

Type	Description
ChartCrosshairTooltip	The default value is null

Description

Description for axis and its element.

Declaration

[HtmlAttributeName("description")]
public string Description { get; set; }

Property Value

Type	Description
System.String	The default value is null

DesiredIntervals

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

Declaration

[HtmlAttributeName("desiredIntervals")]
public double DesiredIntervals { get; set; }

Property Value

Type	Description
System.Double	The default value is Double.NaN

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

[HtmlAttributeName("edgeLabelPlacement")]
public EdgeLabelPlacement EdgeLabelPlacement { get; set; }

Property Value

Type	Description
EdgeLabelPlacement	The default value is EdgeLabelPlacement.None

EnableAutoIntervalOnZooming

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

Declaration

[HtmlAttributeName("enableAutoIntervalOnZooming")]
public bool EnableAutoIntervalOnZooming { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

EnableScrollbarOnZooming

Enables the scrollbar for zooming.

Declaration

[HtmlAttributeName("enableScrollbarOnZooming")]
public bool EnableScrollbarOnZooming { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

EnableTrim

Specifies the Trim property for an axis.

Declaration

[HtmlAttributeName("enableTrim")]
public bool EnableTrim { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

Interval

Specifies the interval for an axis.

Declaration

[HtmlAttributeName("interval")]
public double Interval { get; set; }

Property Value

Type	Description
System.Double	The default value is Double.NaN

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

[HtmlAttributeName("intervalType")]
public IntervalType IntervalType { get; set; }

Property Value

Type	Description
IntervalType	The default value is IntervalType.Auto

IsComplex

Declaration

protected override bool IsComplex { get; }

Property Value

Type	Description
System.Boolean

Overrides

EJTagHelper.IsComplex

IsIndexed

Specifies indexed category axis.

Declaration

[HtmlAttributeName("isIndexed")]
public bool IsIndexed { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

IsInversed

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

Declaration

[HtmlAttributeName("isInversed")]
public bool IsInversed { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

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

[HtmlAttributeName("labelFormat")]
public string LabelFormat { get; set; }

Property Value

Type	Description
System.String	The default value is ""

LabelIntersectAction

Specifies the actions like None, Hide, Trim, Wrap, MultipleRows, 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. Trim: Trim the label when it intersects. Wrap: Wrap the label when it intersects. MultipleRows: Shows the label in MultipleRows when it intersects. Rotate45: Rotates the label to 45 degree when it intersects. Rotate90: Rotates the label to 90 degree when it intersects.

Declaration

[HtmlAttributeName("labelIntersectAction")]
public LabelIntersectAction LabelIntersectAction { get; set; }

Property Value

Type	Description
LabelIntersectAction	The default value is LabelIntersectAction.Trim

LabelPadding

Specifies the labelPadding from axis.

Declaration

[HtmlAttributeName("labelPadding")]
public double LabelPadding { get; set; }

Property Value

Type	Description
System.Double	The default value is 5

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

[HtmlAttributeName("labelPlacement")]
public LabelPlacement LabelPlacement { get; set; }

Property Value

Type	Description
LabelPlacement	The default value is LabelPlacement.BetweenTicks

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

[HtmlAttributeName("labelPosition")]
public AxisPosition LabelPosition { get; set; }

Property Value

Type	Description
AxisPosition	The default value is AxisPosition.Outside

LabelRotation

The angle to which the axis label gets rotated.

Declaration

[HtmlAttributeName("labelRotation")]
public double LabelRotation { get; set; }

Property Value

Type	Description
System.Double	The default value is 0

LabelStyle

Options to customize the axis label.

Declaration

[HtmlAttributeName("labelStyle")]
public ChartFont LabelStyle { get; set; }

Property Value

Type	Description
ChartFont	The default value is null

LineBreakAlignment

It specifies alignment of the line break labels.

Declaration

[HtmlAttributeName("lineBreakAlignment")]
public TextAlignment LineBreakAlignment { get; set; }

Property Value

Type	Description
TextAlignment	The default value is TextAlignment.Center

LineStyle

Options for customizing axis lines.

Declaration

[HtmlAttributeName("lineStyle")]
public ChartAxisLine LineStyle { get; set; }

Property Value

Type	Description
ChartAxisLine	The default value is null

LogBase

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

Declaration

[HtmlAttributeName("logBase")]
public double LogBase { get; set; }

Property Value

Type	Description
System.Double	The default value is 10

MajorGridLines

Options for customizing major grid lines.

Declaration

[HtmlAttributeName("majorGridLines")]
public ChartMajorGridLines MajorGridLines { get; set; }

Property Value

Type	Description
ChartMajorGridLines	The default value is null

MajorTickLines

Options for customizing major tick lines.

Declaration

[HtmlAttributeName("majorTickLines")]
public ChartMajorTickLines MajorTickLines { get; set; }

Property Value

Type	Description
ChartMajorTickLines	The default value is null

Maximum

Specifies the maximum range of an axis.

Declaration

[HtmlAttributeName("maximum")]
public object Maximum { get; set; }

Property Value

Type	Description
System.Object	The default value is null

MaximumLabels

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

Declaration

[HtmlAttributeName("maximumLabels")]
public double MaximumLabels { get; set; }

Property Value

Type	Description
System.Double	The default value is 3

MaximumLabelWidth

Specifies the maximum width of an axis label.

Declaration

[HtmlAttributeName("maximumLabelWidth")]
public double MaximumLabelWidth { get; set; }

Property Value

Type	Description
System.Double	The default value is 34

Minimum

Specifies the minimum range of an axis.

Declaration

[HtmlAttributeName("minimum")]
public object Minimum { get; set; }

Property Value

Type	Description
System.Object	The default value is null

MinorGridLines

Options for customizing minor grid lines.

Declaration

[HtmlAttributeName("minorGridLines")]
public ChartMinorGridLines MinorGridLines { get; set; }

Property Value

Type	Description
ChartMinorGridLines	The default value is null

MinorTickLines

Options for customizing minor tick lines.

Declaration

[HtmlAttributeName("minorTickLines")]
public ChartMinorTickLines MinorTickLines { get; set; }

Property Value

Type	Description
ChartMinorTickLines	The default value is null

MinorTicksPerInterval

Specifies the number of minor ticks per interval.

Declaration

[HtmlAttributeName("minorTicksPerInterval")]
public double MinorTicksPerInterval { get; set; }

Property Value

Type	Description
System.Double	The default value is 0

MultiLevelLabels

Specifies the multi level labels collection for the axis.

Declaration

[HtmlAttributeName("multiLevelLabels")]
public List<ChartMultiLevelLabel> MultiLevelLabels { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<ChartMultiLevelLabel>	The default value is null

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

[HtmlAttributeName("name")]
public string Name { get; set; }

Property Value

Type	Description
System.String	The default value is ""

OpposedPosition

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

Declaration

[HtmlAttributeName("opposedPosition")]
public bool OpposedPosition { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

ParentPropertyName

Declaration

protected override string ParentPropertyName { get; }

Property Value

Type	Description
System.String

Overrides

EJTagHelper.ParentPropertyName

PlaceNextToAxisLine

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

Declaration

[HtmlAttributeName("placeNextToAxisLine")]
public bool PlaceNextToAxisLine { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

PlotOffset

Left and right padding for the plot area in pixels.

Declaration

[HtmlAttributeName("plotOffset")]
public double PlotOffset { get; set; }

Property Value

Type	Description
System.Double	The default value is 0

PlotOffsetBottom

Bottom padding for the plot area in pixels.

Declaration

[HtmlAttributeName("plotOffsetBottom")]
public double PlotOffsetBottom { get; set; }

Property Value

Type	Description
System.Double	The default value is Double.NaN

PlotOffsetLeft

Left padding for the plot area in pixels.

Declaration

[HtmlAttributeName("plotOffsetLeft")]
public double PlotOffsetLeft { get; set; }

Property Value

Type	Description
System.Double	The default value is Double.NaN

PlotOffsetRight

Right padding for the plot area in pixels.

Declaration

[HtmlAttributeName("plotOffsetRight")]
public double PlotOffsetRight { get; set; }

Property Value

Type	Description
System.Double	The default value is Double.NaN

PlotOffsetTop

Top padding for the plot area in pixels.

Declaration

[HtmlAttributeName("plotOffsetTop")]
public double PlotOffsetTop { get; set; }

Property Value

Type	Description
System.Double	The default value is Double.NaN

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

[HtmlAttributeName("rangePadding")]
public ChartRangePadding RangePadding { get; set; }

Property Value

Type	Description
ChartRangePadding	The default value is ChartRangePadding.Auto

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

[HtmlAttributeName("rowIndex")]
public double RowIndex { get; set; }

Property Value

Type	Description
System.Double	The default value is 0

ScrollbarSettings

Option to customize scrollbar with lazy loading.

Declaration

[HtmlAttributeName("scrollbarSettings")]
public ChartScrollbarSettings ScrollbarSettings { get; set; }

Property Value

Type	Description
ChartScrollbarSettings	The default value is null

Skeleton

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

Declaration

[HtmlAttributeName("skeleton")]
public string Skeleton { get; set; }

Property Value

Type	Description
System.String	The default value is ""

SkeletonType

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

Declaration

[HtmlAttributeName("skeletonType")]
public SkeletonType SkeletonType { get; set; }

Property Value

Type	Description
SkeletonType	The default value is SkeletonType.DateTime

Span

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

Declaration

[HtmlAttributeName("span")]
public double Span { get; set; }

Property Value

Type	Description
System.Double	The default value is 1

StartAngle

The start angle for the series.

Declaration

[HtmlAttributeName("startAngle")]
public double StartAngle { get; set; }

Property Value

Type	Description
System.Double	The default value is 0

StartFromZero

It specifies whether the axis to be start from zero.

Declaration

[HtmlAttributeName("startFromZero")]
public bool StartFromZero { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

StripLines

Specifies the stripLine collection for the axis.

Declaration

[HtmlAttributeName("stripLines")]
public List<ChartStripLine> StripLines { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<ChartStripLine>	The default value is null

TabIndex

TabIndex value for the axis.

Declaration

[HtmlAttributeName("tabIndex")]
public double TabIndex { get; set; }

Property Value

Type	Description
System.Double	The default value is 2

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

[HtmlAttributeName("tickPosition")]
public AxisPosition TickPosition { get; set; }

Property Value

Type	Description
AxisPosition	The default value is AxisPosition.Outside

Title

Specifies the title of an axis.

Declaration

[HtmlAttributeName("title")]
public string Title { get; set; }

Property Value

Type	Description
System.String	The default value is ""

TitlePadding

Specifies the titlePadding from axis label.

Declaration

[HtmlAttributeName("titlePadding")]
public double TitlePadding { get; set; }

Property Value

Type	Description
System.Double	The default value is 5

TitleRotation

Defines an angle to rotate axis title. By default, angle auto calculated based on position and orientation of axis.

Declaration

[HtmlAttributeName("titleRotation")]
public double TitleRotation { get; set; }

Property Value

Type	Description
System.Double	The default value is Double.NaN

TitleStyle

Options for customizing the axis title.

Declaration

[HtmlAttributeName("titleStyle")]
public ChartFont TitleStyle { get; set; }

Property Value

Type	Description
ChartFont	The default value is null

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

[HtmlAttributeName("valueType")]
public ValueType ValueType { get; set; }

Property Value

Type	Description
ValueType	The default value is ValueType.Double

Visible

If set to true, axis label will be visible.

Declaration

[HtmlAttributeName("visible")]
public bool Visible { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

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

[HtmlAttributeName("zoomFactor")]
public double ZoomFactor { get; set; }

Property Value

Type	Description
System.Double	The default value is 1

ZoomPosition

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

Declaration

[HtmlAttributeName("zoomPosition")]
public double ZoomPosition { get; set; }

Property Value

Type	Description
System.Double	The default value is 0