ChartAxisImpl Class

Represents an axis on the chart.

Inheritance
System.Object
CommonObject
ChartAxisImpl
ChartSeriesAxisImpl
ChartValueAxisImpl
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.XlsIO.Implementation.Charts
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
public abstract class ChartAxisImpl : CommonObject, IParentApplication, IDisposable, IChartAxis

Constructors

ChartAxisImpl(IApplication, Object)

Initializes a new instance of ChartAxisImpl class.

Declaration
public ChartAxisImpl(IApplication application, object parent)
Parameters
Type Name Description
IApplication application

Application object for the axis.
System.Object parent

Parent object for the axis.

ChartAxisImpl(IApplication, Object, ExcelAxisType)

Initializes a new instance of ChartAxisImpl class with the specified primary axis type.

Declaration
public ChartAxisImpl(IApplication application, object parent, ExcelAxisType axisType)
Parameters
Type Name Description
IApplication application

Application object for the axis.
System.Object parent

Parent object for the axis.
ExcelAxisType axisType

Type of the new axis.

ChartAxisImpl(IApplication, Object, ExcelAxisType, Boolean)

Initializes a new instance of ChartAxisImpl class with specified axis type and specified IsPrimary value.

Declaration
public ChartAxisImpl(IApplication application, object parent, ExcelAxisType axisType, bool bIsPrimary)
Parameters
Type Name Description
IApplication application

Application object for the axis.
System.Object parent

Parent object for the axis.
ExcelAxisType axisType

Type of the new axis.
System.Boolean bIsPrimary

True if primary axis should be created; False otherwise.

Fields

DEF_NUMBER_FORMAT_INDEX

Represents the default number format index.

Declaration
protected const int DEF_NUMBER_FORMAT_INDEX = -1
Field Value
Type
System.Int32

Properties

Alignment

Gets or sets the alignment for the tick label.

Declaration
public ExcelAxisTextDirection Alignment { get; set; }
Property Value
Type
ExcelAxisTextDirection

AutoTickLabelSpacing

Gets or sets a boolean value indicating whether or not the tick label spacing is automatic.

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

AutoTickMarkSpacing

Gets or sets a Boolean value indicating whether or not the tick label spacing is automatic. Read/write Boolean.

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

AxisId

Gets the axis identifier.

Declaration
public int AxisId { get; }
Property Value
Type
System.Int32

AxisType

Gets the type of the axis. Read-only.

Declaration
public ExcelAxisType AxisType { get; set; }
Property Value
Type
ExcelAxisType

Border

Gets the chart border. Read-only.

Declaration
public IChartBorder Border { get; }
Property Value
Type
IChartBorder

Chart3DOptions

Gets the 3D options for the chart. Read-only.

Declaration
public IThreeDFormat Chart3DOptions { get; }
Property Value
Type
IThreeDFormat

Chart3DProperties

Gets the 3D properties for the chart.

Declaration
public IThreeDFormat Chart3DProperties { get; }
Property Value
Type
IThreeDFormat

Deleted

Gets or sets a Boolean value indicating whether axis is deleted.

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

Font

Gets the font used for axis text display. Read-only.

Declaration
public IFont Font { get; set; }
Property Value
Type
IFont

FrameFormat

Gets the frame format of the axis. Read-only.

Declaration
public IChartFrameFormat FrameFormat { get; }
Property Value
Type
IChartFrameFormat

Has3dProperties

True if a shadow object (which includes the 3D properties) is created.

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

HasAxisTitle

True if the axis has a title. False otherwise.

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

HasMajorGridLines

Gets or sets a boolean value indicating if the axis has major grid lines.

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

HasMinorGridLines

Gets or sets a boolean value indicating if the axis has minor grid lines.

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

HasShadowProperties

True if a shadow object is created. False otherwise.

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

IsAutoTextRotation

True if the axis text rotation angle is autoselected. False otherwise.

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

isNumber

True if the axis has numerical values. False otherwise.

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

IsPrimary

True if this is primary axis. False if secondary.

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

IsReversed

True if data points are plotted from last to first. otherwise False.

Declaration
[Obsolete("Please use ReversePlotOrder property instead of this one.")]
public bool IsReversed { get; set; }
Property Value
Type
System.Boolean

MajorGridLines

Gets the major grid lines for the axis. Read-only.

Declaration
public IChartGridLine MajorGridLines { get; }
Property Value
Type
IChartGridLine

MajorTickMark

Gets or sets the type of major tick mark for the axis.

Declaration
public ExcelTickMark MajorTickMark { get; set; }
Property Value
Type
ExcelTickMark

MinorGridLines

Gets the minor grid lines for the axis. Read-only.

Declaration
public IChartGridLine MinorGridLines { get; }
Property Value
Type
IChartGridLine

MinorTickMark

Gets or sets the type of minor tick mark for the axis.

Declaration
public ExcelTickMark MinorTickMark { get; set; }
Property Value
Type
ExcelTickMark

NumberFormat

Gets or sets number format for the axis values.

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

NumberFormatIndex

Gets or sets the number format index for the axis values.

Declaration
public int NumberFormatIndex { get; set; }
Property Value
Type
System.Int32

ParagraphType

Gets or sets the paragraph type for the text area paragraph.

Declaration
public ChartParagraphType ParagraphType { get; set; }
Property Value
Type
ChartParagraphType

ParentAxis

Gets the chart parent axis. Read-only.

Declaration
protected ChartParentAxisImpl ParentAxis { get; }
Property Value
Type
ChartParentAxisImpl

ParentChart

Gets the parent chart. Read-only.

Declaration
public ChartImpl ParentChart { get; }
Property Value
Type
ChartImpl

ParentWorkbook

Gets the parent workbook. Read-only.

Declaration
protected WorkbookImpl ParentWorkbook { get; }
Property Value
Type
WorkbookImpl

ReversePlotOrder

Gets or sets a boolean value indicating whether to plot data points from last to first.

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

Shadow

Gets the shadow properties for the axis. Read-only.

Declaration
public IShadow Shadow { get; }
Property Value
Type
IShadow

ShadowProperties

Gets the shadow Properties. Read-only.

Declaration
public IShadow ShadowProperties { get; }
Property Value
Type
IShadow

TextLinkType

Gets the text link type for the title area. Read-only.

Declaration
protected abstract ExcelObjectTextLink TextLinkType { get; }
Property Value
Type
ExcelObjectTextLink

TextRotationAngle

Gets or sets the axis text rotation angle. Should be an integer value between -90 and 90.

Declaration
public int TextRotationAngle { get; set; }
Property Value
Type
System.Int32

TickLabelPosition

Gets or sets the position of tick-mark labels on the axis.

Declaration
public ExcelTickLabelPosition TickLabelPosition { get; set; }
Property Value
Type
ExcelTickLabelPosition

Title

Gets or sets the axis title.

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

TitleArea

Gets the area for the axis title. Read-only.

Declaration
public IChartTextArea TitleArea { get; }
Property Value
Type
IChartTextArea

Visible

True if the axis is visible. otherwise False.

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

Methods

Clone(FontWrapper)

Creates a copy of current instance with the specified font wrapper object.

Declaration
public ChartAxisImpl Clone(FontWrapper font)
Parameters
Type Name Description
FontWrapper font

Font object for the chart axis.
Returns
Type Description
ChartAxisImpl

Cloned chart axis which is a copy of the current object.

Clone(Object, Dictionary<Int32, Int32>, Dictionary<String, String>)

Creates a copy of current instance with the specified dictionaries of font indexes and worksheet names.

Declaration
public virtual ChartAxisImpl Clone(object parent, Dictionary<int, int> dicFontIndexes, Dictionary<string, string> dicNewSheetNames)
Parameters
Type Name Description
System.Object parent

Parent object.
System.Collections.Generic.Dictionary<System.Int32, System.Int32> dicFontIndexes

Dictionary with new indexes.
System.Collections.Generic.Dictionary<System.String, System.String> dicNewSheetNames

Dictionary with new worksheet names.
Returns
Type Description
ChartAxisImpl

Cloned object which is a copy of the current object.

CreateFrameFormat()

Creates frame format for the axis.

Declaration
protected virtual ChartFrameFormatImpl CreateFrameFormat()
Returns
Type Description
ChartFrameFormatImpl

Newly created frame format.

InitFrameFormat()

Initializes frame format for the axis.

Declaration
protected void InitFrameFormat()

InitializeVariables()

Sets some important variables to the initial state.

Declaration
protected virtual void InitializeVariables()

MarkUsedReferences(Boolean[])

Sets items with used reference indexes to true.

Declaration
public void MarkUsedReferences(bool[] usedItems)
Parameters
Type Name Description
System.Boolean[] usedItems

Array to mark used references in.

SetTitle(ChartTextAreaImpl)

Sets the axis title.

Declaration
public void SetTitle(ChartTextAreaImpl text)
Parameters
Type Name Description
ChartTextAreaImpl text

Title to set.

SetTitleArea(ChartTextAreaImpl)

Sets the specified title area.

Declaration
protected void SetTitleArea(ChartTextAreaImpl titleArea)
Parameters
Type Name Description
ChartTextAreaImpl titleArea

Title area to set.

UpdateReferenceIndexes(Int32[])

Updates reference indexes.

Declaration
public void UpdateReferenceIndexes(int[] arrUpdatedIndexes)
Parameters
Type Name Description
System.Int32[] arrUpdatedIndexes

Array with updated indexes.

UpdateTickRecord(ExcelTickLabelPosition)

Updates surface tick record.

Declaration
public void UpdateTickRecord(ExcelTickLabelPosition value)
Parameters
Type Name Description
ExcelTickLabelPosition value

Represents tick label position value.

Implements

System.IDisposable