Axis Class

In This Topic

The Axis class is the base class of all axes displayed by the Xceed Chart for WinForms component.

Object Model

Syntax

Visual Basic
C#

'Declaration
 
<ClassInterfaceAttribute(ClassInterfaceType.AutoDual)>
<TypeConverterAttribute(Xceed.Chart.Core.AxisConverter)>
<SerializableAttribute()>
Public MustInherit Class Axis

'Usage
 
Dim instance As Axis

[ClassInterface(ClassInterfaceType.AutoDual)]
[TypeConverter(Xceed.Chart.Core.AxisConverter)]
[Serializable()]
public abstract class Axis

Remarks

Each axis displayed by the Xceed Chart for WinForms component is represented by a class derived from this class. The user can obtain a reference to the five standard axes with the help of the Axis method of the Chart class. The following code obtains a reference to the PrimaryY axis.


Dim axis As Axis = Chart.Axis(StandardAxis.PrimaryY);


Axis axis = Chart.Axis(StandardAxis.PrimaryY);

A reference to a custom axis can be obtained with the help of the second override of the Axis mehtod which receives a Int32 parameter which is the axis id. The following code demonstrates this.


' create a custom vertical axis
Dim axis As Axis =  Chart.Axes.AddCustomAxis(AxisOrientation.Vertical,AxisPredefinedPosition.FrontRight) 
' save the axis id 
Dim nAxisId As Integer =  axis.AxisId 
...
' obtain a reference to the axis with the saved id
Dim customAxis As Axis =  Chart.Axis(nAxisId)


// create a custom vertical axis
Axis axis = Chart.Axes.AddCustomAxis(AxisOrientation.Vertical, AxisPredefinedPosition.FrontRight);
// save the axis id 
int nAxisId = axis.AxisId;
...
// obtain a reference to the axis with the saved id
Axis customAxis = Chart.Axis(nAxisId);

The Axis class implements support for the following axis features:

axis identification
appearance control
scale control
major and minor tick control
major and minor gridline control
position control
text format control
title
stagger control
access to the associated constant lines
access to the associated strip lines

Inheritance Hierarchy

System.Object
Xceed.Chart.Core.Axis
Xceed.Chart.Core.VerticalAxis

Protected Fields

	Name	Description
	m_AxisScaleDateTime	This member is reserved for internal use and is not intended to be used directly from your code.
	m_AxisScaleDimension	This member is reserved for internal use and is not intended to be used directly from your code.
	m_AxisScaleLogarithmic	This member is reserved for internal use and is not intended to be used directly from your code.
	m_AxisScaleMode	This member is reserved for internal use and is not intended to be used directly from your code.
	m_AxisScaleNumeric	This member is reserved for internal use and is not intended to be used directly from your code.

Top

Public Properties

	Name	Description
	AxisId	Retrieves the axis identificator - an unique number associated with each axis.
	AxisStyle	Controls the shape of the axis.
	Border	Specifies the border of the axis.
	ConstLines	Gives you access to the collection of AxisConstLine objects.
	CustomLabels	Gives you access to the collection of AxisLabel objects.
	DateTimeScale	Gives you access to the Date Time Scale of the axis.
	DimensionScale	Gives you access to the Dimension Scale of the axis.
	FillEffect	Specifies the fill effect of the axis.
	InnerTickLength	Controls the length of the major inner ticks.
	InnerTickLine	Specifies the line properties of the inner tick lines.
	Interactivity	Gives you access to the Interactivity object of the axis.
	Labels	Gives you access to the collection of strings used for axis labels.
	LogarithmicScale	Gives you access to the Logarithmic Scale of the axis.
	MajorGridLine	Specifies the line properties of the major grid lines.
	MajorTicks	Gives you access to the array of major ticks.
	MinorGridLine	Specifies the line properties of the minor grid lines.
	MinorTickLength	Controls the length of the minor ticks.
	MinorTickLine	Gives you access to the line properties applied on the minor ticks.
	MinorTicks	Gives you access to the array of minor ticks.
	NumericScale	Gives you access to the Numeric Scale of the axis.
	OuterTickLength	Controls the length of the major outer ticks.
	OuterTickLine	Specifies the line properties of the outer tick lines.
	PositionOffset	Specifies the offset of the axis from the original position determined by the component.
	PredefinedPosition	Controls the predefined position of the axis.
	Ruler	Gives you access to the axis ruler.
	ScaleMode	Controls the scale mode of the axis.
	StaggerLevels	Controls the number of the stagger levels.
	StaggerOffset	Controls the offset of the staggered texts.
	StaggerTexts	When set to true the axis texts are displayed in a stagger manner.
	Stripes	Gives you access to the collection of AxisStripe objects.
	Text	Gives you access to the text properties applied on the axis texts.
	Title	Controls the displayed axis title.
	TitleText	Gives you access to the text properties applied on the axis title.
	ValueFormatting	Gives you access to the ValueFormat object specifying the formatting of the values displayed at the axis major ticks.
	Visible	Controls the visibility of the axis.
	Width	Controls the width of the axis when it is displayed with Tube or Bar style.

Top

Public Methods

	Name	Description
	Clone	Creates an identical copy of this axis object
	ConvertModelToScaleCoordinate	Converts a model coordinate to scale value
	ConvertScaleToModelCoordinate	Converts a scale value to model coordninate
	GetMajorShowAtWall	Determines whether the major gridlines are displayed at the specified chart wall.
	GetMinorShowAtWall	Determines whether the minor gridlines are displayed at the specified chart wall.
	GetUserControl	Creates a user control which can be used for this object visual editing
	PositionAxis	Overloaded. Dynamically positions an axis relative to a value of another axis.
	SetMajorShowAtWall	Shows the major lines at the specified wall.
	SetMinorShowAtWall	Shows the minor lines at the specified wall.
	SetPredefinedTextLayout	Sets a predefined layout for the axis texts. A predefined text layout is a specific combination of text offset, alignment, orientation and stagger.
	ShowAxisConstLinesEditor	Shows the axis const line collection editor
	ShowAxisLabelsEditor	Shows the axis label collection editor
	ShowAxisStripesEditor	Shows the axis stripe collection editor

Top

Protected Methods

	Name	Description
	CanRenderMinorTicks	This member is reserved for internal use and is not intended to be used directly from your code.
	GetScaleFromMode	This member is reserved for internal use and is not intended to be used directly from your code.
	RenderConstLinesBorders	This member is reserved for internal use and is not intended to be used directly from your code.
	RenderConstLinesPolygons	This member is reserved for internal use and is not intended to be used directly from your code.
	RenderCustomLabels	This member is reserved for internal use and is not intended to be used directly from your code.
	RenderCustomLabelsLines	This member is reserved for internal use and is not intended to be used directly from your code.
	RenderMajorTicks	This member is reserved for internal use and is not intended to be used directly from your code.
	RenderMinorTicks	This member is reserved for internal use and is not intended to be used directly from your code.
	RenderVolumetricAxis	This member is reserved for internal use and is not intended to be used directly from your code.

Top

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

Axis Members
Xceed.Chart.Core Namespace
Chart Class
StandardAxis Enumeration
AxisPredefinedPosition Enumeration
AxisOrientation Enumeration

Send Feedback

Business Suite

Ultimate Suite

Reference