ASP.NET Core - EJ2

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class ChartAxis

    Show / Hide Table of Contents

    Class ChartAxis

    Inheritance
    System.Object
    EJTagHelper
    ChartAxis
    ChartPrimaryXAxisChart
    ChartPrimaryYAxisChart
    Inherited Members
    EJTagHelper.GetList()
    EJTagHelper.Process(TagHelperContext, TagHelperOutput)
    EJTagHelper.RegisterScript()
    EJTagHelper.GetSerializedProperties()
    EJTagHelper.GetScriptString()
    EJTagHelper.GetHtmlAttrString(IDictionary<String, Object>)
    EJTagHelper.TagName
    EJTagHelper.ViewContext
    EJTagHelper.For
    EJTagHelper.Id
    EJTagHelper.NameSpace
    EJTagHelper.ClassName
    EJTagHelper.IsFor
    EJTagHelper.IsChild
    EJTagHelper.IsCollection
    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
    public ChartLabelBorder Border { get; set; }
    Property Value
    Type Description
    ChartLabelBorder

    The default value is null

    Coefficient

    The polar radar radius position.

    Declaration
    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
    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
    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
    public string CrossesInAxis { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    CrosshairTooltip

    Options to customize the crosshair ToolTip.

    Declaration
    public ChartCrosshairTooltip CrosshairTooltip { get; set; }
    Property Value
    Type Description
    ChartCrosshairTooltip

    The default value is null

    Description

    Description for axis and its element.

    Declaration
    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
    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
    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
    public bool EnableAutoIntervalOnZooming { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is true

    EnableScrollbarOnZooming

    Enables the scrollbar for zooming.

    Declaration
    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
    public bool EnableTrim { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is false

    Interval

    Specifies the interval for an axis.

    Declaration
    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
    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
    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
    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
    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
    public LabelIntersectAction LabelIntersectAction { get; set; }
    Property Value
    Type Description
    LabelIntersectAction

    The default value is LabelIntersectAction.Trim

    LabelPadding

    Specifies the labelPadding from axis.

    Declaration
    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
    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
    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
    public double LabelRotation { get; set; }
    Property Value
    Type Description
    System.Double

    The default value is 0

    LabelStyle

    Options to customize the axis label.

    Declaration
    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
    public TextAlignment LineBreakAlignment { get; set; }
    Property Value
    Type Description
    TextAlignment

    The default value is TextAlignment.Center

    LineStyle

    Options for customizing axis lines.

    Declaration
    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
    public double LogBase { get; set; }
    Property Value
    Type Description
    System.Double

    The default value is 10

    MajorGridLines

    Options for customizing major grid lines.

    Declaration
    public ChartMajorGridLines MajorGridLines { get; set; }
    Property Value
    Type Description
    ChartMajorGridLines

    The default value is null

    MajorTickLines

    Options for customizing major tick lines.

    Declaration
    public ChartMajorTickLines MajorTickLines { get; set; }
    Property Value
    Type Description
    ChartMajorTickLines

    The default value is null

    Maximum

    Specifies the maximum range of an axis.

    Declaration
    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
    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
    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
    public object Minimum { get; set; }
    Property Value
    Type Description
    System.Object

    The default value is null

    MinorGridLines

    Options for customizing minor grid lines.

    Declaration
    public ChartMinorGridLines MinorGridLines { get; set; }
    Property Value
    Type Description
    ChartMinorGridLines

    The default value is null

    MinorTickLines

    Options for customizing minor tick lines.

    Declaration
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    public double Span { get; set; }
    Property Value
    Type Description
    System.Double

    The default value is 1

    StartAngle

    The start angle for the series.

    Declaration
    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
    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
    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
    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
    public AxisPosition TickPosition { get; set; }
    Property Value
    Type Description
    AxisPosition

    The default value is AxisPosition.Outside

    Title

    Specifies the title of an axis.

    Declaration
    public string Title { get; set; }
    Property Value
    Type Description
    System.String

    The default value is ""

    TitlePadding

    Specifies the titlePadding from axis label.

    Declaration
    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
    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
    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
    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
    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
    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
    public double ZoomPosition { get; set; }
    Property Value
    Type Description
    System.Double

    The default value is 0

    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved