Class ChartCategoryAxisImpl
Represents category axis of the chart.
Inherited Members
Namespace: Syncfusion.XlsIO.Implementation.Charts
Assembly: Syncfusion.XlsIO.UWP.dll
Syntax
public class ChartCategoryAxisImpl : ChartValueAxisImpl, IParentApplication, IDisposable, IScalable, IChartCategoryAxis, IChartValueAxis, IChartAxis
Constructors
ChartCategoryAxisImpl(IApplication, Object)
Initializes a new instance of ChartCategoryAxisImpl class with the specified application and parent objects.
Declaration
public ChartCategoryAxisImpl(IApplication application, object parent)
Parameters
Type | Name | Description |
---|---|---|
IApplication | application | Application object for the axis. |
System.Object | parent | Parent object for the axis. |
ChartCategoryAxisImpl(IApplication, Object, ExcelAxisType)
Initializes a new instance of ChartCategoryAxisImpl class of specified primary axis type.
Declaration
public ChartCategoryAxisImpl(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. |
ChartCategoryAxisImpl(IApplication, Object, ExcelAxisType, Boolean)
Initializes a new instance of ChartCategoryAxisImpl class of specified type and specified IsPrimary value.
Declaration
public ChartCategoryAxisImpl(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. |
ChartCategoryAxisImpl(IApplication, Object, IList<BiffRecordRaw>, ref Int32)
Initializes a new instance of ChartCategoryAxisImpl class with primary axis extracted from array of BiffRecords.
Declaration
public ChartCategoryAxisImpl(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. |
ChartCategoryAxisImpl(IApplication, Object, IList<BiffRecordRaw>, ref Int32, Boolean)
Initializes a new instance of ChartCategoryAxisImpl class with the axis extracted from array of BiffRecords.
Declaration
public ChartCategoryAxisImpl(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; False otherwise. |
Properties
AutoTickLabelSpacing
Gets or sets whether or not the tick label spacing is automatic.
Declaration
public bool AutoTickLabelSpacing { get; set; }
Property Value
Type |
---|
System.Boolean |
BaseUnit
Gets or sets the base unit for the category axis.
Declaration
public ExcelChartBaseUnit BaseUnit { get; set; }
Property Value
Type |
---|
ExcelChartBaseUnit |
BaseUnitIsAuto
True to use automatic base units for the specified category axis. otherwise False.
Declaration
public bool BaseUnitIsAuto { get; set; }
Property Value
Type |
---|
System.Boolean |
BinWidth
Get or Set the number of data points in each range.
Declaration
public double BinWidth { get; set; }
Property Value
Type |
---|
System.Double |
Remarks
Applies only to Histogram and Pareto charts.
CategoryLabels
Gets or sets the category labels for the chart.
Declaration
public IRange CategoryLabels { get; set; }
Property Value
Type |
---|
IRange |
CategoryType
Gets or sets the ExcelCategoryType.
Declaration
public ExcelCategoryType CategoryType { get; set; }
Property Value
Type |
---|
ExcelCategoryType |
CrossesAt
Gets or sets the point on the value axis where the category axis crosses it. Applies only to the value axis.
Declaration
public override double CrossesAt { get; set; }
Property Value
Type |
---|
System.Double |
Overrides
EnteredDirectlyCategoryLabels
Gets or sets the directly entered category labels for the chart.
Declaration
public object[] EnteredDirectlyCategoryLabels { get; set; }
Property Value
Type |
---|
System.Object[] |
HasAutomaticBins
True if bins generated are automatic. otherwise False
Declaration
public bool HasAutomaticBins { get; set; }
Property Value
Type |
---|
System.Boolean |
Remarks
Applies only to Histogram and Pareto charts.
IsAutoCross
Automatic category crossing point selected.
Declaration
public override bool IsAutoCross { get; set; }
Property Value
Type |
---|
System.Boolean |
Overrides
IsAutoMajor
Automatic major selected.
Declaration
public override bool IsAutoMajor { get; set; }
Property Value
Type |
---|
System.Boolean |
Overrides
IsAutoMax
Automatic maximum selected.
Declaration
public override bool IsAutoMax { get; set; }
Property Value
Type |
---|
System.Boolean |
Overrides
IsAutoMin
Automatic minimum selected.
Declaration
public override bool IsAutoMin { get; set; }
Property Value
Type |
---|
System.Boolean |
Overrides
IsAutoMinor
Automatic minor selected.
Declaration
public override bool IsAutoMinor { get; set; }
Property Value
Type |
---|
System.Boolean |
Overrides
IsBetween
True to cut unused plot area. otherwise False. Default for area and surface charts.
Declaration
public bool IsBetween { get; set; }
Property Value
Type |
---|
System.Boolean |
IsBinningByCategory
True if bins generated by category values. otherwise False
Declaration
public bool IsBinningByCategory { get; set; }
Property Value
Type |
---|
System.Boolean |
Remarks
Applies only to Histogram and Pareto charts.
IsMaxCross
True if the value axis crosses at the far right category (in a line, bar, column, scatter, or area chart; 2D charts only).
Declaration
public override bool IsMaxCross { get; set; }
Property Value
Type |
---|
System.Boolean |
Overrides
LabelFrequency
Gets or sets the number of categories or series between tick-mark labels.
Declaration
public int LabelFrequency { get; set; }
Property Value
Type |
---|
System.Int32 |
MajorUnit
Gets or sets the major units for the value axis.
Declaration
public override double MajorUnit { get; set; }
Property Value
Type |
---|
System.Double |
Overrides
MajorUnitScale
Gets or sets the major unit scale value for the category axis when the CategoryType of the axis is set to Time.
Declaration
public ExcelChartBaseUnit MajorUnitScale { get; set; }
Property Value
Type |
---|
ExcelChartBaseUnit |
MinorUnit
Value of minor increment.
Declaration
public override double MinorUnit { get; set; }
Property Value
Type |
---|
System.Double |
Overrides
MinorUnitScale
Gets or sets the minor unit scale value for the category axis when the CategoryType of the axis is set to TimeScale.
Declaration
public ExcelChartBaseUnit MinorUnitScale { get; set; }
Property Value
Type |
---|
ExcelChartBaseUnit |
NoMultiLevelLabel
True if multi-Level category axis is not allowed. otherwise False.
Declaration
public bool NoMultiLevelLabel { get; set; }
Property Value
Type |
---|
System.Boolean |
NumberOfBins
Get or set the Number of Bins in the axis
Declaration
public int NumberOfBins { get; set; }
Property Value
Type |
---|
System.Int32 |
Remarks
Applies only to Histogram and Pareto charts.Can be a value from 1 through 31999.
Offset
Gets or sets the distance between the labels and the axis line. The value can be from 0 through 1000.
Declaration
public int Offset { get; set; }
Property Value
Type |
---|
System.Int32 |
OverflowBinValue
Get or Set the OverFlow Bin value
Declaration
public double OverflowBinValue { get; set; }
Property Value
Type |
---|
System.Double |
Remarks
Applies only to Histogram and Pareto charts.
ReversePlotOrder
True if plots data points from last to first.
Declaration
public override bool ReversePlotOrder { get; set; }
Property Value
Type |
---|
System.Boolean |
Overrides
TextLinkType
Creates title area. Read-only.
Declaration
protected override ExcelObjectTextLink TextLinkType { get; }
Property Value
Type |
---|
ExcelObjectTextLink |
Overrides
TickLabelSpacing
Gets or sets the number of categories or series between tick-mark labels. Applies only to category and series axes. Can be a value from 1 through 31999.
Declaration
public int TickLabelSpacing { get; set; }
Property Value
Type |
---|
System.Int32 |
TickMarksFrequency
Gets or sets the number of categories or series between tick marks.
Declaration
public int TickMarksFrequency { get; set; }
Property Value
Type |
---|
System.Int32 |
TickMarkSpacing
Gets or sets the number of categories or series between tick marks. Applies only to category and series axes. Can be a value from 1 through 31999.
Declaration
public int TickMarkSpacing { get; set; }
Property Value
Type |
---|
System.Int32 |
UnderflowBinValue
Get or Set the UnderFlow Bin value
Declaration
public double UnderflowBinValue { get; set; }
Property Value
Type |
---|
System.Double |
Remarks
Applies only to Histogram and Pareto charts.
Methods
CheckValueRangeRecord(Boolean)
Checks for error free ChartValueRangeRecord.
Declaration
protected override 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. |
Overrides
Clone(Object, Dictionary<Int32, Int32>, Dictionary<String, String>)
Creates a copy of current instance with the specified parent object, Font indexes and worksheet names dictionary.
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 the cloned object. |
Overrides
InitializeVariables()
Initializes internal variables.
Declaration
protected override void InitializeVariables()
Overrides
ParseData(BiffRecordRaw, IList<BiffRecordRaw>, ref Int32)
Parses data of the specified record.
Declaration
protected override void ParseData(BiffRecordRaw record, IList<BiffRecordRaw> data, ref int iPos)
Parameters
Type | Name | Description |
---|---|---|
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw | record | Represents 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 from the specified record.
Declaration
protected override void ParseMaxCross(BiffRecordRaw record)
Parameters
Type | Name | Description |
---|---|---|
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw | record | Represents max cross data to parse. |
Overrides
ParseWallsOrFloor(IList<BiffRecordRaw>, ref Int32)
Parses walls or floor from the specified list of Binary Interchanged File Formats (BIFF) records and the offset.
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 the axis record.
Declaration
public override void Serialize(OffsetArrayList records)
Parameters
Type | Name | Description |
---|---|---|
OffsetArrayList | records | OffsetArrayList that will receive all records. |
Overrides
SerializeWallsOrFloor(OffsetArrayList)
Serializes walls or floor of the axis.
Declaration
protected override void SerializeWallsOrFloor(OffsetArrayList records)
Parameters
Type | Name | Description |
---|---|---|
OffsetArrayList | records | Record storage. |