Class ChartAxis

The ChartAxis class represents an axis on the plot. An axis can be oriented vertically or horizontally. Multiple axes can exist within a chart, including one X-axis and one Y-axis which are considered the primary X and primary Y axes. These primary axes are visible by default. You can create and add additional axes to the ChartArea using its Axes collection. Any series on the chart can be plotted on any axis that is registered with the chart.

Inheritance
System.Object
ChartAxis
Implements
System.IDisposable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Syncfusion.Windows.Forms.Chart
Assembly: Syncfusion.Chart.Base.dll
Syntax
public class ChartAxis : IDisposable

Constructors

ChartAxis()

Initializes a new instance of the ChartAxis class.

Declaration
public ChartAxis()

ChartAxis(ChartOrientation)

Initializes a new instance of the ChartAxis class.

Declaration
public ChartAxis(ChartOrientation orientation)
Parameters
Type Name Description
ChartOrientation orientation

The orientation.

ChartAxis(Boolean)

Initializes a new instance of the ChartAxis class.

Declaration
[Obsolete("Primary axis is computed automatically, as first vertical or horizontal axis.")]
public ChartAxis(bool isPrimary)
Parameters
Type Name Description
System.Boolean isPrimary

if set to true axis is primary.

Properties

AutoSize

Gets or sets a value indicating whether the size of the chart axis should be calculated automatically.

Declaration
public bool AutoSize { get; set; }
Property Value
Type
System.Boolean

AutoValueType

[Obsolete] This property is no longer supported - hidden from designer and IntelliSense. Previously determined axis value types automatically, but caused inconsistencies with explicit ValueType settings. Use ValueType properties instead.

Declaration
[Obsolete("This property isn't used.")]
public bool AutoValueType { get; set; }
Property Value
Type
System.Boolean

AxisLabelPlacement

Gets or sets a value indicates whether label is located inside or outside of chart area.

Declaration
public ChartPlacement AxisLabelPlacement { get; set; }
Property Value
Type Description
ChartPlacement

The legends placement.

BreakInfo

Gets or sets the break info to customize the axes line.

Declaration
[ChartTemplate(ChartTemplateSet.Content)]
public ChartAxisBreakInfo BreakInfo { get; set; }
Property Value
Type Description
ChartAxisBreakInfo

The break info.

BreakRanges

Gets the break ranges.

Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public ChartAxisRange BreakRanges { get; }
Property Value
Type Description
ChartAxisRange

The break ranges.

Breaks

Gets the breaks for an axis.

Declaration
[Obsolete("This property is useless. Use BreakInfo property.")]
public MinMaxInfo[] Breaks { get; }
Property Value
Type
MinMaxInfo[]

Crossing

Specifies the double value.This property is used to locate the X and Y axes in chart area based on the specified value. specified value must be within the range of X and Y axes values.

Declaration
public double Crossing { get; set; }
Property Value
Type
System.Double

CurrentSmartDateTimeFormat

Gets the current smart date time format.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public string CurrentSmartDateTimeFormat { get; }
Property Value
Type Description
System.String

The current smart date time format.

CustomLabelsParameter

Gets or sets the the parameter types of GetLabelAt(Int32) method.

Declaration
public ChartCustomLabelsParameter CustomLabelsParameter { get; set; }
Property Value
Type Description
ChartCustomLabelsParameter

The parameter type.

CustomOrigin

By default the axis will calculate the origin of the axis from data contained in the series. Using the OriginDate and Origin properties, you can change this origin. To do so, first set this property to true. Default is false.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool CustomOrigin { get; set; }
Property Value
Type
System.Boolean

DateTimeFormat

This format will be used to format axis labels of type DateTime for display. Default is "g".

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public string DateTimeFormat { get; set; }
Property Value
Type
System.String

DateTimeInterval

Gets or sets the date time range of this axis as DateTime values. Note: it works only if ValueType is DateTime.

Declaration
public ChartDateTimeInterval DateTimeInterval { get; }
Property Value
Type
ChartDateTimeInterval

DateTimeOffset

Gets or sets an offset for axis intervals that contain DateTime datas. Depending on the data in the series provided to the Chart, the Chart will calculate and display a range of data on the ChartAxis. This will result in major grid lines being rendered along calculated intervals. However, sometimes you may wish to offset the calculated grid lines (major) by a certain factor. This is especially useful for DateTime values. For example, the default calculation always starts the intervals at Sunday (if the IntervalType is set to weeks). If you wish to start the intervals with Monday, you can simply specify a DateTimeOffset of one day. If your axis is not of type DateTime and you wish to take advantage of this property, please refer Offset.

Declaration
public TimeSpan DateTimeOffset { get; set; }
Property Value
Type
System.TimeSpan

DateTimeRange

Specify the start and end dates and interval time for the axis. Use this if the data points are of datetime type.

Declaration
public ChartDateTimeRange DateTimeRange { get; set; }
Property Value
Type
ChartDateTimeRange

DefaultOrientation

Gets the default orientation.

Declaration
protected ChartOrientation DefaultOrientation { get; }
Property Value
Type
ChartOrientation

DesiredIntervals

Gets or sets the desired number of intervals for the range. Essential Chart includes a sophisticated automatic nice range calculation engine. The goal of this engine is to take raw data and convert it into human readable numbers. For example, if your raw numbers are 1.2 - 3.87, nice numbers could be 0-5 with 10 intervals of 0.5 each. The ChartAxis can do the same calculation for dates also. It offers precise control over how data types are to be interpreted when performing this calculation. With the DesiredIntervals setting, you can request the engine to calculate nice numbers such that they result in the number of intervals desired. Due to the nature of the calculation, the ChartAxis cannot provide precisely the same number of intervals but it will try to match the value to the extent possible.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public int DesiredIntervals { get; set; }
Property Value
Type
System.Int32

Dimension

Gets or sets the cardinal dimension of the axis object. If the text that is rendered by the axis is of a dimension that is more, then that dimension will be used and this dimension is ignored.

Declaration
public float Dimension { get; set; }
Property Value
Type
System.Single

DrawGrid

Gets or sets a value indicating whether the grid lines associated with the main interval points on the axis are to be rendered. This is set to True by default.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool DrawGrid { get; set; }
Property Value
Type
System.Boolean

DrawMinorGrid

Gets or sets a value indicating whether the minor grid lines associated with the main interval points on the axis are to be rendered. This is set to True by default.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool DrawMinorGrid { get; set; }
Property Value
Type
System.Boolean

DrawTickLabelGrid

Gets or sets a value indicating whether label grid is visible.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool DrawTickLabelGrid { get; set; }
Property Value
Type Description
System.Boolean

true if label grid is visible; otherwise, false.

EdgeLabelsDrawingMode

Gets or sets the edge labels drawing mode.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public ChartAxisEdgeLabelsDrawingMode EdgeLabelsDrawingMode { get; set; }
Property Value
Type
ChartAxisEdgeLabelsDrawingMode

EnableZoomedInterval

Specifies whether interval should be recalculated during zooming or not. If this property is disabled, then interval value assigned to ZoomedRange.Interval property will be used as interval in zoomed chart

Declaration
public bool EnableZoomedInterval { get; set; }
Property Value
Type
System.Boolean

ExcludeInvisibleSeriesRange

Gets or sets a value indicating whether this instance is visible.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool ExcludeInvisibleSeriesRange { get; set; }
Property Value
Type
System.Boolean

Font

Gets or sets the font that is to be used for text that is rendered in association with the axis (such as axis labels).

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public Font Font { get; set; }
Property Value
Type
System.Drawing.Font

ForceZero

Indicates whether one boundary of the calculated range should always be tweaked to zero.

Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public bool ForceZero { get; set; }
Property Value
Type
System.Boolean

ForceZeroToDouble

Indicates whether one boundary of the calculated range should always be tweaked to zero to both positive and negative value.

Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public bool ForceZeroToDouble { get; set; }
Property Value
Type
System.Boolean

ForeColor

Gets or sets the color that is to be used for text that is rendered in association with the axis (such as axis labels).

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public Color ForeColor { get; set; }
Property Value
Type
System.Drawing.Color

Format

Gets or sets the format for axis labels. If the value type of the axis is double, this format will be used to format axis labels for display.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public string Format { get; set; }
Property Value
Type
System.String

GridDrawMode

Gets or sets the grid drawing mode.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public ChartAxisGridDrawingMode GridDrawMode { get; set; }
Property Value
Type Description
ChartAxisGridDrawingMode

The grid draw mode.

GridLineType

Gets the attributes of the axis grid lines. Please refer to LineInfo for more information on these attributes and how they can change the appearance of the grid lines.

Declaration
[ChartTemplate(ChartTemplateSet.Content)]
public LineInfo GridLineType { get; }
Property Value
Type
LineInfo

GroupingLabels

Collection of grouping labels associated with this axis.

Declaration
public ChartAxisGroupingLabelCollection GroupingLabels { get; }
Property Value
Type
ChartAxisGroupingLabelCollection

GroupingLabelsImpl

Use this property to assign a custom implementation of IChartAxisLabelModel. If you are working with the default label collection, use Labels.

Declaration
public IChartAxisGroupingLabelModel GroupingLabelsImpl { get; set; }
Property Value
Type
IChartAxisGroupingLabelModel

HidePartialLabels

Indicates whether partially visible axis labels should be hidden.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool HidePartialLabels { get; set; }
Property Value
Type
System.Boolean

Indexed

This property is for internal use. Do not try to set it manually. It indicates whether this ChartAxis is indexed. Indexed axes have only positional value. They do not actually plot value data; only the position of the data is used for plotting. You may read the value, but do not set it manually.

Declaration
[Obsolete("This property isn't used anymore")]
public bool Indexed { get; set; }
Property Value
Type Description
System.Boolean

true if axis is indexed; false otherwise.

InterlacedGrid

Gets or sets a value indicating whether interlaced grid is enabled.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool InterlacedGrid { get; set; }
Property Value
Type Description
System.Boolean

true if interlaced grid is enabled; otherwise, false.

InterlacedGridInterior

Gets or sets the interlaced grid interior.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public BrushInfo InterlacedGridInterior { get; set; }
Property Value
Type Description
BrushInfo

The interlaced grid interior.

IntervalType

Gets or sets a value indicating whether the interval that gets calculated by the nice range calculation engine should be in Years, Months, Weeks, Days, Hours, Minutes, Seconds or MilliSeconds. This setting is used only if the ValueType of the axis is set to DateTime. Default value is Auto.

Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public ChartDateTimeIntervalType IntervalType { get; set; }
Property Value
Type
ChartDateTimeIntervalType

Inversed

Gets or sets a value indicating whether the axis should be reversed. When reversed, the axis will render points from right to left if horizontal and top to bottom when vertical.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool Inversed { get; set; }
Property Value
Type
System.Boolean

IsVisible

Gets or sets a value indicating whether this instance is visible.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool IsVisible { get; set; }
Property Value
Type Description
System.Boolean

true if this instance is visible; otherwise, false.

LabelAlignment

Gets or sets label alignment.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public StringAlignment LabelAlignment { get; set; }
Property Value
Type
System.Drawing.StringAlignment

LabelIntersectAction

Gets or sets the label intersect action. Labels can intersect on the axis if they are too close to each other. ChartAxis offers several options to enhance the display of the axis when such intersection occurs. Please see ChartLabelIntersectAction for more information.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public ChartLabelIntersectAction LabelIntersectAction { get; set; }
Property Value
Type
ChartLabelIntersectAction
Remarks

LabelIntersectAction is applicable for horizontally orientated axes only.

LabelIntersectionActionEffect

Gets or sets the Label intersection control option. ChartLabelIntersectionActionEffect

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
[Obsolete("This property isn't used anymore.")]
public ChartLabelIntersectionActionEffect LabelIntersectionActionEffect { get; set; }
Property Value
Type
ChartLabelIntersectionActionEffect

LabelPlacement

Gets or sets the label placement on axis. Labels can be placed between ticks only for categorical axis

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public ChartAxisLabelPlacement LabelPlacement { get; set; }
Property Value
Type
ChartAxisLabelPlacement

LabelRotate

Gets or sets a value indicating whether labels can be rotated.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool LabelRotate { get; set; }
Property Value
Type
System.Boolean

LabelRotateAngle

Gets or sets the angle at which labels are to be rotated.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public int LabelRotateAngle { get; set; }
Property Value
Type
System.Int32

Labels

Gets the collection of labels associated with this axis.

Declaration
public ChartAxisLabelCollection Labels { get; }
Property Value
Type
ChartAxisLabelCollection

LabelsImpl

Use this property to assign a custom implementation of IChartAxisLabelModel. If you are working with the default label collection, use Labels.

Declaration
public IChartAxisLabelModel LabelsImpl { get; set; }
Property Value
Type
IChartAxisLabelModel

LabelsOffset

Gets or sets LebelsOffset. It specifies the offset that should be applied to the automatically calculated labels.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public double LabelsOffset { get; set; }
Property Value
Type Description
System.Double

The labels offset.

LabelStringFormat

Get or Sets the string format of label.Default value is StringFormat.GenericDefault.

Declaration
public StringFormat LabelStringFormat { get; set; }
Property Value
Type
System.Drawing.StringFormat

LineType

Returns attributes of the primary axis line. Please refer to LineInfo for more information on these attributes and how they can change the appearance of the axis line.

Declaration
[ChartTemplate(ChartTemplateSet.Content)]
public LineInfo LineType { get; }
Property Value
Type
LineInfo

Location

If LocationType is set to ChartAxisLocationType.Set, then this property is used to calculate RenderGlobalBounds and in such a way to define location of axes.

Declaration
public PointF Location { get; set; }
Property Value
Type
System.Drawing.PointF

LocationType

Determines how location of axes is calculated. See Location.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public ChartAxisLocationType LocationType { get; set; }
Property Value
Type
ChartAxisLocationType

LogBase

Gets or sets the log base that is to be used when value is logarithimic. Default is base 10.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public int LogBase { get; set; }
Property Value
Type
System.Int32

LogLabelsDisplayMode

Gets or sets whether labels should be an integer power of log base or not. Applicable only for logarithmic axis.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public LogLabelsDisplayMode LogLabelsDisplayMode { get; set; }
Property Value
Type
LogLabelsDisplayMode

MakeBreaks

Indicates whether the breaks should be shown for the specified axis.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool MakeBreaks { get; set; }
Property Value
Type
System.Boolean

Margin

Gets or sets a value indicating whether this ChartAxis Showa some space as margin.

Declaration
public bool Margin { get; set; }
Property Value
Type Description
System.Boolean

true if margin; otherwise, false.

MinorGridLineType

Gets the attributes of the axis grid lines. Please refer to LineInfo for more information on these attributes and how they can change the appearance of the grid lines.

Declaration
[ChartTemplate(ChartTemplateSet.Content)]
public LineInfo MinorGridLineType { get; }
Property Value
Type
LineInfo

Offset

Gets or sets the Offset. It specifies the offset that should be applied to the automatically calculated range's start value.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public double Offset { get; set; }
Property Value
Type
System.Double

OpposedPosition

If this axis is a secondary axis, setting this property to True will cause it to move to the opposite side of the primary axis. This property is False by default.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool OpposedPosition { get; set; }
Property Value
Type
System.Boolean

Orientation

Gets or sets the Orientation of the axis. You cannot change the orientation of primary axes. Primary axes are the ones that are created and available by default in the Axes collection.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public ChartOrientation Orientation { get; set; }
Property Value
Type
ChartOrientation

Origin

Gets or sets custom origin for charts containing datas of double value type. By default, the axis will calculate the origin of the axis from data contained in the series. Using the OriginDate and Origin properties, you can change this origin. To enable the origin set with Origin or OriginDate, you have to set CustomOrigin to True.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public double Origin { get; set; }
Property Value
Type
System.Double

OriginDate

Gets or sets custom origin for charts containing datas of DateTime value type. By default the axis will calculate the origin of the axis from data contained in the series. Using the OriginDate and Origin properties, you can change this origin. To enable the origin set with Origin or OriginDate, you have to set CustomOrigin to True.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public DateTime OriginDate { get; set; }
Property Value
Type
System.DateTime

Pens

Gets or sets a collection of pens by using which internal line of Polar and Radar chart is drawned.

Declaration
public Pen[] Pens { get; set; }
Property Value
Type
System.Drawing.Pen[]

PointOffset

Gets or sets the PointOffset. It specifies the points offset that should be applied to the automatically calculated range's start value.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public double PointOffset { get; set; }
Property Value
Type
System.Double

PreferZero

Indicates that you would like one boundary of the calculated range to be tweaked to zero.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool PreferZero { get; set; }
Property Value
Type
System.Boolean

Range

Gets or sets the range for an axis. By default, the chart will automatically calculate the range that is to be displayed. The range property allows you to change this range to be any range of your choice. Set ChartAxis.RangeType to Set for this to take effect.

Declaration
[ChartTemplate(ChartTemplateSet.ContentBehavior)]
public MinMaxInfo Range { get; set; }
Property Value
Type
MinMaxInfo

RangePaddingType

Gets or sets the padding that will be applied when calculating the axis range.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public ChartAxisRangePaddingType RangePaddingType { get; set; }
Property Value
Type
ChartAxisRangePaddingType

RangeType

Gets or sets the range type. ChartAxisRangeType

Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public ChartAxisRangeType RangeType { get; set; }
Property Value
Type
ChartAxisRangeType

RealLength

Gets or sets the length of this axis.

Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public float RealLength { get; set; }
Property Value
Type
System.Single

Rect

Gets or sets the location and size of the rectangular region occupied by the axis.

Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public RectangleF Rect { get; set; }
Property Value
Type
System.Drawing.RectangleF

RequireInvertedAxes

Gets or sets a value indicating whether require inverted axes.

Declaration
[Obsolete("This property isn't used anymore.")]
public bool RequireInvertedAxes { get; set; }
Property Value
Type
System.Boolean

RotateFromTicks

Gets or sets a value indicating whether label is rotate from Ticks while using Far.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool RotateFromTicks { get; set; }
Property Value
Type
System.Boolean

RoundingPlaces

Gets or sets the number of places that is to be used for rounding when numbers are used for display (default is 2). If this property less zero, rounding is disable.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public int RoundingPlaces { get; set; }
Property Value
Type
System.Int32

ScaleLabels

Gets or sets a value indicating whether labels can be scaled.

Declaration
[Obsolete("Behavior of this property is incorrect. This property only for internal usage.")]
public bool ScaleLabels { get; set; }
Property Value
Type
System.Boolean

ScrollBar

Internal property.

Declaration
public IChartScrollBar ScrollBar { get; set; }
Property Value
Type
IChartScrollBar

ShowAxisLabelTooltip

Gets or sets a value indicating whether the tool tip associated with the axis labels are to be rendered. This is set to True by default.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool ShowAxisLabelTooltip { get; set; }
Property Value
Type
System.Boolean

ShowCrosshairTooltip

Gets or sets a value indicating whether tooltip should be displayed in axis for crosshair or trackball. This is set to False by default.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool ShowCrosshairTooltip { get; set; }
Property Value
Type
System.Boolean

Size

Gets or sets the size of this axis.

Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public SizeF Size { get; set; }
Property Value
Type
System.Drawing.SizeF

SmallTickSize

Gets or sets the size of small ticks to be displayed on the axis. By default, small ticks are not displayed.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public Size SmallTickSize { get; set; }
Property Value
Type
System.Drawing.Size

SmallTicksPerInterval

Gets or sets the number of small ticks to be displayed per major interval. Default is 0.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public int SmallTicksPerInterval { get; set; }
Property Value
Type
System.Int32

SmartDateZoom

Gets or sets a value indicating whether to set zoom factor and labels format according to the improved date time zoom logic or to use default zooming behaviour.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool SmartDateZoom { get; set; }
Property Value
Type
System.Boolean

SmartDateZoomDayLevelLabelFormat

Indicates whether to set zoom factor and labels format according improved date time zoom logic or to use default zooming behaviour. Default is "g"

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public string SmartDateZoomDayLevelLabelFormat { get; set; }
Property Value
Type
System.String

SmartDateZoomHourLevelLabelFormat

Gets or sets a value indicating whether to set zoom factor and labels format according improved date time zoom logic or to use default zooming behaviour. Default is "t".

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public string SmartDateZoomHourLevelLabelFormat { get; set; }
Property Value
Type
System.String

SmartDateZoomLabelsCulture

Gets or sets a value indicating whether to set zoom factor and labels format according improved date time zoom logic or to use default zooming behaviour.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public string SmartDateZoomLabelsCulture { get; set; }
Property Value
Type
System.String

SmartDateZoomMinuteLevelLabelFormat

Gets or sets a value indicating whether to set zoom factor and labels format according improved date time zoom logic or to use default zooming behaviour. Default is "T".

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public string SmartDateZoomMinuteLevelLabelFormat { get; set; }
Property Value
Type
System.String

SmartDateZoomMonthLevelLabelFormat

Gets or sets a value indicating whether to set zoom factor and labels format according improved date time zoom logic or to use default zooming behaviour. Default is "MMMM d, yyyy"

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public string SmartDateZoomMonthLevelLabelFormat { get; set; }
Property Value
Type
System.String

SmartDateZoomSecondLevelLabelFormat

Gets or sets a value indicating whether to set zoom factor and labels format according improved date time zoom logic or to use default zooming behaviour. Default is "T".

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public string SmartDateZoomSecondLevelLabelFormat { get; set; }
Property Value
Type
System.String

SmartDateZoomWeekLevelLabelFormat

Gets or sets a value indicating whether to set zoom factor and labels format according improved date time zoom logic or to use default zooming behaviour. Default is "MMM, ddd d, yyyy".

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public string SmartDateZoomWeekLevelLabelFormat { get; set; }
Property Value
Type
System.String

SmartDateZoomYearLevelLabelFormat

Gets or sets a value indicating whether to set zoom factor and labels format according improved date time zoom logic or to use default zooming behaviour. Default is "y".

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public string SmartDateZoomYearLevelLabelFormat { get; set; }
Property Value
Type
System.String

StripLines

Gets the collection of strip lines. Please refer to ChartStripLine for more information.

Declaration
public ChartStripLineCollection StripLines { get; }
Property Value
Type
ChartStripLineCollection

TickColor

Gets or sets the color of ticks that are rendered on the axis.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public Color TickColor { get; set; }
Property Value
Type
System.Drawing.Color

TickDrawingOperationMode

Gets or sets the tick drawing operation mode.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public ChartAxisTickDrawingOperationMode TickDrawingOperationMode { get; set; }
Property Value
Type Description
ChartAxisTickDrawingOperationMode

The tick drawing operation mode.

TickLabelGridPadding

Gets or sets the tick label grid padding.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public float TickLabelGridPadding { get; set; }
Property Value
Type Description
System.Single

The tick label grid padding.

TickLabelsDrawingMode

Gets or sets the mode of drawing of tick labels.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public ChartAxisTickLabelDrawingMode TickLabelsDrawingMode { get; set; }
Property Value
Type
ChartAxisTickLabelDrawingMode

TickSize

Gets or sets the size of ticks that are rendered on the axis.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public Size TickSize { get; set; }
Property Value
Type
System.Drawing.Size

Title

Gets or sets the title of this axis.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public string Title { get; set; }
Property Value
Type
System.String

TitleAlignment

Gets or sets the alignment of the axis title.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public StringAlignment TitleAlignment { get; set; }
Property Value
Type
System.Drawing.StringAlignment

TitleColor

Gets or sets the title color that is to be used for text that is rendered in association with the axis (such as axis title).

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public Color TitleColor { get; set; }
Property Value
Type
System.Drawing.Color

TitleDrawMode

Gets or sets the title draw mode.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public ChartTitleDrawMode TitleDrawMode { get; set; }
Property Value
Type Description
ChartTitleDrawMode

The title draw mode.

TitleFont

Gets or sets the title font that is to be used for text that is rendered in association with the axis (such as axis title).

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public Font TitleFont { get; set; }
Property Value
Type
System.Drawing.Font

TitleRotationAngle

Gets or sets axis title rotation.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public AxisTitleRotationAngle TitleRotationAngle { get; set; }
Property Value
Type
AxisTitleRotationAngle

TitleSpacing

Gets or sets the spacing between title and labels.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public float TitleSpacing { get; set; }
Property Value
Type Description
System.Single

The spacing.

ToolTip

Gets or sets the ToolTip of the axis.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public string ToolTip { get; set; }
Property Value
Type
System.String

ValueType

Gets or sets the type of value that this axis is displaying. For the types supported, refer to ChartValueType.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public ChartValueType ValueType { get; set; }
Property Value
Type
ChartValueType
Remarks

If the ChartValueType.Custom type is set, labels gets from the LabelsImpl by index or position of label. Elsewhere labels is generated by value of label.

The ChartValueType.Custom can't guarantee correct position of labels. You can use the other ways to implements the custom labels, such as to use the FormatLabel event.

VisibleRange

Gets the visible range when zoomed.

Declaration
public virtual MinMaxInfo VisibleRange { get; }
Property Value
Type
MinMaxInfo
Remarks

Don't try to change this property manually. The value will be changed if any of related properties is changed.

ZoomActions

Gets or sets the zoom actions.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public ChartZoomingAction ZoomActions { get; set; }
Property Value
Type Description
ChartZoomingAction

The zoom actions.

ZoomedRange

Gets the range that is currently zoomed in.

Declaration
[ChartTemplate(ChartTemplateSet.ContentBehavior)]
public MinMaxInfo ZoomedRange { get; }
Property Value
Type
MinMaxInfo

ZoomFactor

Gets or sets the factor that is to be used to calculate Zoomed range.

Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public double ZoomFactor { get; set; }
Property Value
Type
System.Double

ZoomPosition

Gets or sets the minimum value(ZoomPosition) displayed on this axis when zoomed as a fraction of the total range. For example if the total range is 20 and the minimum value currently displayed is 10, the ZoomPosition will be 0.5 (10/20).

Declaration
[ChartTemplate(ChartTemplateSet.SimpleBehavior)]
public double ZoomPosition { get; set; }
Property Value
Type
System.Double

Methods

AddBreak(MinMaxInfo)

Add breaks at the specified range.

Declaration
[Obsolete("Use other AddBreak method or BreakInfo property.")]
public void AddBreak(MinMaxInfo mm)
Parameters
Type Name Description
MinMaxInfo mm

Break's >MinMaxInfo.

AddBreak(Double, Double)

Add breaks at the specified range.

Declaration
public void AddBreak(double from, double to)
Parameters
Type Name Description
System.Double from

Value from.
System.Double to

Value to.

CalculateAxis(RectangleF, SizeF, Single)

Calculates the axis layout.

Declaration
public RectangleF CalculateAxis(RectangleF rect, SizeF spacing, float dimension)
Parameters
Type Name Description
System.Drawing.RectangleF rect

The System.Drawing.RectangleF to place axis.
System.Drawing.SizeF spacing

The spacing.
System.Single dimension

The dimension.
Returns
Type Description
System.Drawing.RectangleF

System.Drawing.RectangleF where axis is placed.

CalculateAxisLocation(RectangleF)

Calculates the axis location.

Declaration
public void CalculateAxisLocation(RectangleF rect)
Parameters
Type Name Description
System.Drawing.RectangleF rect

The System.Drawing.RectangleF to place axis.

CenteredZoom(Double)

Changes the ZoomFactor and the ZoomPosition by center.

Declaration
public void CenteredZoom(double factor)
Parameters
Type Name Description
System.Double factor

The new zoom factor.

CheckFormatLabel()

Checks whether FormatLabel event of axis is used or not.

Declaration
public bool CheckFormatLabel()
Returns
Type
System.Boolean

ClearBreaks()

Clears all the breaks.

Declaration
public void ClearBreaks()

CoefficientToValue(Double)

Coeficients to value.

Declaration
public double CoefficientToValue(double value)
Parameters
Type Name Description
System.Double value

The value.
Returns
Type
System.Double

CoeficientToValue(Double)

Coefficients to value.

Declaration
[Obsolete("Use CoefficientToValue.")]
public double CoeficientToValue(double value)
Parameters
Type Name Description
System.Double value

The value.
Returns
Type
System.Double

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration
public void Dispose()

DisposeChartAxis()

Dispose ChartAxisObject for MVCChartModel

Declaration
public void DisposeChartAxis()

DrawAxis(Graphics3D, ChartArea, Single)

Draws the axis.

Declaration
public void DrawAxis(Graphics3D g, ChartArea chartarea, float z)
Parameters
Type Name Description
Graphics3D g

The g.
ChartArea chartarea

The chartarea.
System.Single z

The z.

DrawAxis(Graphics, ChartArea)

Draws the axis.

Declaration
public void DrawAxis(Graphics g, ChartArea chartarea)
Parameters
Type Name Description
System.Drawing.Graphics g

The g.
ChartArea chartarea

The chartarea.

DrawAxis(Graphics, ChartArea, RectangleF)

Draws the axis.

Declaration
public void DrawAxis(Graphics g, ChartArea chartarea, RectangleF labelBounds)
Parameters
Type Name Description
System.Drawing.Graphics g

The g.
ChartArea chartarea

The chartarea.
System.Drawing.RectangleF labelBounds

Bounds for axis labels

Freeze()

Disables events raising (AppearanceChanged, DimensionsChanged, IntervalsChanged, VisibleRangeChanged).

Declaration
public void Freeze()
See Also

GetCategoryAtIndex(Int32)

Used to get the specific index of category value.

Declaration
public string GetCategoryAtIndex(int index)
Parameters
Type Name Description
System.Int32 index
Returns
Type
System.String

GetCoordinateFromValue(Double)

Gets the coordinate from value.

Declaration
public float GetCoordinateFromValue(double value)
Parameters
Type Name Description
System.Double value

The value to get coordinate.
Returns
Type Description
System.Single

Coordinate that represent value.

GetDimension(Graphics, ChartArea)

Gets the dimension.

Declaration
public float GetDimension(Graphics g, ChartArea chartarea)
Parameters
Type Name Description
System.Drawing.Graphics g

The graphics content.
ChartArea chartarea

The chart area.
Returns
Type Description
System.Single

Dimension.

GetDimension(Graphics, ChartArea, RectangleF)

Gets the dimension.

Declaration
public float GetDimension(Graphics g, ChartArea chartarea, RectangleF renderBounds)
Parameters
Type Name Description
System.Drawing.Graphics g

The g.
ChartArea chartarea

The chartarea.
System.Drawing.RectangleF renderBounds

The render bounds.
Returns
Type
System.Single

GetRealValue(PointF)

Calculates real value for given point.

Declaration
public double GetRealValue(PointF p)
Parameters
Type Name Description
System.Drawing.PointF p

The point to calculate real value.
Returns
Type Description
System.Double

Real value.

GetRealValue(Single)

Gets the real value in pixels.

Declaration
public double GetRealValue(float value)
Parameters
Type Name Description
System.Single value

The value.
Returns
Type Description
System.Double

Calculated value.

GetScrollBarValueFromZoomPosition()

Calculates scroll bar position from zoom position.

Declaration
public double GetScrollBarValueFromZoomPosition()
Returns
Type Description
System.Double

Calculated scroll bar position.

GetVisibleValue(Double)

Gets the visible value on the chart by specified value.

Declaration
public float GetVisibleValue(double value)
Parameters
Type Name Description
System.Double value

The value.
Returns
Type
System.Single

Melt()

Enables events raising (AppearanceChanged, DimensionsChanged, IntervalsChanged, VisibleRangeChanged).

Declaration
public void Melt()
See Also

MulZoomCenter(Double)

Multiplies the zoom factor by center.

Declaration
public void MulZoomCenter(double mulFactor)
Parameters
Type Name Description
System.Double mulFactor

The mul factor.

OnAppearanceChanged(EventArgs)

Raises the appearance changed event.

Declaration
protected virtual void OnAppearanceChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

The System.EventArgs instance containing the event data.

OnDimensionsChanged(EventArgs)

Raises the dimensions changed event.

Declaration
protected virtual void OnDimensionsChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

The System.EventArgs instance containing the event data.

OnIntervalsChanged(EventArgs)

Raises the intervals changed event.

Declaration
protected virtual void OnIntervalsChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

The System.EventArgs instance containing the event data.

OnVisibleRangeChanged(EventArgs)

Raises the visible range changed event.

Declaration
protected virtual void OnVisibleRangeChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

The System.EventArgs instance containing the event data.

PointToVisibleValue(PointF)

Subtructs location of axis and returns necessary value by orientation.

Declaration
[Obsolete]
public float PointToVisibleValue(PointF pt)
Parameters
Type Name Description
System.Drawing.PointF pt

System.Drawing.PointF to convert.
Returns
Type Description
System.Single

Calculated value by orientation.

RaiseFormatLabel(Object, ChartFormatAxisLabelEventArgs)

Raises FormatLabel event.

Declaration
protected void RaiseFormatLabel(object sender, ChartFormatAxisLabelEventArgs args)
Parameters
Type Name Description
System.Object sender

The sender.
ChartFormatAxisLabelEventArgs args

The ChartFormatAxisLabelEventArgs instance containing the event data.

RecalculateVisibleRange(Double, Double)

This method is for internal purpose do not use in your code. It will trigger VisibleRangeChanged event handlers for the provided zoomfactor and zoomposition values.

Declaration
public double RecalculateVisibleRange(double zoomFactor, double zoomPosition)
Parameters
Type Name Description
System.Double zoomFactor

The zoom factor.
System.Double zoomPosition

The zoom position.
Returns
Type
System.Double

ResetForeColor()

Resets the fore color to default value.

Declaration
protected void ResetForeColor()

ResetInterlacedGridInterior()

Resets the orientation.

Declaration
protected void ResetInterlacedGridInterior()

ResetOrientation()

Resets the orientation.

Declaration
protected void ResetOrientation()

ResetTickColor()

Resets the color of the tick.

Declaration
protected void ResetTickColor()

ResetTitleColor()

Resets the color of the title to default value.

Declaration
protected void ResetTitleColor()

ResetZoom()

Resets the zoom.

Declaration
public void ResetZoom()

SetNiceRange(DoubleRange, ChartAxisRangePaddingType)

Sets the nice range.

Declaration
public void SetNiceRange(DoubleRange baseRange, ChartAxisRangePaddingType pattingType)
Parameters
Type Name Description
DoubleRange baseRange

The base range.
ChartAxisRangePaddingType pattingType

Type of the patting.

SetRange(MinMaxInfo)

The ChartAxis by default creates a display range based on data. If you do not wish to use this range you can set this range yourself using this method. When you set a custom range you have to set RangeType to Set.

Declaration
public void SetRange(MinMaxInfo value)
Parameters
Type Name Description
MinMaxInfo value

Range information with minimum and maximum values to be used.

SetZoomPositionFromScrollBarValue(Double, Boolean)

Sets the zoom position from scroll bar value.

Declaration
public void SetZoomPositionFromScrollBarValue(double scrollValue, bool updateVisibleRange)
Parameters
Type Name Description
System.Double scrollValue

The scroll value.
System.Boolean updateVisibleRange

Indicates that visible range need to be recalculated.

ShouldSerializeDateTimeOffset()

Determines if the DateTimeOffset property was modified.

Declaration
protected bool ShouldSerializeDateTimeOffset()
Returns
Type Description
System.Boolean

True if property was modified, otherwise false.

ShouldSerializeForeColor()

Determines if the ForeColor property was changed.

Declaration
protected bool ShouldSerializeForeColor()
Returns
Type Description
System.Boolean

True if property was changed, otherwise false.

ShouldSerializeInterlacedGridInterior()

Calculates value indicates that orientation property will be serialized by designer.

Declaration
protected bool ShouldSerializeInterlacedGridInterior()
Returns
Type Description
System.Boolean

True if value will be serialized, otherwise false.

ShouldSerializeOrientation()

Calculates value indicates that orientation property will be serialized by designer.

Declaration
protected bool ShouldSerializeOrientation()
Returns
Type Description
System.Boolean

True if value will be serialized, otherwise false.

ShouldSerializeOriginDate()

Determines if OriginDate property was changed.

Declaration
protected bool ShouldSerializeOriginDate()
Returns
Type Description
System.Boolean

True if property was changed, otherwise false.

ShouldSerializeRange()

Determine if the RangeType property was modified.

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

True if Range property was modified, otherwise false.

ShouldSerializeSize()

Determines if the size property was modified.

Declaration
protected bool ShouldSerializeSize()
Returns
Type Description
System.Boolean

True if size property was modified, otherwise false.

ShouldSerializeSmallTickSize()

Determines if SmallTickSize property was changed.

Declaration
protected bool ShouldSerializeSmallTickSize()
Returns
Type Description
System.Boolean

True if property was changed, otherwise false.

ShouldSerializeTickColor()

Determines if the TickColor property was changed.

Declaration
protected bool ShouldSerializeTickColor()
Returns
Type Description
System.Boolean

True if property was changed, otherwise false.

ShouldSerializeTickSize()

Determines if TickSize property was changed.

Declaration
protected bool ShouldSerializeTickSize()
Returns
Type Description
System.Boolean

True if property was changed, otherwise false.

ShouldSerializeTitleColor()

Determines if the ForeColor property was changed.

Declaration
protected bool ShouldSerializeTitleColor()
Returns
Type Description
System.Boolean

True if property was changed, otherwise false.

Update()

Marks the axis and related rendering information as out of date.

Declaration
public void Update()

ValueToCoefficient(Double)

Values to coefficient.

Declaration
public double ValueToCoefficient(double value)
Parameters
Type Name Description
System.Double value

The value.
Returns
Type
System.Double

ValueToCoeficient(Double)

Values to coefficient.

Declaration
[Obsolete("Use ValueToCoefficient.")]
public double ValueToCoeficient(double value)
Parameters
Type Name Description
System.Double value

The value.
Returns
Type
System.Double

Zoom(Double, Double)

Applies zooming to the chart using the specified zoom factor and position.

Declaration
public void Zoom(double Zoomfactor, double ZoomPosition)
Parameters
Type Name Description
System.Double Zoomfactor
System.Double ZoomPosition

Zoom(PointF, PointF, Double)

Zoom axis and updates zoom factor and zoom position.

Declaration
public bool Zoom(PointF upPoint, PointF downPoint, double minZoomFactor)
Parameters
Type Name Description
System.Drawing.PointF upPoint

The start point of zoomed rectangle.
System.Drawing.PointF downPoint

The end point of zoomed rectangle.
System.Double minZoomFactor

The min zoom factor.
Returns
Type Description
System.Boolean

True if axis was updated, otherwise false.

ZoomRange(DoubleRange)

Zooms by range.

Declaration
public void ZoomRange(DoubleRange zoomRange)
Parameters
Type Name Description
DoubleRange zoomRange

Events

AppearanceChanged

Occurs when appearance was changed.

Declaration
public event EventHandler AppearanceChanged
Event Type
Type
System.EventHandler

DimensionsChanged

Occurs then dimensions was changed.

Declaration
public event EventHandler DimensionsChanged
Event Type
Type
System.EventHandler

FormatLabel

Event for dynamic formatting of axis labels.

Declaration
public event ChartFormatAxisLabelEventHandler FormatLabel
Event Type
Type
ChartFormatAxisLabelEventHandler
Examples

xAxis.FormatLabel += new ChartFormatAxisLabelEventHandler(XAxis_FormatLabel);

...

void XAxis_FormatLabel(object sender, ChartFormatAxisLabelEventArgs args)

{

args.Label = "Category" + args.Value;

args.Handled = true;

}

See Also

IntervalsChanged

Occurs then intervals was changed.

Declaration
public event EventHandler IntervalsChanged
Event Type
Type
System.EventHandler

VisibleRangeChanged

Occurs when visible range was changed.

Declaration
public event EventHandler VisibleRangeChanged
Event Type
Type
System.EventHandler

Zoomed

Occurs when ZoomFactor or ZoomPosition properties are changed.

Declaration
public event EventHandler Zoomed
Event Type
Type
System.EventHandler

Zooming

Occurs when ZoomFactor or ZoomPosition properties are changing.

Declaration
public event ChartAxisZoomingEventHandler Zooming
Event Type
Type
ChartAxisZoomingEventHandler

Implements

System.IDisposable