Axis
Axis class
Encapsulates the object that represents an axis of chart.
class Axis;
Example
const { Workbook, ChartType, CrossType } = require("aspose.cells.node");
//Instantiating a Workbook object
var workbook = new Workbook();
//Adding a new worksheet to the Excel object
var sheetIndex = workbook.worksheets.add();
//Obtaining the reference of the newly added worksheet by passing its sheet index
var worksheet = workbook.worksheets.get(sheetIndex);
//Adding a sample value to "A1" cell
worksheet.cells.get("A1").putValue(50);
//Adding a sample value to "A2" cell
worksheet.cells.get("A2").putValue(100);
//Adding a sample value to "A3" cell
worksheet.cells.get("A3").putValue(150);
//Adding a sample value to "B1" cell
worksheet.cells.get("B1").putValue(4);
//Adding a sample value to "B2" cell
worksheet.cells.get("B2").putValue(20);
//Adding a sample value to "B3" cell
worksheet.cells.get("B3").putValue(50);
//Adding a chart to the worksheet
var chartIndex = worksheet.charts.add(ChartType.Column, 5, 0, 25, 5);
//Accessing the instance of the newly added chart
var chart = worksheet.charts.get(chartIndex);
//Adding NSeries (chart data source) to the chart ranging from "A1" cell to "B3"
chart.nSeries.add("A1:B3", true);
//Set the max value of value axis
chart.valueAxis.maxValue = 200;
//Set the min value of value axis
chart.valueAxis.minValue = 0;
//Set the major unit
chart.valueAxis.majorUnit = 25;
//Category(X) axis crosses at the maxinum value.
chart.valueAxis.crossType = CrossType.Maximum;
//Set he number of categories or series between tick-mark labels.
chart.categoryAxis.tickLabelSpacing = 2;
//Saving the Excel file
workbook.save("output/ChartsAxis.xlsx");
Properties
| Property | Type | Description |
|---|---|---|
| area | Area | Readonly. Gets the Area. |
| isAutomaticMinValue | boolean | Indicates whether the min value is automatically assigned. |
| minValue | Object | Represents the minimum value on the value axis. |
| isAutomaticMaxValue | boolean | Indicates whether the max value is automatically assigned. |
| maxValue | Object | Represents the maximum value on the value axis. |
| isAutomaticMajorUnit | boolean | Indicates whether the major unit of the axis is automatically assigned. |
| majorUnit | number | Represents the major units for the axis. |
| isAutomaticMinorUnit | boolean | Indicates whether the minor unit of the axis is automatically assigned. |
| minorUnit | number | Represents the minor units for the axis. |
| axisLine | Line | Readonly. Gets the appearance of an Axis. |
| majorTickMark | TickMarkType | Represents the type of major tick mark for the specified axis. |
| minorTickMark | TickMarkType | Represents the type of minor tick mark for the specified axis. |
| tickLabelPosition | TickLabelPositionType | Represents the position of tick-mark labels on the specified axis. |
| crossAt | number | Represents the point on the value axis where the category axis crosses it. |
| crossType | CrossType | Represents the CrossType on the specified axis where the other axis crosses. |
| logBase | number | Represents the logarithmic base. Default value is 10.Only applies for Excel2007. |
| isLogarithmic | boolean | Represents if the value axis scale type is logarithmic or not. |
| isPlotOrderReversed | boolean | Represents if Microsoft Excel plots data points from last to first. |
| axisBetweenCategories | boolean | Represents if the value axis crosses the category axis between categories. |
| tickLabels | TickLabels | Readonly. Returns a TickLabels object that represents the tick-mark labels for the specified axis. |
| tickLabelSpacing | number | Represents the number of categories or series between tick-mark labels. Applies only to category and series axes. |
| isAutoTickLabelSpacing | boolean | Indicates whether the spacing of tick label is automatic |
| tickMarkSpacing | number | Returns or sets the number of categories or series between tick marks. Applies only to category and series axes. |
| displayUnit | DisplayUnitType | Represents the unit label for the specified axis. |
| customUnit | number | Specifies a custom value for the display unit. |
| customDisplayUnit | number | Specifies a custom value for the display unit. |
| displayUnitLabel | DisplayUnitLabel | Readonly. Represents a unit label on an axis in the specified chart. Unit labels are useful for charting large values— for example, in the millions or billions. |
| isDisplayUnitLabelShown | boolean | Represents if the display unit label is shown on the specified axis. |
| title | Title | Readonly. Gets the axis’ title. |
| categoryType | CategoryType | Represents the category axis type. |
| baseUnitScale | TimeUnit | Represents the base unit scale for the category axis. |
| majorUnitScale | TimeUnit | Represents the major unit scale for the category axis. |
| minorUnitScale | TimeUnit | Represents the major unit scale for the category axis. |
| isVisible | boolean | Represents if the axis is visible. |
| majorGridLines | Line | Readonly. Represents major gridlines on a chart axis. |
| minorGridLines | Line | Readonly. Represents minor gridlines on a chart axis. |
| hasMultiLevelLabels | boolean | Indicates whether the labels shall be shown as multi level. |
| bins | AxisBins | Readonly. Represents bins on a chart(Histogram/Pareto) axis |
Methods
| Method | Description |
|---|---|
| getArea() | @deprecated. Please use the ‘area’ property instead. Gets the Area. |
| isAutomaticMinValue() | @deprecated. Please use the ‘isAutomaticMinValue’ property instead. Indicates whether the min value is automatically assigned. |
| setIsAutomaticMinValue(boolean) | @deprecated. Please use the ‘isAutomaticMinValue’ property instead. Indicates whether the min value is automatically assigned. |
| getMinValue() | @deprecated. Please use the ‘minValue’ property instead. Represents the minimum value on the value axis. |
| setMinValue(Object) | @deprecated. Please use the ‘minValue’ property instead. Represents the minimum value on the value axis. |
| isAutomaticMaxValue() | @deprecated. Please use the ‘isAutomaticMaxValue’ property instead. Indicates whether the max value is automatically assigned. |
| setIsAutomaticMaxValue(boolean) | @deprecated. Please use the ‘isAutomaticMaxValue’ property instead. Indicates whether the max value is automatically assigned. |
| getMaxValue() | @deprecated. Please use the ‘maxValue’ property instead. Represents the maximum value on the value axis. |
| setMaxValue(Object) | @deprecated. Please use the ‘maxValue’ property instead. Represents the maximum value on the value axis. |
| isAutomaticMajorUnit() | @deprecated. Please use the ‘isAutomaticMajorUnit’ property instead. Indicates whether the major unit of the axis is automatically assigned. |
| setIsAutomaticMajorUnit(boolean) | @deprecated. Please use the ‘isAutomaticMajorUnit’ property instead. Indicates whether the major unit of the axis is automatically assigned. |
| getMajorUnit() | @deprecated. Please use the ‘majorUnit’ property instead. Represents the major units for the axis. |
| setMajorUnit(number) | @deprecated. Please use the ‘majorUnit’ property instead. Represents the major units for the axis. |
| isAutomaticMinorUnit() | @deprecated. Please use the ‘isAutomaticMinorUnit’ property instead. Indicates whether the minor unit of the axis is automatically assigned. |
| setIsAutomaticMinorUnit(boolean) | @deprecated. Please use the ‘isAutomaticMinorUnit’ property instead. Indicates whether the minor unit of the axis is automatically assigned. |
| getMinorUnit() | @deprecated. Please use the ‘minorUnit’ property instead. Represents the minor units for the axis. |
| setMinorUnit(number) | @deprecated. Please use the ‘minorUnit’ property instead. Represents the minor units for the axis. |
| getAxisLine() | @deprecated. Please use the ‘axisLine’ property instead. Gets the appearance of an Axis. |
| getMajorTickMark() | @deprecated. Please use the ‘majorTickMark’ property instead. Represents the type of major tick mark for the specified axis. |
| setMajorTickMark(TickMarkType) | @deprecated. Please use the ‘majorTickMark’ property instead. Represents the type of major tick mark for the specified axis. |
| getMinorTickMark() | @deprecated. Please use the ‘minorTickMark’ property instead. Represents the type of minor tick mark for the specified axis. |
| setMinorTickMark(TickMarkType) | @deprecated. Please use the ‘minorTickMark’ property instead. Represents the type of minor tick mark for the specified axis. |
| getTickLabelPosition() | @deprecated. Please use the ’tickLabelPosition’ property instead. Represents the position of tick-mark labels on the specified axis. |
| setTickLabelPosition(TickLabelPositionType) | @deprecated. Please use the ’tickLabelPosition’ property instead. Represents the position of tick-mark labels on the specified axis. |
| getCrossAt() | @deprecated. Please use the ‘crossAt’ property instead. Represents the point on the value axis where the category axis crosses it. |
| setCrossAt(number) | @deprecated. Please use the ‘crossAt’ property instead. Represents the point on the value axis where the category axis crosses it. |
| getCrossType() | @deprecated. Please use the ‘crossType’ property instead. Represents the CrossType on the specified axis where the other axis crosses. |
| setCrossType(CrossType) | @deprecated. Please use the ‘crossType’ property instead. Represents the CrossType on the specified axis where the other axis crosses. |
| getLogBase() | @deprecated. Please use the ’logBase’ property instead. Represents the logarithmic base. Default value is 10.Only applies for Excel2007. |
| setLogBase(number) | @deprecated. Please use the ’logBase’ property instead. Represents the logarithmic base. Default value is 10.Only applies for Excel2007. |
| isLogarithmic() | @deprecated. Please use the ‘isLogarithmic’ property instead. Represents if the value axis scale type is logarithmic or not. |
| setIsLogarithmic(boolean) | @deprecated. Please use the ‘isLogarithmic’ property instead. Represents if the value axis scale type is logarithmic or not. |
| isPlotOrderReversed() | @deprecated. Please use the ‘isPlotOrderReversed’ property instead. Represents if Microsoft Excel plots data points from last to first. |
| setIsPlotOrderReversed(boolean) | @deprecated. Please use the ‘isPlotOrderReversed’ property instead. Represents if Microsoft Excel plots data points from last to first. |
| getAxisBetweenCategories() | @deprecated. Please use the ‘axisBetweenCategories’ property instead. Represents if the value axis crosses the category axis between categories. |
| setAxisBetweenCategories(boolean) | @deprecated. Please use the ‘axisBetweenCategories’ property instead. Represents if the value axis crosses the category axis between categories. |
| getTickLabels() | @deprecated. Please use the ’tickLabels’ property instead. Returns a TickLabels object that represents the tick-mark labels for the specified axis. |
| getTickLabelSpacing() | @deprecated. Please use the ’tickLabelSpacing’ property instead. Represents the number of categories or series between tick-mark labels. Applies only to category and series axes. |
| setTickLabelSpacing(number) | @deprecated. Please use the ’tickLabelSpacing’ property instead. Represents the number of categories or series between tick-mark labels. Applies only to category and series axes. |
| isAutoTickLabelSpacing() | @deprecated. Please use the ‘isAutoTickLabelSpacing’ property instead. Indicates whether the spacing of tick label is automatic |
| setIsAutoTickLabelSpacing(boolean) | @deprecated. Please use the ‘isAutoTickLabelSpacing’ property instead. Indicates whether the spacing of tick label is automatic |
| getTickMarkSpacing() | @deprecated. Please use the ’tickMarkSpacing’ property instead. Returns or sets the number of categories or series between tick marks. Applies only to category and series axes. |
| setTickMarkSpacing(number) | @deprecated. Please use the ’tickMarkSpacing’ property instead. Returns or sets the number of categories or series between tick marks. Applies only to category and series axes. |
| getDisplayUnit() | @deprecated. Please use the ‘displayUnit’ property instead. Represents the unit label for the specified axis. |
| setDisplayUnit(DisplayUnitType) | @deprecated. Please use the ‘displayUnit’ property instead. Represents the unit label for the specified axis. |
| getCustomUnit() | @deprecated. Please use the ‘customUnit’ property instead. Specifies a custom value for the display unit. |
| setCustomUnit(number) | @deprecated. Please use the ‘customUnit’ property instead. Specifies a custom value for the display unit. |
| getCustomDisplayUnit() | @deprecated. Please use the ‘customDisplayUnit’ property instead. Specifies a custom value for the display unit. |
| setCustomDisplayUnit(number) | @deprecated. Please use the ‘customDisplayUnit’ property instead. Specifies a custom value for the display unit. |
| getDisplayUnitLabel() | @deprecated. Please use the ‘displayUnitLabel’ property instead. Represents a unit label on an axis in the specified chart. Unit labels are useful for charting large values— for example, in the millions or billions. |
| isDisplayUnitLabelShown() | @deprecated. Please use the ‘isDisplayUnitLabelShown’ property instead. Represents if the display unit label is shown on the specified axis. |
| setIsDisplayUnitLabelShown(boolean) | @deprecated. Please use the ‘isDisplayUnitLabelShown’ property instead. Represents if the display unit label is shown on the specified axis. |
| getTitle() | @deprecated. Please use the ’title’ property instead. Gets the axis’ title. |
| getCategoryType() | @deprecated. Please use the ‘categoryType’ property instead. Represents the category axis type. |
| setCategoryType(CategoryType) | @deprecated. Please use the ‘categoryType’ property instead. Represents the category axis type. |
| getBaseUnitScale() | @deprecated. Please use the ‘baseUnitScale’ property instead. Represents the base unit scale for the category axis. |
| setBaseUnitScale(TimeUnit) | @deprecated. Please use the ‘baseUnitScale’ property instead. Represents the base unit scale for the category axis. |
| getMajorUnitScale() | @deprecated. Please use the ‘majorUnitScale’ property instead. Represents the major unit scale for the category axis. |
| setMajorUnitScale(TimeUnit) | @deprecated. Please use the ‘majorUnitScale’ property instead. Represents the major unit scale for the category axis. |
| getMinorUnitScale() | @deprecated. Please use the ‘minorUnitScale’ property instead. Represents the major unit scale for the category axis. |
| setMinorUnitScale(TimeUnit) | @deprecated. Please use the ‘minorUnitScale’ property instead. Represents the major unit scale for the category axis. |
| isVisible() | @deprecated. Please use the ‘isVisible’ property instead. Represents if the axis is visible. |
| setIsVisible(boolean) | @deprecated. Please use the ‘isVisible’ property instead. Represents if the axis is visible. |
| getMajorGridLines() | @deprecated. Please use the ‘majorGridLines’ property instead. Represents major gridlines on a chart axis. |
| getMinorGridLines() | @deprecated. Please use the ‘minorGridLines’ property instead. Represents minor gridlines on a chart axis. |
| getHasMultiLevelLabels() | @deprecated. Please use the ‘hasMultiLevelLabels’ property instead. Indicates whether the labels shall be shown as multi level. |
| setHasMultiLevelLabels(boolean) | @deprecated. Please use the ‘hasMultiLevelLabels’ property instead. Indicates whether the labels shall be shown as multi level. |
| getBins() | @deprecated. Please use the ‘bins’ property instead. Represents bins on a chart(Histogram/Pareto) axis |
| getAxisTexts() | Gets the labels of the axis after call Chart.Calculate() method. |
| isNull() | Checks whether the implementation object is null. |
area
Readonly. Gets the Area.
area : Area;
isAutomaticMinValue
Indicates whether the min value is automatically assigned.
isAutomaticMinValue : boolean;
minValue
Represents the minimum value on the value axis.
minValue : Object;
Remarks
The minValue type only can be double or DateTime
isAutomaticMaxValue
Indicates whether the max value is automatically assigned.
isAutomaticMaxValue : boolean;
maxValue
Represents the maximum value on the value axis.
maxValue : Object;
Remarks
The maxValue type only can be double or DateTime
isAutomaticMajorUnit
Indicates whether the major unit of the axis is automatically assigned.
isAutomaticMajorUnit : boolean;
majorUnit
Represents the major units for the axis.
majorUnit : number;
Remarks
The major units must be greater than zero.
isAutomaticMinorUnit
Indicates whether the minor unit of the axis is automatically assigned.
isAutomaticMinorUnit : boolean;
minorUnit
Represents the minor units for the axis.
minorUnit : number;
Remarks
The minor units must be greater than zero.
axisLine
Readonly. Gets the appearance of an Axis.
axisLine : Line;
majorTickMark
Represents the type of major tick mark for the specified axis.
majorTickMark : TickMarkType;
minorTickMark
Represents the type of minor tick mark for the specified axis.
minorTickMark : TickMarkType;
tickLabelPosition
Represents the position of tick-mark labels on the specified axis.
tickLabelPosition : TickLabelPositionType;
crossAt
Represents the point on the value axis where the category axis crosses it.
crossAt : number;
Remarks
The number should be a integer when it applies to category axis. And the value must be between 1 and 31999.
crossType
Represents the CrossType on the specified axis where the other axis crosses.
crossType : CrossType;
logBase
Represents the logarithmic base. Default value is 10.Only applies for Excel2007.
logBase : number;
isLogarithmic
Represents if the value axis scale type is logarithmic or not.
isLogarithmic : boolean;
isPlotOrderReversed
Represents if Microsoft Excel plots data points from last to first.
isPlotOrderReversed : boolean;
axisBetweenCategories
Represents if the value axis crosses the category axis between categories.
axisBetweenCategories : boolean;
Remarks
This property applies only to category axes, and it doesn’t apply to 3-D charts.
tickLabels
Readonly. Returns a TickLabels object that represents the tick-mark labels for the specified axis.
tickLabels : TickLabels;
tickLabelSpacing
Represents the number of categories or series between tick-mark labels. Applies only to category and series axes.
tickLabelSpacing : number;
Remarks
The number must be between 1 and 31999.
isAutoTickLabelSpacing
Indicates whether the spacing of tick label is automatic
isAutoTickLabelSpacing : boolean;
tickMarkSpacing
Returns or sets the number of categories or series between tick marks. Applies only to category and series axes.
tickMarkSpacing : number;
Remarks
The number must be between 1 and 31999.
displayUnit
Represents the unit label for the specified axis.
displayUnit : DisplayUnitType;
customUnit
Specifies a custom value for the display unit.
customUnit : number;
Remarks
NOTE: This property is now obsolete. Instead, please use Axis.CustomDisplayUnit property. This property will be removed 12 months later since February 2025. Aspose apologizes for any inconvenience you may have experienced.
customDisplayUnit
Specifies a custom value for the display unit.
customDisplayUnit : number;
displayUnitLabel
Readonly. Represents a unit label on an axis in the specified chart. Unit labels are useful for charting large values— for example, in the millions or billions.
displayUnitLabel : DisplayUnitLabel;
isDisplayUnitLabelShown
Represents if the display unit label is shown on the specified axis.
isDisplayUnitLabelShown : boolean;
Remarks
The default value is True.
title
Readonly. Gets the axis’ title.
title : Title;
categoryType
Represents the category axis type.
categoryType : CategoryType;
baseUnitScale
Represents the base unit scale for the category axis.
baseUnitScale : TimeUnit;
Remarks
Setting this property only takes effect when the CategoryType property is set to TimeScale.
majorUnitScale
Represents the major unit scale for the category axis.
majorUnitScale : TimeUnit;
Example
const { Workbook, ChartType, CategoryType, TimeUnit } = require("aspose.cells.node");
var workbook = new Workbook();
//Adding a new worksheet to the Excel object
var sheetIndex = workbook.worksheets.add();
//Obtaining the reference of the newly added worksheet by passing its sheet index
var worksheet = workbook.worksheets.get(sheetIndex);
//Adding a sample value to "A1" cell
worksheet.cells.get("A1").putValue(50);
//Adding a sample value to "A2" cell
worksheet.cells.get("A2").putValue(100);
//Adding a sample value to "A3" cell
worksheet.cells.get("A3").putValue(150);
//Adding a sample value to "B1" cell
worksheet.cells.get("B1").putValue(4);
//Adding a sample value to "B2" cell
worksheet.cells.get("B2").putValue(20);
//Adding a sample value to "B3" cell
worksheet.cells.get("B3").putValue(50);
//Adding a chart to the worksheet
var chartIndex = worksheet.charts.add(ChartType.Column, 5, 0, 25, 5);
//Accessing the instance of the newly added chart
var chart = worksheet.charts.get(chartIndex);
chart.categoryAxis.categoryType = CategoryType.TimeScale;
chart.categoryAxis.majorUnitScale = TimeUnit.Months;
chart.categoryAxis.majorUnit = 2;
minorUnitScale
Represents the major unit scale for the category axis.
minorUnitScale : TimeUnit;
Example
const { Workbook, ChartType, CategoryType, TimeUnit } = require("aspose.cells.node");
var workbook = new Workbook();
//Adding a new worksheet to the Excel object
var sheetIndex = workbook.worksheets.add();
//Obtaining the reference of the newly added worksheet by passing its sheet index
var worksheet = workbook.worksheets.get(sheetIndex);
//Adding a sample value to "A1" cell
worksheet.cells.get("A1").putValue(50);
//Adding a sample value to "A2" cell
worksheet.cells.get("A2").putValue(100);
//Adding a sample value to "A3" cell
worksheet.cells.get("A3").putValue(150);
//Adding a sample value to "B1" cell
worksheet.cells.get("B1").putValue(4);
//Adding a sample value to "B2" cell
worksheet.cells.get("B2").putValue(20);
//Adding a sample value to "B3" cell
worksheet.cells.get("B3").putValue(50);
//Adding a chart to the worksheet
var chartIndex = worksheet.charts.add(ChartType.Column, 5, 0, 25, 5);
//Accessing the instance of the newly added chart
var chart = worksheet.charts.get(chartIndex);
chart.categoryAxis.categoryType = CategoryType.TimeScale;
chart.categoryAxis.minorUnitScale = TimeUnit.Months;
chart.categoryAxis.minorUnit = 2;
isVisible
Represents if the axis is visible.
isVisible : boolean;
majorGridLines
Readonly. Represents major gridlines on a chart axis.
majorGridLines : Line;
Example
const { Workbook, ChartType } = require("aspose.cells.node");
var workbook = new Workbook();
//Adding a new worksheet to the Excel object
var sheetIndex = workbook.worksheets.add();
//Obtaining the reference of the newly added worksheet by passing its sheet index
var worksheet = workbook.worksheets.get(sheetIndex);
//Adding a sample value to "A1" cell
worksheet.cells.get("A1").putValue(50);
//Adding a sample value to "A2" cell
worksheet.cells.get("A2").putValue(100);
//Adding a sample value to "A3" cell
worksheet.cells.get("A3").putValue(150);
//Adding a sample value to "B1" cell
worksheet.cells.get("B1").putValue(4);
//Adding a sample value to "B2" cell
worksheet.cells.get("B2").putValue(20);
//Adding a sample value to "B3" cell
worksheet.cells.get("B3").putValue(50);
//Adding a chart to the worksheet
var chartIndex = worksheet.charts.add(ChartType.Column, 5, 0, 25, 5);
//Accessing the instance of the newly added chart
var chart = worksheet.charts.get(chartIndex);
chart.valueAxis.majorGridLines.isVisible = false;
chart.categoryAxis.majorGridLines.isVisible = true;
minorGridLines
Readonly. Represents minor gridlines on a chart axis.
minorGridLines : Line;
hasMultiLevelLabels
Indicates whether the labels shall be shown as multi level.
hasMultiLevelLabels : boolean;
Remarks
Only valid for category axis.
bins
Readonly. Represents bins on a chart(Histogram/Pareto) axis
bins : AxisBins;
getArea()
@deprecated. Please use the ‘area’ property instead. Gets the Area.
getArea() : Area;
Returns
isAutomaticMinValue()
@deprecated. Please use the ‘isAutomaticMinValue’ property instead. Indicates whether the min value is automatically assigned.
isAutomaticMinValue() : boolean;
setIsAutomaticMinValue(boolean)
@deprecated. Please use the ‘isAutomaticMinValue’ property instead. Indicates whether the min value is automatically assigned.
setIsAutomaticMinValue(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getMinValue()
@deprecated. Please use the ‘minValue’ property instead. Represents the minimum value on the value axis.
getMinValue() : Object;
Remarks
The minValue type only can be double or DateTime
setMinValue(Object)
@deprecated. Please use the ‘minValue’ property instead. Represents the minimum value on the value axis.
setMinValue(value: Object) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Object | The value to set. |
Remarks
The minValue type only can be double or DateTime
isAutomaticMaxValue()
@deprecated. Please use the ‘isAutomaticMaxValue’ property instead. Indicates whether the max value is automatically assigned.
isAutomaticMaxValue() : boolean;
setIsAutomaticMaxValue(boolean)
@deprecated. Please use the ‘isAutomaticMaxValue’ property instead. Indicates whether the max value is automatically assigned.
setIsAutomaticMaxValue(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getMaxValue()
@deprecated. Please use the ‘maxValue’ property instead. Represents the maximum value on the value axis.
getMaxValue() : Object;
Remarks
The maxValue type only can be double or DateTime
setMaxValue(Object)
@deprecated. Please use the ‘maxValue’ property instead. Represents the maximum value on the value axis.
setMaxValue(value: Object) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Object | The value to set. |
Remarks
The maxValue type only can be double or DateTime
isAutomaticMajorUnit()
@deprecated. Please use the ‘isAutomaticMajorUnit’ property instead. Indicates whether the major unit of the axis is automatically assigned.
isAutomaticMajorUnit() : boolean;
setIsAutomaticMajorUnit(boolean)
@deprecated. Please use the ‘isAutomaticMajorUnit’ property instead. Indicates whether the major unit of the axis is automatically assigned.
setIsAutomaticMajorUnit(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getMajorUnit()
@deprecated. Please use the ‘majorUnit’ property instead. Represents the major units for the axis.
getMajorUnit() : number;
Remarks
The major units must be greater than zero.
setMajorUnit(number)
@deprecated. Please use the ‘majorUnit’ property instead. Represents the major units for the axis.
setMajorUnit(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
Remarks
The major units must be greater than zero.
isAutomaticMinorUnit()
@deprecated. Please use the ‘isAutomaticMinorUnit’ property instead. Indicates whether the minor unit of the axis is automatically assigned.
isAutomaticMinorUnit() : boolean;
setIsAutomaticMinorUnit(boolean)
@deprecated. Please use the ‘isAutomaticMinorUnit’ property instead. Indicates whether the minor unit of the axis is automatically assigned.
setIsAutomaticMinorUnit(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getMinorUnit()
@deprecated. Please use the ‘minorUnit’ property instead. Represents the minor units for the axis.
getMinorUnit() : number;
Remarks
The minor units must be greater than zero.
setMinorUnit(number)
@deprecated. Please use the ‘minorUnit’ property instead. Represents the minor units for the axis.
setMinorUnit(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
Remarks
The minor units must be greater than zero.
getAxisLine()
@deprecated. Please use the ‘axisLine’ property instead. Gets the appearance of an Axis.
getAxisLine() : Line;
Returns
getMajorTickMark()
@deprecated. Please use the ‘majorTickMark’ property instead. Represents the type of major tick mark for the specified axis.
getMajorTickMark() : TickMarkType;
Returns
setMajorTickMark(TickMarkType)
@deprecated. Please use the ‘majorTickMark’ property instead. Represents the type of major tick mark for the specified axis.
setMajorTickMark(value: TickMarkType) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | TickMarkType | The value to set. |
getMinorTickMark()
@deprecated. Please use the ‘minorTickMark’ property instead. Represents the type of minor tick mark for the specified axis.
getMinorTickMark() : TickMarkType;
Returns
setMinorTickMark(TickMarkType)
@deprecated. Please use the ‘minorTickMark’ property instead. Represents the type of minor tick mark for the specified axis.
setMinorTickMark(value: TickMarkType) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | TickMarkType | The value to set. |
getTickLabelPosition()
@deprecated. Please use the ’tickLabelPosition’ property instead. Represents the position of tick-mark labels on the specified axis.
getTickLabelPosition() : TickLabelPositionType;
Returns
setTickLabelPosition(TickLabelPositionType)
@deprecated. Please use the ’tickLabelPosition’ property instead. Represents the position of tick-mark labels on the specified axis.
setTickLabelPosition(value: TickLabelPositionType) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | TickLabelPositionType | The value to set. |
getCrossAt()
@deprecated. Please use the ‘crossAt’ property instead. Represents the point on the value axis where the category axis crosses it.
getCrossAt() : number;
Remarks
The number should be a integer when it applies to category axis. And the value must be between 1 and 31999.
setCrossAt(number)
@deprecated. Please use the ‘crossAt’ property instead. Represents the point on the value axis where the category axis crosses it.
setCrossAt(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
Remarks
The number should be a integer when it applies to category axis. And the value must be between 1 and 31999.
getCrossType()
@deprecated. Please use the ‘crossType’ property instead. Represents the CrossType on the specified axis where the other axis crosses.
getCrossType() : CrossType;
Returns
setCrossType(CrossType)
@deprecated. Please use the ‘crossType’ property instead. Represents the CrossType on the specified axis where the other axis crosses.
setCrossType(value: CrossType) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | CrossType | The value to set. |
getLogBase()
@deprecated. Please use the ’logBase’ property instead. Represents the logarithmic base. Default value is 10.Only applies for Excel2007.
getLogBase() : number;
setLogBase(number)
@deprecated. Please use the ’logBase’ property instead. Represents the logarithmic base. Default value is 10.Only applies for Excel2007.
setLogBase(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
isLogarithmic()
@deprecated. Please use the ‘isLogarithmic’ property instead. Represents if the value axis scale type is logarithmic or not.
isLogarithmic() : boolean;
setIsLogarithmic(boolean)
@deprecated. Please use the ‘isLogarithmic’ property instead. Represents if the value axis scale type is logarithmic or not.
setIsLogarithmic(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
isPlotOrderReversed()
@deprecated. Please use the ‘isPlotOrderReversed’ property instead. Represents if Microsoft Excel plots data points from last to first.
isPlotOrderReversed() : boolean;
setIsPlotOrderReversed(boolean)
@deprecated. Please use the ‘isPlotOrderReversed’ property instead. Represents if Microsoft Excel plots data points from last to first.
setIsPlotOrderReversed(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getAxisBetweenCategories()
@deprecated. Please use the ‘axisBetweenCategories’ property instead. Represents if the value axis crosses the category axis between categories.
getAxisBetweenCategories() : boolean;
Remarks
This property applies only to category axes, and it doesn’t apply to 3-D charts.
setAxisBetweenCategories(boolean)
@deprecated. Please use the ‘axisBetweenCategories’ property instead. Represents if the value axis crosses the category axis between categories.
setAxisBetweenCategories(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
Remarks
This property applies only to category axes, and it doesn’t apply to 3-D charts.
getTickLabels()
@deprecated. Please use the ’tickLabels’ property instead. Returns a TickLabels object that represents the tick-mark labels for the specified axis.
getTickLabels() : TickLabels;
Returns
getTickLabelSpacing()
@deprecated. Please use the ’tickLabelSpacing’ property instead. Represents the number of categories or series between tick-mark labels. Applies only to category and series axes.
getTickLabelSpacing() : number;
Remarks
The number must be between 1 and 31999.
setTickLabelSpacing(number)
@deprecated. Please use the ’tickLabelSpacing’ property instead. Represents the number of categories or series between tick-mark labels. Applies only to category and series axes.
setTickLabelSpacing(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
Remarks
The number must be between 1 and 31999.
isAutoTickLabelSpacing()
@deprecated. Please use the ‘isAutoTickLabelSpacing’ property instead. Indicates whether the spacing of tick label is automatic
isAutoTickLabelSpacing() : boolean;
setIsAutoTickLabelSpacing(boolean)
@deprecated. Please use the ‘isAutoTickLabelSpacing’ property instead. Indicates whether the spacing of tick label is automatic
setIsAutoTickLabelSpacing(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getTickMarkSpacing()
@deprecated. Please use the ’tickMarkSpacing’ property instead. Returns or sets the number of categories or series between tick marks. Applies only to category and series axes.
getTickMarkSpacing() : number;
Remarks
The number must be between 1 and 31999.
setTickMarkSpacing(number)
@deprecated. Please use the ’tickMarkSpacing’ property instead. Returns or sets the number of categories or series between tick marks. Applies only to category and series axes.
setTickMarkSpacing(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
Remarks
The number must be between 1 and 31999.
getDisplayUnit()
@deprecated. Please use the ‘displayUnit’ property instead. Represents the unit label for the specified axis.
getDisplayUnit() : DisplayUnitType;
Returns
setDisplayUnit(DisplayUnitType)
@deprecated. Please use the ‘displayUnit’ property instead. Represents the unit label for the specified axis.
setDisplayUnit(value: DisplayUnitType) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | DisplayUnitType | The value to set. |
getCustomUnit()
@deprecated. Please use the ‘customUnit’ property instead. Specifies a custom value for the display unit.
getCustomUnit() : number;
Remarks
NOTE: This property is now obsolete. Instead, please use Axis.CustomDisplayUnit property. This property will be removed 12 months later since February 2025. Aspose apologizes for any inconvenience you may have experienced.
setCustomUnit(number)
@deprecated. Please use the ‘customUnit’ property instead. Specifies a custom value for the display unit.
setCustomUnit(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
Remarks
NOTE: This property is now obsolete. Instead, please use Axis.CustomDisplayUnit property. This property will be removed 12 months later since February 2025. Aspose apologizes for any inconvenience you may have experienced.
getCustomDisplayUnit()
@deprecated. Please use the ‘customDisplayUnit’ property instead. Specifies a custom value for the display unit.
getCustomDisplayUnit() : number;
setCustomDisplayUnit(number)
@deprecated. Please use the ‘customDisplayUnit’ property instead. Specifies a custom value for the display unit.
setCustomDisplayUnit(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
getDisplayUnitLabel()
@deprecated. Please use the ‘displayUnitLabel’ property instead. Represents a unit label on an axis in the specified chart. Unit labels are useful for charting large values— for example, in the millions or billions.
getDisplayUnitLabel() : DisplayUnitLabel;
Returns
isDisplayUnitLabelShown()
@deprecated. Please use the ‘isDisplayUnitLabelShown’ property instead. Represents if the display unit label is shown on the specified axis.
isDisplayUnitLabelShown() : boolean;
Remarks
The default value is True.
setIsDisplayUnitLabelShown(boolean)
@deprecated. Please use the ‘isDisplayUnitLabelShown’ property instead. Represents if the display unit label is shown on the specified axis.
setIsDisplayUnitLabelShown(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
Remarks
The default value is True.
getTitle()
@deprecated. Please use the ’title’ property instead. Gets the axis’ title.
getTitle() : Title;
Returns
getCategoryType()
@deprecated. Please use the ‘categoryType’ property instead. Represents the category axis type.
getCategoryType() : CategoryType;
Returns
setCategoryType(CategoryType)
@deprecated. Please use the ‘categoryType’ property instead. Represents the category axis type.
setCategoryType(value: CategoryType) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | CategoryType | The value to set. |
getBaseUnitScale()
@deprecated. Please use the ‘baseUnitScale’ property instead. Represents the base unit scale for the category axis.
getBaseUnitScale() : TimeUnit;
Returns
Remarks
Setting this property only takes effect when the CategoryType property is set to TimeScale.
setBaseUnitScale(TimeUnit)
@deprecated. Please use the ‘baseUnitScale’ property instead. Represents the base unit scale for the category axis.
setBaseUnitScale(value: TimeUnit) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | TimeUnit | The value to set. |
Remarks
Setting this property only takes effect when the CategoryType property is set to TimeScale.
getMajorUnitScale()
@deprecated. Please use the ‘majorUnitScale’ property instead. Represents the major unit scale for the category axis.
getMajorUnitScale() : TimeUnit;
Returns
setMajorUnitScale(TimeUnit)
@deprecated. Please use the ‘majorUnitScale’ property instead. Represents the major unit scale for the category axis.
setMajorUnitScale(value: TimeUnit) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | TimeUnit | The value to set. |
getMinorUnitScale()
@deprecated. Please use the ‘minorUnitScale’ property instead. Represents the major unit scale for the category axis.
getMinorUnitScale() : TimeUnit;
Returns
setMinorUnitScale(TimeUnit)
@deprecated. Please use the ‘minorUnitScale’ property instead. Represents the major unit scale for the category axis.
setMinorUnitScale(value: TimeUnit) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | TimeUnit | The value to set. |
isVisible()
@deprecated. Please use the ‘isVisible’ property instead. Represents if the axis is visible.
isVisible() : boolean;
setIsVisible(boolean)
@deprecated. Please use the ‘isVisible’ property instead. Represents if the axis is visible.
setIsVisible(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getMajorGridLines()
@deprecated. Please use the ‘majorGridLines’ property instead. Represents major gridlines on a chart axis.
getMajorGridLines() : Line;
Returns
getMinorGridLines()
@deprecated. Please use the ‘minorGridLines’ property instead. Represents minor gridlines on a chart axis.
getMinorGridLines() : Line;
Returns
getHasMultiLevelLabels()
@deprecated. Please use the ‘hasMultiLevelLabels’ property instead. Indicates whether the labels shall be shown as multi level.
getHasMultiLevelLabels() : boolean;
Remarks
Only valid for category axis.
setHasMultiLevelLabels(boolean)
@deprecated. Please use the ‘hasMultiLevelLabels’ property instead. Indicates whether the labels shall be shown as multi level.
setHasMultiLevelLabels(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
Remarks
Only valid for category axis.
getBins()
@deprecated. Please use the ‘bins’ property instead. Represents bins on a chart(Histogram/Pareto) axis
getBins() : AxisBins;
Returns
getAxisTexts()
Gets the labels of the axis after call Chart.Calculate() method.
getAxisTexts() : string[];
Returns
string[]
isNull()
Checks whether the implementation object is null.
isNull() : boolean;