Edit

Share via


Excel.Interfaces.ChartAxisUpdateData interface

An interface for updating data on the ChartAxis object, for use in chartAxis.set({ ... }).

Properties

alignment

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

baseTimeUnit

Specifies the base unit for the specified category axis.

categoryType

Specifies the category axis type.

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.

isBetweenCategories

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

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.

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.

visible

Specifies if the axis is visible.

Property Details

alignment

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

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

Property Value

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

Remarks

[ API set: ExcelApi 1.8 ]

baseTimeUnit

Specifies the base unit for the specified category axis.

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

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

Property Value

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

Remarks

[ API set: ExcelApi 1.7 ]

displayUnit

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

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

TypeScript
format?: Excel.Interfaces.ChartAxisFormatUpdateData;

Property Value

Remarks

[ API set: ExcelApi 1.1 ]

isBetweenCategories

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

TypeScript
isBetweenCategories?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

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.

TypeScript
linkNumberFormat?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

logBase

Specifies the base of the logarithm when using logarithmic scales.

TypeScript
logBase?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.7 ]

majorGridlines

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

TypeScript
majorGridlines?: Excel.Interfaces.ChartGridlinesUpdateData;

Property Value

Remarks

[ API set: ExcelApi 1.1 ]

majorTickMark

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

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

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

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

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

TypeScript
minimum?: any;

Property Value

any

Remarks

[ API set: ExcelApi 1.1 ]

minorGridlines

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

TypeScript
minorGridlines?: Excel.Interfaces.ChartGridlinesUpdateData;

Property Value

Remarks

[ API set: ExcelApi 1.1 ]

minorTickMark

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

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

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

TypeScript
minorUnit?: any;

Property Value

any

Remarks

[ API set: ExcelApi 1.1 ]

multiLevel

Specifies if an axis is multilevel.

TypeScript
multiLevel?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

numberFormat

Specifies the format code for the axis tick label.

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

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

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

Property Value

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

Remarks

[ API set: ExcelApi 1.8 ]

reversePlotOrder

Specifies if Excel plots data points from last to first.

TypeScript
reversePlotOrder?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

scaleType

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

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

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

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

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

TypeScript
tickLabelSpacing?: any;

Property Value

any

Remarks

[ API set: ExcelApi 1.7 ]

tickMarkSpacing

Specifies the number of categories or series between tick marks.

TypeScript
tickMarkSpacing?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.7 ]

title

Represents the axis title.

TypeScript
title?: Excel.Interfaces.ChartAxisTitleUpdateData;

Property Value

Remarks

[ API set: ExcelApi 1.1 ]

visible

Specifies if the axis is visible.

TypeScript
visible?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]