Excel.Interfaces.ChartAxisData interface

An interface describing the data returned by calling "chartAxis.toJSON()".

Properties

alignment

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

[ API set: ExcelApi 1.8 ]

axisGroup

Represents the group for the specified axis. See Excel.ChartAxisGroup for details. Read-only.

[ API set: ExcelApi 1.7 ]

baseTimeUnit

Returns or sets the base unit for the specified category axis.

[ API set: ExcelApi 1.7 ]

categoryType

Returns or sets the category axis type.

[ API set: ExcelApi 1.7 ]

customDisplayUnit

Represents the custom axis display unit value. Read-only. To set this property, please use the SetCustomDisplayUnit(double) method.

[ API set: ExcelApi 1.7 ]

displayUnit

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

[ API set: ExcelApi 1.7 ]

format

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

[ API set: ExcelApi 1.1 ]

height

Represents the height, in points, of the chart axis. Null if the axis is not visible. Read-only.

[ API set: ExcelApi 1.7 ]

isBetweenCategories

Represents whether value axis crosses the category axis between categories.

[ API set: ExcelApi 1.8 ]

left

Represents the distance, in points, from the left edge of the axis to the left of chart area. Null if the axis is not visible. Read-only.

[ API set: ExcelApi 1.7 ]

linkNumberFormat

Represents whether or not the number format is linked to the cells. If true, the number format will change in the labels when it changes in the cells.

[ API set: ExcelApi 1.9 ]

logBase

Represents the base of the logarithm when using logarithmic scales.

[ API set: ExcelApi 1.7 ]

majorGridlines

Returns a Gridlines object that represents the major gridlines for the specified axis. Read-only.

[ API set: ExcelApi 1.1 ]

majorTickMark

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

[ API set: ExcelApi 1.7 ]

majorTimeUnitScale

Returns or sets the major unit scale value for the category axis when the CategoryType property is set to TimeScale.

[ 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.

[ 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.

[ 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.

[ API set: ExcelApi 1.1 ]

minorGridlines

Returns a Gridlines object that represents the minor gridlines for the specified axis. Read-only.

[ API set: ExcelApi 1.1 ]

minorTickMark

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

[ API set: ExcelApi 1.7 ]

minorTimeUnitScale

Returns or sets the minor unit scale value for the category axis when the CategoryType property is set to TimeScale.

[ 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.

[ API set: ExcelApi 1.1 ]

multiLevel

Represents whether an axis is multilevel or not.

[ API set: ExcelApi 1.8 ]

numberFormat

Represents the format code for the axis tick label.

[ API set: ExcelApi 1.8 ]

offset

Represents 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.

[ API set: ExcelApi 1.8 ]

position

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

[ API set: ExcelApi 1.8 ]

positionAt

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

[ API set: ExcelApi 1.8 ]

reversePlotOrder

Represents whether Microsoft Excel plots data points from last to first.

[ API set: ExcelApi 1.7 ]

scaleType

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

[ API set: ExcelApi 1.7 ]

showDisplayUnitLabel

Represents whether the axis display unit label is visible.

[ API set: ExcelApi 1.7 ]

textOrientation

Represents the text orientation of the axis tick label. The value should be an integer either from -90 to 90, or 180 for vertically-oriented text.

[ API set: ExcelApi 1.8 ]

tickLabelPosition

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

[ API set: ExcelApi 1.7 ]

tickLabelSpacing

Represents 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.

[ API set: ExcelApi 1.7 ]

tickMarkSpacing

Represents the number of categories or series between tick marks.

[ API set: ExcelApi 1.7 ]

title

Represents the axis title. Read-only.

[ API set: ExcelApi 1.1 ]

top

Represents the distance, in points, from the top edge of the axis to the top of chart area. Null if the axis is not visible. Read-only.

[ API set: ExcelApi 1.7 ]

type

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

[ API set: ExcelApi 1.7 ]

visible

A boolean value represents the visibility of the axis.

[ API set: ExcelApi 1.7 ]

width

Represents the width, in points, of the chart axis. Null if the axis is not visible. Read-only.

[ API set: ExcelApi 1.7 ]

Property Details

alignment

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

[ API set: ExcelApi 1.8 ]

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

Property Value

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

axisGroup

Represents the group for the specified axis. See Excel.ChartAxisGroup for details. Read-only.

[ API set: ExcelApi 1.7 ]

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

Property Value

Excel.ChartAxisGroup | "Primary" | "Secondary"

baseTimeUnit

Returns or sets the base unit for the specified category axis.

[ API set: ExcelApi 1.7 ]

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

Property Value

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

categoryType

Returns or sets the category axis type.

[ API set: ExcelApi 1.7 ]

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

Property Value

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

customDisplayUnit

Represents the custom axis display unit value. Read-only. To set this property, please use the SetCustomDisplayUnit(double) method.

[ API set: ExcelApi 1.7 ]

customDisplayUnit?: number;

Property Value

number

displayUnit

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

[ API set: ExcelApi 1.7 ]

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"

format

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

[ API set: ExcelApi 1.1 ]

format?: Excel.Interfaces.ChartAxisFormatData;

Property Value

height

Represents the height, in points, of the chart axis. Null if the axis is not visible. Read-only.

[ API set: ExcelApi 1.7 ]

height?: number;

Property Value

number

isBetweenCategories

Represents whether value axis crosses the category axis between categories.

[ API set: ExcelApi 1.8 ]

isBetweenCategories?: boolean;

Property Value

boolean

left

Represents the distance, in points, from the left edge of the axis to the left of chart area. Null if the axis is not visible. Read-only.

[ API set: ExcelApi 1.7 ]

left?: number;

Property Value

number

linkNumberFormat

Represents whether or not the number format is linked to the cells. If true, the number format will change in the labels when it changes in the cells.

[ API set: ExcelApi 1.9 ]

linkNumberFormat?: boolean;

Property Value

boolean

logBase

Represents the base of the logarithm when using logarithmic scales.

[ API set: ExcelApi 1.7 ]

logBase?: number;

Property Value

number

majorGridlines

Returns a Gridlines object that represents the major gridlines for the specified axis. Read-only.

[ API set: ExcelApi 1.1 ]

majorGridlines?: Excel.Interfaces.ChartGridlinesData;

Property Value

majorTickMark

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

[ API set: ExcelApi 1.7 ]

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

Property Value

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

majorTimeUnitScale

Returns or sets the major unit scale value for the category axis when the CategoryType property is set to TimeScale.

[ API set: ExcelApi 1.7 ]

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

Property Value

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

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.

[ API set: ExcelApi 1.1 ]

majorUnit?: any;

Property Value

any

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.

[ API set: ExcelApi 1.1 ]

maximum?: any;

Property Value

any

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.

[ API set: ExcelApi 1.1 ]

minimum?: any;

Property Value

any

minorGridlines

Returns a Gridlines object that represents the minor gridlines for the specified axis. Read-only.

[ API set: ExcelApi 1.1 ]

minorGridlines?: Excel.Interfaces.ChartGridlinesData;

Property Value

minorTickMark

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

[ API set: ExcelApi 1.7 ]

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

Property Value

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

minorTimeUnitScale

Returns or sets the minor unit scale value for the category axis when the CategoryType property is set to TimeScale.

[ API set: ExcelApi 1.7 ]

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

Property Value

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

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.

[ API set: ExcelApi 1.1 ]

minorUnit?: any;

Property Value

any

multiLevel

Represents whether an axis is multilevel or not.

[ API set: ExcelApi 1.8 ]

multiLevel?: boolean;

Property Value

boolean

numberFormat

Represents the format code for the axis tick label.

[ API set: ExcelApi 1.8 ]

numberFormat?: string;

Property Value

string

offset

Represents 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.

[ API set: ExcelApi 1.8 ]

offset?: number;

Property Value

number

position

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

[ API set: ExcelApi 1.8 ]

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

Property Value

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

positionAt

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

[ API set: ExcelApi 1.8 ]

positionAt?: number;

Property Value

number

reversePlotOrder

Represents whether Microsoft Excel plots data points from last to first.

[ API set: ExcelApi 1.7 ]

reversePlotOrder?: boolean;

Property Value

boolean

scaleType

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

[ API set: ExcelApi 1.7 ]

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

Property Value

Excel.ChartAxisScaleType | "Linear" | "Logarithmic"

showDisplayUnitLabel

Represents whether the axis display unit label is visible.

[ API set: ExcelApi 1.7 ]

showDisplayUnitLabel?: boolean;

Property Value

boolean

textOrientation

Represents the text orientation of the axis tick label. The value should be an integer either from -90 to 90, or 180 for vertically-oriented text.

[ API set: ExcelApi 1.8 ]

textOrientation?: any;

Property Value

any

tickLabelPosition

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

[ API set: ExcelApi 1.7 ]

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

Property Value

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

tickLabelSpacing

Represents 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.

[ API set: ExcelApi 1.7 ]

tickLabelSpacing?: any;

Property Value

any

tickMarkSpacing

Represents the number of categories or series between tick marks.

[ API set: ExcelApi 1.7 ]

tickMarkSpacing?: number;

Property Value

number

title

Represents the axis title. Read-only.

[ API set: ExcelApi 1.1 ]

title?: Excel.Interfaces.ChartAxisTitleData;

Property Value

top

Represents the distance, in points, from the top edge of the axis to the top of chart area. Null if the axis is not visible. Read-only.

[ API set: ExcelApi 1.7 ]

top?: number;

Property Value

number

type

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

[ API set: ExcelApi 1.7 ]

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

Property Value

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

visible

A boolean value represents the visibility of the axis.

[ API set: ExcelApi 1.7 ]

visible?: boolean;

Property Value

boolean

width

Represents the width, in points, of the chart axis. Null if the axis is not visible. Read-only.

[ API set: ExcelApi 1.7 ]

width?: number;

Property Value

number