Excel.Interfaces.ChartAxisData interface
An interface describing the data returned by calling chartAxis.toJSON().
Properties
| alignment | Specifies the alignment for the specified axis tick label. See |
| axis |
Specifies the group for the specified axis. See |
| base |
Specifies the base unit for the specified category axis. |
| category |
Specifies the category axis type. |
| custom |
Specifies the custom axis display unit value. To set this property, please use the |
| display |
Represents the axis display unit. See |
| 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 |
| is |
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 |
| log |
Specifies the base of the logarithm when using logarithmic scales. |
| major |
Returns an object that represents the major gridlines for the specified axis. |
| major |
Specifies the type of major tick mark for the specified axis. See |
| major |
Specifies the major unit scale value for the category axis when the |
| major |
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. |
| minor |
Returns an object that represents the minor gridlines for the specified axis. |
| minor |
Specifies the type of minor tick mark for the specified axis. See |
| minor |
Specifies the minor unit scale value for the category axis when the |
| minor |
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. |
| multi |
Specifies if an axis is multilevel. |
| number |
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 |
| position |
Specifies the axis position where the other axis crosses. You should use the |
| reverse |
Specifies if Excel plots data points from last to first. |
| scale |
Specifies the value axis scale type. See |
| show |
Specifies if the axis display unit label is visible. |
| text |
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. |
| tick |
Specifies the position of tick-mark labels on the specified axis. See |
| tick |
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. |
| tick |
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 |
| type | Specifies the axis type. See |
| visible | Specifies if the axis is visible. |
| width | Specifies the width, in points, of the chart axis. Returns |
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
axisGroup
Specifies the group for the specified axis. See Excel.ChartAxisGroup for details.
axisGroup?: Excel.ChartAxisGroup | "Primary" | "Secondary";Property Value
Excel.ChartAxisGroup | "Primary" | "Secondary"
Remarks
baseTimeUnit
Specifies the base unit for the specified category axis.
baseTimeUnit?: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years";Property Value
Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years"
Remarks
categoryType
Specifies the category axis type.
categoryType?: Excel.ChartAxisCategoryType | "Automatic" | "TextAxis" | "DateAxis";Property Value
Excel.ChartAxisCategoryType | "Automatic" | "TextAxis" | "DateAxis"
Remarks
customDisplayUnit
Specifies the custom axis display unit value. To set this property, please use the SetCustomDisplayUnit(double) method.
customDisplayUnit?: number;Property Value
number
Remarks
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
format
Represents the formatting of a chart object, which includes line and font formatting.
format?: Excel.Interfaces.ChartAxisFormatData;Property Value
Remarks
height
Specifies the height, in points, of the chart axis. Returns null if the axis is not visible.
height?: number;Property Value
number
Remarks
isBetweenCategories
Specifies if the value axis crosses the category axis between categories.
isBetweenCategories?: boolean;Property Value
boolean
Remarks
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.
left?: number;Property Value
number
Remarks
logBase
Specifies the base of the logarithm when using logarithmic scales.
logBase?: number;Property Value
number
Remarks
majorGridlines
Returns an object that represents the major gridlines for the specified axis.
majorGridlines?: Excel.Interfaces.ChartGridlinesData;Property Value
Remarks
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
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
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
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
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
minorGridlines
Returns an object that represents the minor gridlines for the specified axis.
minorGridlines?: Excel.Interfaces.ChartGridlinesData;Property Value
Remarks
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
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
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
multiLevel
Specifies if an axis is multilevel.
multiLevel?: boolean;Property Value
boolean
Remarks
numberFormat
Specifies the format code for the axis tick label.
numberFormat?: string;Property Value
string
Remarks
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
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
positionAt
Specifies the axis position where the other axis crosses. You should use the SetPositionAt(double) method to set this property.
positionAt?: number;Property Value
number
Remarks
reversePlotOrder
Specifies if Excel plots data points from last to first.
reversePlotOrder?: boolean;Property Value
boolean
Remarks
scaleType
Specifies the value axis scale type. See Excel.ChartAxisScaleType for details.
scaleType?: Excel.ChartAxisScaleType | "Linear" | "Logarithmic";Property Value
Excel.ChartAxisScaleType | "Linear" | "Logarithmic"
Remarks
showDisplayUnitLabel
Specifies if the axis display unit label is visible.
showDisplayUnitLabel?: boolean;Property Value
boolean
Remarks
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
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
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
tickMarkSpacing
Specifies the number of categories or series between tick marks.
tickMarkSpacing?: number;Property Value
number
Remarks
title
Represents the axis title.
title?: Excel.Interfaces.ChartAxisTitleData;Property Value
Remarks
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.
top?: number;Property Value
number
Remarks
type
Specifies the axis type. See Excel.ChartAxisType for details.
type?: Excel.ChartAxisType | "Invalid" | "Category" | "Value" | "Series";Property Value
Excel.ChartAxisType | "Invalid" | "Category" | "Value" | "Series"
Remarks
visible
Specifies if the axis is visible.
visible?: boolean;Property Value
boolean
Remarks
width
Specifies the width, in points, of the chart axis. Returns null if the axis is not visible.
width?: number;Property Value
number
Remarks
Office Add-ins