Class Axis

Inheritance
System.Object
EJTagHelper
Axis
Inherited Members
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.JavaScript.DataVisualization.Models
Assembly: Syncfusion.EJ.dll
Syntax
public class Axis : EJTagHelper

Constructors

Axis()

Declaration
public Axis()

Fields

m_alignment

Declaration
public Alignment m_alignment
Field Value
Type Description
Alignment

Properties

Alignment

Gets or sets the value for AxislabelPosition in axis, to render axis labels in center, near or far positions.

Declaration
[JsonProperty("alignment")]
[JsonConverter(typeof(StringEnumConverter))]
public Alignment Alignment { get; set; }
Property Value
Type Description
Alignment
Remarks

Specifies the position of the axis labels.

AlternateGridBand

Gets or sets values for AlternateGridBand properties, which provides options to customize horizontal and vertical grid bands.

Declaration
[JsonProperty("alternateGridBand")]
public AlternateGridBand AlternateGridBand { get; set; }
Property Value
Type Description
AlternateGridBand
Remarks

Options for customizing axis alternate grid band.

AxislabelPosition

Gets or sets the value for AxislabelPosition in axis, to render axis labels either inside of outside the axis line.

Declaration
[JsonProperty("labelPosition")]
[JsonConverter(typeof(StringEnumConverter))]
public AxislabelPosition AxislabelPosition { get; set; }
Property Value
Type Description
AxislabelPosition
Remarks

Specifies the position of the axis labels.

AxisLine

Gets or sets values for AxisLine properties, which provides options to customize axis lines.

Declaration
[JsonProperty("axisLine")]
public AxisLines AxisLine { get; set; }
Property Value
Type Description
AxisLines
Remarks

Options for customizing the axis line.

AxisTitlePosition

Declaration
[JsonProperty("axisTitlePosition")]
[JsonConverter(typeof(StringEnumConverter))]
public AxisTitlePosition AxisTitlePosition { get; set; }
Property Value
Type Description
AxisTitlePosition

CategoryInterval

Gets or sets the value for CategoryInterval in axis, which specifies interval values for rendering category axis.

Declaration
[JsonProperty("categoryInterval")]
public int CategoryInterval { get; set; }
Property Value
Type Description
System.Int32
Remarks

Specifies the interval for category axis

ColumnIndex

Gets or sets the value for ColumnIndex in axis, which specifies column index value, where axis is associated with.

Declaration
[JsonProperty("columnIndex")]
public int? ColumnIndex { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>
Remarks

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

ColumnSpan

Gets or sets the value for ColumnSpan in axis, to render axis horizontally based on number of columns specified.

Declaration
[JsonProperty("columnSpan")]
public int? ColumnSpan { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>
Remarks

Specifies the number of columns or plot areas an axis has to span horizontally.

CrossesAt

Gets or sets the crossing value, in which horizontal axis intersects with the vertical axis and vice versa.

Declaration
[JsonProperty("crossesAt")]
public double? CrossesAt { get; set; }
Property Value
Type Description
System.Nullable<System.Double>
Remarks

Specifies where to intersect with the horizontal / vertical axis

CrossesInAxis

Gets or sets the name of the axis to intersect with horizontal or vertical axis based on provided axis name.

Declaration
[JsonProperty("CrossesInAxis")]
public string CrossesInAxis { get; set; }
Property Value
Type Description
System.String
Remarks

Name of the axis to intersect with

CrosshairLabel

Gets or sets the value for CrosshairLabel, which provides option to customize crosshair labels of an axis.

Declaration
[JsonProperty("crosshairLabel")]
public CrosshairLabel CrosshairLabel { get; set; }
Property Value
Type Description
CrosshairLabel
Remarks

Options to customize the cross hair label.

DesiredIntervals

Gets or sets the value for DesiredIntervals in axis, to calculate axis intervals equal to specified desired interval.

Declaration
[JsonProperty("desiredIntervals")]
public int? DesiredIntervals { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>
Remarks

With this setting, you can request axis to calculate intervals approximately equal to your desired interval.

EdgeLabelPlacement

Gets or sets the value for EdgeLabelPlacement in axis, which renders axis labels at the edge of axis.

Declaration
[JsonConverter(typeof(StringEnumConverter))]
[JsonProperty("edgeLabelPlacement")]
public EdgeLabelPlacement EdgeLabelPlacement { get; set; }
Property Value
Type Description
EdgeLabelPlacement
Remarks

Specifies the position of labels at the edge of the axis.

EnableAutoIntervalOnZooming

Gets or sets the value for EnableAutoIntervalOnZooming in axis, to calculate auto interval during chart zooming.

Declaration
[JsonProperty("enableAutoIntervalOnZooming")]
public bool EnableAutoIntervalOnZooming { get; set; }
Property Value
Type Description
System.Boolean
Remarks

Specifies to calculate auto interval on zooming the chart.

EnableTrim

Gets or sets the value for EnableTrim in axis, to trim axis labels when its width is greater than maximum label width.

Declaration
[JsonProperty("enableTrim")]
public bool EnableTrim { get; set; }
Property Value
Type Description
System.Boolean
Remarks

Specifies whether to trim the axis label when the width of the label exceeds the maximumLabelWidth.

Font

Gets or sets the values for Font properties in axis, which provides options to customize axis labels font.

Declaration
[JsonProperty("font")]
public ChartFont Font { get; set; }
Property Value
Type Description
ChartFont
Remarks

Options for customizing the font of the axis Labels.

HidePartialLabels

Gets or sets the value for HidePartialLabels in axis, to hide axis labels which are rendered partially.

Declaration
[JsonProperty("hidePartialLabels")]
public bool HidePartialLabels { get; set; }
Property Value
Type Description
System.Boolean
Remarks

Specifies whether to hide the partially displayed axis labels.

IntervalType

Gets or sets the value for IntervalType in axis, to render axis lables based on specified interval type.

Declaration
[JsonConverter(typeof(StringEnumConverter))]
[JsonProperty("intervalType")]
public ChartIntervalType? IntervalType { get; set; }
Property Value
Type Description
System.Nullable<ChartIntervalType>
Remarks

Specifies the type of interval in date time axis.

IsIndexed

Gets or sets the value for IsIndexed in axis, which specifies whether the rendered axis is indexed or not.

Declaration
[JsonProperty("isIndexed")]
public bool IsIndexed { get; set; }
Property Value
Type Description
System.Boolean
Remarks

Specifies whether to indexed the axis.

IsInversed

Gets or sets the value for IsInversed in axis, to render axis labels from left to right in axis.

Declaration
[JsonProperty("isInversed")]
public bool IsInversed { get; set; }
Property Value
Type Description
System.Boolean
Remarks

Specifies whether to inverse the axis.

LabelBorder

Gets or sets the values for Border properties in axis, which provides options to customize axis labels border.

Declaration
[JsonProperty("labelBorder")]
public ChartBorder LabelBorder { get; set; }
Property Value
Type Description
ChartBorder
Remarks

Options for customizing the border of the axis Labels.

LabelFormat

Gets or sets the value for LabelFormat in axis, to format the axis label which supports date time and numeric format values.

Declaration
[JsonProperty("labelFormat")]
public string LabelFormat { get; set; }
Property Value
Type Description
System.String
Remarks

Custom formatting for axis label and supports all standard formatting type of numerical and date time values.

LabelIntersectAction

Gets or sets the value for LabelIntersectAction in axis, to render axis labels without overlapping with other labels.

Declaration
[JsonProperty("labelIntersectAction")]
[JsonConverter(typeof(StringEnumConverter))]
public LabelIntersectAction LabelIntersectAction { get; set; }
Property Value
Type Description
LabelIntersectAction
Remarks

Specifies the action to take when the axis labels are overlapping with each other.

LabelPlacement

Gets or sets the value for LabelPlacement in axis, to place the axis labels at specified position.

Declaration
[JsonProperty("labelPlacement")]
public string LabelPlacement { get; set; }
Property Value
Type Description
System.String
Remarks

Specifies the position of the labels.

LabelRotation

Gets or sets the value for LabelRotation in axis, to rotate labels of axis based on its specified degrees.

Declaration
[JsonProperty("labelRotation")]
public int? LabelRotation { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>
Remarks

Angle in degrees to rotate the axis labels.

LogBase

Gets or sets the value for LogBase in axis, which displays horizontal or vertical axis with logarithmic values.

Declaration
[JsonProperty("logBase")]
public int LogBase { get; set; }
Property Value
Type Description
System.Int32
Remarks

Logarithmic base value. This is applicable only for logarithmic axis.

MajorGridLines

Gets or sets values for axis MajorGridLines properties, which provides options to customize major grid lines for axis.

Declaration
[JsonProperty("majorGridLines")]
public MajorGridLines MajorGridLines { get; set; }
Property Value
Type Description
MajorGridLines
Remarks

Options for customizing major grid lines.

MajorTickLines

Gets or sets values for MajorTickLines properties, which provides options to customize major tick lines of axis.

Declaration
[JsonProperty("majorTickLines")]
public MajorTicks MajorTickLines { get; set; }
Property Value
Type Description
MajorTicks
Remarks

Options for customizing the major tick lines.

MaximumLabels

Gets or sets the value for MaximumLabels in axis, to display maximum number of axis labels in every hundred pixels.

Declaration
[JsonProperty("maximumLabels")]
public int MaximumLabels { get; set; }
Property Value
Type Description
System.Int32
Remarks

Maximum number of labels to be displayed in every 100 pixels.

MaximumLabelWidth

Gets or sets the value for MaximumLabelWidth in axis, which represents maximum label width of horizontal and vertical axis.

Declaration
[JsonProperty("maximumLabelWidth")]
public double MaximumLabelWidth { get; set; }
Property Value
Type Description
System.Double
Remarks

Maximum width of the axis label. When the label exceeds the width, the label gets trimmed when the enableTrim is set to true.

MinorGridLines

Gets or sets values for MinorGridLines properties, which provides options to customize minor grid lines of axis.

Declaration
[JsonProperty("minorGridLines")]
public MinorGridLines MinorGridLines { get; set; }
Property Value
Type Description
MinorGridLines
Remarks

Options for customizing the minor grid lines.

MinorTickLines

Gets or sets values for MinorTickLines properties, which provides options to customize minor tick lines of axis.

Declaration
[JsonProperty("minorTickLines")]
public MinorTicks MinorTickLines { get; set; }
Property Value
Type Description
MinorTicks
Remarks

Options for customizing the minor tick lines.

MinorTicksPerInterval

Gets or sets the value for MinorTicksPerInterval in axis, which represents number of minor ticks for each interval.

Declaration
[JsonProperty("minorTicksPerInterval")]
public int? MinorTicksPerInterval { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>
Remarks

Specifies the number of minor ticks per interval.

MultiLevelLabels

Gets or sets the value for multi-level labels properties, which provides options to customize multi level labels of an axis.

Declaration
[JsonProperty("multiLevelLabels")]
public List<MultiLevelLabels> MultiLevelLabels { get; }
Property Value
Type Description
System.Collections.Generic.List<MultiLevelLabels>
Remarks

Options for customizing the multi-level labels.

Name

Gets or sets the value for Name, to associate axis with series based on specified name for axis.

Declaration
[JsonProperty("name")]
public string Name { get; set; }
Property Value
Type Description
System.String
Remarks

Unique name of the axis. To associate an axis with the series, you have to set this name to the XAxisName/YAxisName property of the series.

OpposedPosition

Gets or sets the value for OpposedPosition in axis, to render axis at opposite position of its default position.

Declaration
[JsonProperty("opposedPosition")]
public bool OpposedPosition { get; set; }
Property Value
Type Description
System.Boolean
Remarks

Specifies whether to render the axis at the opposite side of its default position.

Orientation

Gets or sets the value for Orientation in axis, to display the axis line in horizontal or vertical direction.

Declaration
[JsonProperty("orientation")]
public string Orientation { get; set; }
Property Value
Type Description
System.String
Remarks

Specifies orientation of axis line.

PlotOffset

Gets or sets the value for PlotOffset in axis, which specifies padding value of chart plot area in axis.

Declaration
[JsonProperty("plotOffset")]
public int PlotOffset { get; set; }
Property Value
Type Description
System.Int32
Remarks

Specifies the padding for the plot area.

Range

Gets or sets the value for Range in axis, which provides options to specify minimum, maximum and interval for axis ranges.

Declaration
[JsonProperty("range")]
public Range Range { get; set; }
Property Value
Type Description
Range
Remarks

Specified the range of the axis.

RangePadding

Gets or sets the value for RangePadding in axis, to apply padding for horizontal and vertical axis ranges.

Declaration
[JsonProperty("rangePadding")]
[JsonConverter(typeof(StringEnumConverter))]
public ChartRangePadding RangePadding { get; set; }
Property Value
Type Description
ChartRangePadding
Remarks

Specifies the padding for the axis range.

RotateOn

Gets or sets the value for TextAnchor in axis to position the rotated axis labels based on specified text anchor.

Declaration
[JsonProperty("rotateOn")]
[JsonConverter(typeof(StringEnumConverter))]
public RotateOn RotateOn { get; set; }
Property Value
Type Description
RotateOn
Remarks

Specifies text anchor position when axis labels are rotated.

RoundingPlaces

Gets or sets the value for RoundingPlaces in axis, which rounds the number based on specified number of decimals.

Declaration
[JsonProperty("roundingPlaces")]
public int? RoundingPlaces { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>
Remarks

Rounds the number to the given number of decimals.

RowIndex

Gets or sets the value for RowIndex in axis, which specifies row index value where axis is associated with.

Declaration
[JsonProperty("rowIndex")]
public int? RowIndex { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>
Remarks

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

RowSpan

Gets or sets the value for RowSpan in axis, to render axis vertically based on number of rows specified.

Declaration
[JsonProperty("rowSpan")]
public int? RowSpan { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>
Remarks

Specifies the number of rows or plot areas an axis has to span vertically.

ScrollbarSettings

Gets or sets the value for ScrollbarSettings, which provides options to customize scrollbar of an axis.

Declaration
[JsonProperty("scrollbarSettings")]
public ScrollbarSettings ScrollbarSettings { get; set; }
Property Value
Type Description
ScrollbarSettings
Remarks

Options for customizing the axis scrollbarSettings.

ShowNextToAxisLine

Gets or sets the value for showNextToAxisLine in axis, to place axis labels based on crossesAt value for axis.

Declaration
[JsonProperty("showNextToAxisLine")]
public bool ShowNextToAxisLine { get; set; }
Property Value
Type Description
System.Boolean
Remarks

Specifies the label position at origin while axis crossesAt the values .

StartFromZero

Gets or sets the value for startFromZero in axis, in which specified axis ranges are start from zero.

Declaration
[JsonProperty("startFromZero")]
public bool StartFromZero { get; set; }
Property Value
Type Description
System.Boolean
Remarks

Specifies whether to startFromZero for axis.

StripLine

Gets or sets the value for StripLine properties, which provides options to customize striplines of an axis.

Declaration
[JsonProperty("stripLine")]
public List<StripLine> StripLine { get; }
Property Value
Type Description
System.Collections.Generic.List<StripLine>
Remarks

Options for customizing the strip lines.

TickLinesPosition

Gets or sets the value for TickLinesPosition in axis, to render axis tick lines either inside or outside axis line.

Declaration
[JsonProperty("tickLinesPosition")]
[JsonConverter(typeof(StringEnumConverter))]
public TickLinesPosition TickLinesPosition { get; set; }
Property Value
Type Description
TickLinesPosition
Remarks

Specifies the position of the axis tick lines.

Title

Gets or sets the value for Title, which provides various options to customize the horizontal or vertical axis title.

Declaration
[JsonProperty("title")]
public Title Title { get; set; }
Property Value
Type Description
Title
Remarks

Options for customizing the axis title.

ValueType

Gets or sets the value for ValueType in axis, to denote value type in which horizontal or vertical axis is handling.

Declaration
[JsonConverter(typeof(StringEnumConverter))]
[JsonProperty("valueType")]
public AxisValueType? ValueType { get; set; }
Property Value
Type Description
System.Nullable<AxisValueType>
Remarks

Specifies the type of data the axis is handling.

Visible

Gets or sets the value for Visible in axis, to control visibility of horizontal and vertical axis elements.

Declaration
[JsonProperty("visible")]
public bool Visible { get; set; }
Property Value
Type Description
System.Boolean
Remarks

Show/hides the axis.

ZoomFactor

Gets or sets the value for ZoomFactor in axis, which represents scaled horizontal and vertical axis whose values range between 0 to 1.

Declaration
[JsonProperty("zoomFactor")]
public double ZoomFactor { get; set; }
Property Value
Type Description
System.Double
Remarks

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.

ZoomPosition

Gets or sets the value for ZoomPosition in axis, which represents zoomed horizontal and vertical axis position whose values range between 0 to 1.

Declaration
[JsonProperty("zoomPosition")]
public double ZoomPosition { get; set; }
Property Value
Type Description
System.Double
Remarks

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

Methods

ShouldSerializeAlternateGridBand()

Declaration
public bool ShouldSerializeAlternateGridBand()
Returns
Type Description
System.Boolean

ShouldSerializeAxisLine()

Declaration
public bool ShouldSerializeAxisLine()
Returns
Type Description
System.Boolean

ShouldSerializeCrosshairLabel()

Declaration
public bool ShouldSerializeCrosshairLabel()
Returns
Type Description
System.Boolean

ShouldSerializeFont()

Declaration
public bool ShouldSerializeFont()
Returns
Type Description
System.Boolean

ShouldSerializeLabelBorder()

Declaration
public bool ShouldSerializeLabelBorder()
Returns
Type Description
System.Boolean

ShouldSerializeMajorGridLines()

Declaration
public bool ShouldSerializeMajorGridLines()
Returns
Type Description
System.Boolean

ShouldSerializeMajorTickLines()

Declaration
public bool ShouldSerializeMajorTickLines()
Returns
Type Description
System.Boolean

ShouldSerializeMinorGridLines()

Declaration
public bool ShouldSerializeMinorGridLines()
Returns
Type Description
System.Boolean

ShouldSerializeMinorTickLines()

Declaration
public bool ShouldSerializeMinorTickLines()
Returns
Type Description
System.Boolean

ShouldSerializeMultiLevelLabels()

Declaration
public bool ShouldSerializeMultiLevelLabels()
Returns
Type Description
System.Boolean

ShouldSerializeRange()

Declaration
public bool ShouldSerializeRange()
Returns
Type Description
System.Boolean

ShouldSerializeStripline()

Declaration
public bool ShouldSerializeStripline()
Returns
Type Description
System.Boolean

ShouldSerializeTitle()

Declaration
public bool ShouldSerializeTitle()
Returns
Type Description
System.Boolean

ShouldSerializeZoomFactor()

Declaration
public bool ShouldSerializeZoomFactor()
Returns
Type Description
System.Boolean

ShouldSerializeZoomPosition()

Declaration
public bool ShouldSerializeZoomPosition()
Returns
Type Description
System.Boolean