Excel.Interfaces.ChartAxisLoadOptions interface

Reference

Package:: excel

Represents a single axis in a chart.

Remarks

Properties

$all	Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
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.
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.
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.
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.
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.
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.

Property Details

$all

Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).

$all?: boolean;

Property Value

boolean

axisGroup

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

axisGroup?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

baseTimeUnit

Specifies the base unit for the specified category axis.

baseTimeUnit?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

categoryType

Specifies the category axis type.

categoryType?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

customDisplayUnit

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

customDisplayUnit?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

displayUnit

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

displayUnit?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

format

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

format?: Excel.Interfaces.ChartAxisFormatLoadOptions;

Property Value

Excel.Interfaces.ChartAxisFormatLoadOptions

Remarks

[ API set: ExcelApi 1.1 ]

height

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

height?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

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?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

logBase

Specifies the base of the logarithm when using logarithmic scales.

logBase?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

majorGridlines

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

majorGridlines?: Excel.Interfaces.ChartGridlinesLoadOptions;

Property Value

Excel.Interfaces.ChartGridlinesLoadOptions

Remarks

[ API set: ExcelApi 1.1 ]

majorTickMark

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

majorTickMark?: boolean;

Property Value

boolean

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?: boolean;

Property Value

boolean

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?: boolean;

Property Value

boolean

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?: boolean;

Property Value

boolean

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?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

minorGridlines

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

minorGridlines?: Excel.Interfaces.ChartGridlinesLoadOptions;

Property Value

Excel.Interfaces.ChartGridlinesLoadOptions

Remarks

[ API set: ExcelApi 1.1 ]

minorTickMark

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

minorTickMark?: boolean;

Property Value

boolean

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?: boolean;

Property Value

boolean

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?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

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?: boolean;

Property Value

boolean

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 ]

tickLabelPosition

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

tickLabelPosition?: boolean;

Property Value

boolean

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?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

tickMarkSpacing

Specifies the number of categories or series between tick marks.

tickMarkSpacing?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

title

Represents the axis title.

title?: Excel.Interfaces.ChartAxisTitleLoadOptions;

Property Value

Excel.Interfaces.ChartAxisTitleLoadOptions

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.

top?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

type

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

type?: boolean;

Property Value

boolean

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.

width?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]