Class ChartValueAxisImpl

Class used for Chart Value Axis implementation.

Inheritance
System.Object
CommonObject
ChartAxisImpl
ChartValueAxisImpl
ChartCategoryAxisImpl
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 class ChartValueAxisImpl : ChartAxisImpl, IParentApplication, IDisposable, IChartValueAxis, IChartAxis, IScalable

Constructors

ChartValueAxisImpl(IApplication, Object)

Creates axis object.

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

Application object for the axis.
System.Object parent

Parent object for the axis.

ChartValueAxisImpl(IApplication, Object, ExcelAxisType)

Creates primary axis of specified type.

Declaration
public ChartValueAxisImpl(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.

ChartValueAxisImpl(IApplication, Object, ExcelAxisType, Boolean)

Creates axis of specified type and specified IsPrimary value.

Declaration
public ChartValueAxisImpl(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; otherwise False.

ChartValueAxisImpl(IApplication, Object, IList<BiffRecordRaw>, ref Int32)

Extracts primary axis from the array of BiffRecords.

Declaration
[CLSCompliant(false)]
public ChartValueAxisImpl(IApplication application, object parent, IList<BiffRecordRaw> data, ref int iPos)
Parameters
Type Name Description
IApplication application

Application object for the axis.
System.Object parent

Parent object for the axis.
System.Collections.Generic.IList<Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw> data

Array of BiffRecords with axis data.
System.Int32 iPos

Position of the first axis record in the data array.

ChartValueAxisImpl(IApplication, Object, IList<BiffRecordRaw>, ref Int32, Boolean)

Extracts axis from the array of BiffRecords.

Declaration
[CLSCompliant(false)]
public ChartValueAxisImpl(IApplication application, object parent, IList<BiffRecordRaw> data, ref int iPos, bool isPrimary)
Parameters
Type Name Description
IApplication application

Application object for the axis.
System.Object parent

Parent object for the axis.
System.Collections.Generic.IList<Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw> data

Array of BiffRecords with axis data.
System.Int32 iPos

Position of the first axis record in the data array.
System.Boolean isPrimary

True if it is primary axis; otherwise False.

Fields

DEF_DISPLAY_UNIT_VALUES

Represents array of display units values. Index - display units index, value - double value.

Declaration
public static double[] DEF_DISPLAY_UNIT_VALUES
Field Value
Type
System.Double[]

Properties

AutoTickLabelSpacing

Represents whether the label spacing is automatic or not

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

ChartValueRange

Gets or sets the ChartValueRangeRecord.

Declaration
[CLSCompliant(false)]
protected ChartValueRangeRecord ChartValueRange { get; set; }
Property Value
Type
ChartValueRangeRecord

CrossesAt

Represents the point on the axis another axis crosses it.

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

CrossValue

Represents the point on the axis another axis crosses it.

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

DisplayUnit

Returns or sets the unit label for the specified axis.

Declaration
public ExcelChartDisplayUnit DisplayUnit { get; set; }
Property Value
Type
ExcelChartDisplayUnit

DisplayUnitCustom

Represents custom unit to display.

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

DisplayUnitLabel

Returns the DisplayUnitLabel object for the specified axis. Returns Null if the HasDisplayUnitLabel property is set to False. Read-only.

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

HasDisplayUnitLabel

True if the label is displayed on the specified axis.

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

IsAutoCross

Automatic category crossing point selected.

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

IsAutoMajor

Automatic major selected.

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

IsAutoMax

Automatic maximum selected.

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

IsAutoMin

Automatic minimum selected.

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

IsAutoMinor

Automatic minor selected.

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

IsLogScale

Logarithmic scale.

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

IsMaxCross

Category axis to cross at maximum value.

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

LogBase

Returns or sets the base of the logarithm when you are using log scales. The default value is 10.

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

MajorUnit

Value of major increment.

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

MaximumValue

Maximum value on axis.

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

MinimumValue

Maximum value on axis.

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

MinorUnit

Value of minor increment.

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

ReversePlotOrder

True if plots data points from last to first.

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

TextLinkType

Gets text link for this axis.

Declaration
[CLSCompliant(false)]
protected override ExcelObjectTextLink TextLinkType { get; }
Property Value
Type
ExcelObjectTextLink
Overrides

Methods

CheckValueRangeRecord()

Checks if everything is ok with ChartValueRangeRecord.

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

True if check succeeded.

CheckValueRangeRecord(Boolean)

Checks if everything is ok with ChartValueRangeRecord.

Declaration
protected virtual bool CheckValueRangeRecord(bool throwException)
Parameters
Type Name Description
System.Boolean throwException

Indicates whether we should throw an exception in the case of check failed.
Returns
Type Description
System.Boolean

True if check succeeded.

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

Clone current object.

Declaration
public override 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

Returns cloned object.
Overrides

InitializeVariables()

Initializes internal variables.

Declaration
protected override void InitializeVariables()
Overrides

ParseData(BiffRecordRaw, IList<BiffRecordRaw>, ref Int32)

Parses data.

Declaration
[CLSCompliant(false)]
protected override void ParseData(BiffRecordRaw record, IList<BiffRecordRaw> data, ref int iPos)
Parameters
Type Name Description
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw record

Represents current record to parse.
System.Collections.Generic.IList<Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw> data

Represents records storage.
System.Int32 iPos

Represents position in storage.
Overrides

ParseMaxCross(BiffRecordRaw)

Parses max cross.

Declaration
[CLSCompliant(false)]
protected virtual void ParseMaxCross(BiffRecordRaw record)
Parameters
Type Name Description
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw record

Represents max cross data to parse.

ParseWallsOrFloor(IList<BiffRecordRaw>, ref Int32)

Parses walls or floor.

Declaration
protected override void ParseWallsOrFloor(IList<BiffRecordRaw> data, ref int iPos)
Parameters
Type Name Description
System.Collections.Generic.IList<Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw> data

Record storage.
System.Int32 iPos

Position in storage.
Overrides

Serialize(OffsetArrayList)

Serializes axis.

Declaration
[CLSCompliant(false)]
public override void Serialize(OffsetArrayList records)
Parameters
Type Name Description
OffsetArrayList records

OffsetArrayList that will receive all records.
Overrides

Serialize(OffsetArrayList, ChartAxisRecord.ChartAxisType)

Serializes axis.

Declaration
[CLSCompliant(false)]
protected void Serialize(OffsetArrayList records, ChartAxisRecord.ChartAxisType axisType)
Parameters
Type Name Description
OffsetArrayList records

OffsetArrayList that will receive all records.
ChartAxisRecord.ChartAxisType axisType

Represents axis type.

SerializeWallsOrFloor(OffsetArrayList)

Serializes walls or floor.

Declaration
[CLSCompliant(false)]
protected virtual void SerializeWallsOrFloor(OffsetArrayList records)
Parameters
Type Name Description
OffsetArrayList records

Record storage.

SetAutoMax(Boolean, Boolean)

Automatic Maximum

Declaration
protected void SetAutoMax(bool check, bool value)
Parameters
Type Name Description
System.Boolean check
System.Boolean value

SetAutoMin(Boolean, Boolean)

Automatic Minimum

Declaration
protected void SetAutoMin(bool check, bool value)
Parameters
Type Name Description
System.Boolean check
System.Boolean value

SetMajorUnit(Double)

Sets major unit.

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

SetMinorUnit(Double)

Sets minor unit.

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

Implements

System.IDisposable