Excel.ChartAxis class

Package:

excel

Represents a single axis in a chart.

Extends

OfficeExtension.ClientObject

Remarks

[Api set: ExcelApi 1.1]

Properties

alignment	Specifies the alignment for the specified axis tick label. See Excel.ChartTextHorizontalAlignment for detail.
axisGroup	Specifies the group for the specified axis. See Excel.ChartAxisGroup for details.
baseTimeUnit	Specifies the base unit for the specified category axis.
categoryType	Specifies the category axis type.
context	The request context associated with the object. This connects the add-in's process to the Office host application's process.
customDisplayUnit	Specifies the custom axis display unit value. To set this property, please use the SetCustomDisplayUnit(double) method.
displayUnit	Represents the axis display unit. See Excel.ChartAxisDisplayUnit for details.
format	Represents the formatting of a chart object, which includes line and font formatting.
height	Specifies the height, in points, of the chart axis. Returns null if the axis is not visible.
isBetweenCategories	Specifies if the value axis crosses the category axis between categories.
left	Specifies the distance, in points, from the left edge of the axis to the left of chart area. Returns null if the axis is not visible.
linkNumberFormat	Specifies if the number format is linked to the cells. If true, the number format will change in the labels when it changes in the cells.
logBase	Specifies the base of the logarithm when using logarithmic scales.
majorGridlines	Returns an object that represents the major gridlines for the specified axis.
majorTickMark	Specifies the type of major tick mark for the specified axis. See Excel.ChartAxisTickMark for details.
majorTimeUnitScale	Specifies the major unit scale value for the category axis when the categoryType property is set to dateAxis.
majorUnit	Represents the interval between two major tick marks. Can be set to a numeric value or an empty string. The returned value is always a number.
maximum	Represents the maximum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number.
minimum	Represents the minimum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number.
minorGridlines	Returns an object that represents the minor gridlines for the specified axis.
minorTickMark	Specifies the type of minor tick mark for the specified axis. See Excel.ChartAxisTickMark for details.
minorTimeUnitScale	Specifies the minor unit scale value for the category axis when the categoryType property is set to dateAxis.
minorUnit	Represents the interval between two minor tick marks. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number.
multiLevel	Specifies if an axis is multilevel.
numberFormat	Specifies the format code for the axis tick label.
offset	Specifies the distance between the levels of labels, and the distance between the first level and the axis line. The value should be an integer from 0 to 1000.
position	Specifies the specified axis position where the other axis crosses. See Excel.ChartAxisPosition for details.
positionAt	Specifies the axis position where the other axis crosses. You should use the SetPositionAt(double) method to set this property.
reversePlotOrder	Specifies if Excel plots data points from last to first.
scaleType	Specifies the value axis scale type. See Excel.ChartAxisScaleType for details.
showDisplayUnitLabel	Specifies if the axis display unit label is visible.
textOrientation	Specifies the angle to which the text is oriented for the chart axis tick label. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text.
tickLabelPosition	Specifies the position of tick-mark labels on the specified axis. See Excel.ChartAxisTickLabelPosition for details.
tickLabelSpacing	Specifies the number of categories or series between tick-mark labels. Can be a value from 1 through 31999 or an empty string for automatic setting. The returned value is always a number.
tickMarkSpacing	Specifies the number of categories or series between tick marks.
title	Represents the axis title.
top	Specifies the distance, in points, from the top edge of the axis to the top of chart area. Returns null if the axis is not visible.
type	Specifies the axis type. See Excel.ChartAxisType for details.
visible	Specifies if the axis is visible.
width	Specifies the width, in points, of the chart axis. Returns null if the axis is not visible.

Methods

load(options)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
set(properties, options)	Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
set(properties)	Sets multiple properties on the object at the same time, based on an existing loaded object.
setCategoryNames(sourceData)	Sets all the category names for the specified axis.
setCustomDisplayUnit(value)	Sets the axis display unit to a custom value.
setPositionAt(value)	Sets the specified axis position where the other axis crosses.
toJSON()	Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Excel.ChartAxis object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ChartAxisData) that contains shallow copies of any loaded child properties from the original object.

Property Details

alignment

Specifies the alignment for the specified axis tick label. See Excel.ChartTextHorizontalAlignment for detail.

alignment: Excel.ChartTickLabelAlignment | "Center" | "Left" | "Right";

Property Value

Excel.ChartTickLabelAlignment | "Center" | "Left" | "Right"

Remarks

[Api set: ExcelApi 1.8]

axisGroup

Specifies the group for the specified axis. See Excel.ChartAxisGroup for details.

readonly axisGroup: Excel.ChartAxisGroup | "Primary" | "Secondary";

Property Value

Excel.ChartAxisGroup | "Primary" | "Secondary"

Remarks

[Api set: ExcelApi 1.7]

baseTimeUnit

Specifies the base unit for the specified category axis.

baseTimeUnit: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years";

Property Value

Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years"

Remarks

[Api set: ExcelApi 1.7]

categoryType

Specifies the category axis type.

categoryType: Excel.ChartAxisCategoryType | "Automatic" | "TextAxis" | "DateAxis";

Property Value

Excel.ChartAxisCategoryType | "Automatic" | "TextAxis" | "DateAxis"

Remarks

[Api set: ExcelApi 1.7]

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

Excel.RequestContext

customDisplayUnit

Specifies the custom axis display unit value. To set this property, please use the SetCustomDisplayUnit(double) method.

readonly customDisplayUnit: number;

Property Value

number

Remarks

[Api set: ExcelApi 1.7]

displayUnit

Represents the axis display unit. See Excel.ChartAxisDisplayUnit for details.

displayUnit: Excel.ChartAxisDisplayUnit | "None" | "Hundreds" | "Thousands" | "TenThousands" | "HundredThousands" | "Millions" | "TenMillions" | "HundredMillions" | "Billions" | "Trillions" | "Custom";

Property Value

Excel.ChartAxisDisplayUnit | "None" | "Hundreds" | "Thousands" | "TenThousands" | "HundredThousands" | "Millions" | "TenMillions" | "HundredMillions" | "Billions" | "Trillions" | "Custom"

Remarks

[Api set: ExcelApi 1.7]

format

Represents the formatting of a chart object, which includes line and font formatting.

readonly format: Excel.ChartAxisFormat;

Property Value

Excel.ChartAxisFormat

Remarks

[Api set: ExcelApi 1.1]

height

Specifies the height, in points, of the chart axis. Returns null if the axis is not visible.

readonly height: number;

Property Value

number

Remarks

[Api set: ExcelApi 1.7]

isBetweenCategories

Specifies if the value axis crosses the category axis between categories.

isBetweenCategories: boolean;

Property Value

boolean

Remarks

[Api set: ExcelApi 1.8]

left

Specifies the distance, in points, from the left edge of the axis to the left of chart area. Returns null if the axis is not visible.

readonly left: number;

Property Value

number

Remarks

[Api set: ExcelApi 1.7]

linkNumberFormat

Specifies if the number format is linked to the cells. If true, the number format will change in the labels when it changes in the cells.

linkNumberFormat: boolean;

Property Value

boolean

Remarks

[Api set: ExcelApi 1.9]

logBase

Specifies the base of the logarithm when using logarithmic scales.

logBase: number;

Property Value

number

Remarks

[Api set: ExcelApi 1.7]

majorGridlines

Returns an object that represents the major gridlines for the specified axis.

readonly majorGridlines: Excel.ChartGridlines;

Property Value

Excel.ChartGridlines

Remarks

[Api set: ExcelApi 1.1]

majorTickMark

Specifies the type of major tick mark for the specified axis. See Excel.ChartAxisTickMark for details.

majorTickMark: Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | "Outside";

Property Value

Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | "Outside"

Remarks

[Api set: ExcelApi 1.7]

majorTimeUnitScale

Specifies the major unit scale value for the category axis when the categoryType property is set to dateAxis.

majorTimeUnitScale: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years";

Property Value

Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years"

Remarks

[Api set: ExcelApi 1.7]

majorUnit

Represents the interval between two major tick marks. Can be set to a numeric value or an empty string. The returned value is always a number.

majorUnit: any;

Property Value

any

Remarks

[Api set: ExcelApi 1.1]

maximum

Represents the maximum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number.

maximum: any;

Property Value

any

Remarks

[Api set: ExcelApi 1.1]

minimum

Represents the minimum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number.

minimum: any;

Property Value

any

Remarks

[Api set: ExcelApi 1.1]

minorGridlines

Returns an object that represents the minor gridlines for the specified axis.

readonly minorGridlines: Excel.ChartGridlines;

Property Value

Excel.ChartGridlines

Remarks

[Api set: ExcelApi 1.1]

minorTickMark

Specifies the type of minor tick mark for the specified axis. See Excel.ChartAxisTickMark for details.

minorTickMark: Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | "Outside";

Property Value

Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | "Outside"

Remarks

[Api set: ExcelApi 1.7]

minorTimeUnitScale

Specifies the minor unit scale value for the category axis when the categoryType property is set to dateAxis.

minorTimeUnitScale: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years";

Property Value

Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years"

Remarks

[Api set: ExcelApi 1.7]

minorUnit

Represents the interval between two minor tick marks. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number.

minorUnit: any;

Property Value

any

Remarks

[Api set: ExcelApi 1.1]

multiLevel

Specifies if an axis is multilevel.

multiLevel: boolean;

Property Value

boolean

Remarks

[Api set: ExcelApi 1.8]

numberFormat

Specifies the format code for the axis tick label.

numberFormat: string;

Property Value

string

Remarks

[Api set: ExcelApi 1.8]

offset

Specifies the distance between the levels of labels, and the distance between the first level and the axis line. The value should be an integer from 0 to 1000.

offset: number;

Property Value

number

Remarks

[Api set: ExcelApi 1.8]

position

Specifies the specified axis position where the other axis crosses. See Excel.ChartAxisPosition for details.

position: Excel.ChartAxisPosition | "Automatic" | "Maximum" | "Minimum" | "Custom";

Property Value

Excel.ChartAxisPosition | "Automatic" | "Maximum" | "Minimum" | "Custom"

Remarks

[Api set: ExcelApi 1.8]

positionAt

Specifies the axis position where the other axis crosses. You should use the SetPositionAt(double) method to set this property.

readonly positionAt: number;

Property Value

number

Remarks

[Api set: ExcelApi 1.8]

reversePlotOrder

Specifies if Excel plots data points from last to first.

reversePlotOrder: boolean;

Property Value

boolean

Remarks

[Api set: ExcelApi 1.7]

scaleType

Specifies the value axis scale type. See Excel.ChartAxisScaleType for details.

scaleType: Excel.ChartAxisScaleType | "Linear" | "Logarithmic";

Property Value

Excel.ChartAxisScaleType | "Linear" | "Logarithmic"

Remarks

[Api set: ExcelApi 1.7]

showDisplayUnitLabel

Specifies if the axis display unit label is visible.

showDisplayUnitLabel: boolean;

Property Value

boolean

Remarks

[Api set: ExcelApi 1.7]

textOrientation

Specifies the angle to which the text is oriented for the chart axis tick label. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text.

textOrientation: any;

Property Value

any

Remarks

[Api set: ExcelApi 1.8]

tickLabelPosition

Specifies the position of tick-mark labels on the specified axis. See Excel.ChartAxisTickLabelPosition for details.

tickLabelPosition: Excel.ChartAxisTickLabelPosition | "NextToAxis" | "High" | "Low" | "None";

Property Value

Excel.ChartAxisTickLabelPosition | "NextToAxis" | "High" | "Low" | "None"

Remarks

[Api set: ExcelApi 1.7]

tickLabelSpacing

Specifies the number of categories or series between tick-mark labels. Can be a value from 1 through 31999 or an empty string for automatic setting. The returned value is always a number.

tickLabelSpacing: any;

Property Value

any

Remarks

[Api set: ExcelApi 1.7]

tickMarkSpacing

Specifies the number of categories or series between tick marks.

tickMarkSpacing: number;

Property Value

number

Remarks

[Api set: ExcelApi 1.7]

title

Represents the axis title.

readonly title: Excel.ChartAxisTitle;

Property Value

Excel.ChartAxisTitle

Remarks

[Api set: ExcelApi 1.1]

top

Specifies the distance, in points, from the top edge of the axis to the top of chart area. Returns null if the axis is not visible.

readonly top: number;

Property Value

number

Remarks

[Api set: ExcelApi 1.7]

type

Specifies the axis type. See Excel.ChartAxisType for details.

readonly type: Excel.ChartAxisType | "Invalid" | "Category" | "Value" | "Series";

Property Value

Excel.ChartAxisType | "Invalid" | "Category" | "Value" | "Series"

Remarks

[Api set: ExcelApi 1.7]

visible

Specifies if the axis is visible.

visible: boolean;

Property Value

boolean

Remarks

[Api set: ExcelApi 1.7]

width

Specifies the width, in points, of the chart axis. Returns null if the axis is not visible.

readonly width: number;

Property Value

number

Remarks

[Api set: ExcelApi 1.7]

Method Details

load(options)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(options?: Excel.Interfaces.ChartAxisLoadOptions): Excel.ChartAxis;

Parameters

options

Excel.Interfaces.ChartAxisLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.ChartAxis

load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): Excel.ChartAxis;

Parameters

propertyNames

string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

Excel.ChartAxis

load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.ChartAxis;

Parameters

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

Returns

Excel.ChartAxis

set(properties, options)

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties: Interfaces.ChartAxisUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

properties

Excel.Interfaces.ChartAxisUpdateData

A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options

OfficeExtension.UpdateOptions

Provides an option to suppress errors if the properties object tries to set any read-only properties.

Returns

void

set(properties)

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.ChartAxis): void;

Parameters

properties

Excel.ChartAxis

Returns

void

setCategoryNames(sourceData)

Sets all the category names for the specified axis.

setCategoryNames(sourceData: Range): void;

Parameters

sourceData

Excel.Range

The Range object corresponding to the source data.

Returns

void

Remarks

[Api set: ExcelApi 1.7]

setCustomDisplayUnit(value)

Sets the axis display unit to a custom value.

setCustomDisplayUnit(value: number): void;

Parameters

value

number

Custom value of the display unit.

Returns

void

Remarks

[Api set: ExcelApi 1.7]

setPositionAt(value)

Sets the specified axis position where the other axis crosses.

setPositionAt(value: number): void;

Parameters

value

number

Custom value of the crossing point.

Returns

void

Remarks

[Api set: ExcelApi 1.8]

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Excel.ChartAxis object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ChartAxisData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.ChartAxisData;

Returns

Excel.Interfaces.ChartAxisData