ExcelScript.ChartAxis interface

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

getAlignment(): ChartTickLabelAlignment;

Returns

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

getAxisGroup(): ChartAxisGroup;

Returns

Specifies the base unit for the specified category axis.

getBaseTimeUnit(): ChartAxisTimeUnit;

Returns

Specifies the category axis type.

getCategoryType(): ChartAxisCategoryType;

Returns

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

getCustomDisplayUnit(): number;

Returns

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

getDisplayUnit(): ChartAxisDisplayUnit;

Returns

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

getFormat(): ChartAxisFormat;

Returns

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

getHeight(): number;

Returns

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

getIsBetweenCategories(): boolean;

Returns

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.

getLeft(): number;

Returns

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.

getLinkNumberFormat(): boolean;

Returns

Specifies the base of the logarithm when using logarithmic scales.

getLogBase(): number;

Returns

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

getMajorGridlines(): ChartGridlines;

Returns

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

getMajorTickMark(): ChartAxisTickMark;

Returns

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

getMajorTimeUnitScale(): ChartAxisTimeUnit;

Returns

Specifies the interval between two major tick marks.

getMajorUnit(): number;

Returns

Specifies the maximum value on the value axis.

getMaximum(): number;

Returns

Specifies the minimum value on the value axis.

getMinimum(): number;

Returns

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

getMinorGridlines(): ChartGridlines;

Returns

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

getMinorTickMark(): ChartAxisTickMark;

Returns

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

getMinorTimeUnitScale(): ChartAxisTimeUnit;

Returns

Specifies the interval between two minor tick marks.

getMinorUnit(): number;

Returns

Specifies if an axis is multilevel.

getMultiLevel(): boolean;

Returns

Specifies the format code for the axis tick label.

getNumberFormat(): string;

Returns

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.

getOffset(): number;

Returns

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

getPosition(): ChartAxisPosition;

Returns

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

getPositionAt(): number;

Returns

Specifies if Excel plots data points from last to first.

getReversePlotOrder(): boolean;

Returns

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

getScaleType(): ChartAxisScaleType;

Returns

Specifies if the axis display unit label is visible.

getShowDisplayUnitLabel(): boolean;

Returns

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.

getTextOrientation(): number;

Returns

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

getTickLabelPosition(): ChartAxisTickLabelPosition;

Returns

Specifies the number of categories or series between tick-mark labels. Can be a value from 1 through 31999.

getTickLabelSpacing(): number;

Returns

Specifies the number of categories or series between tick marks.

getTickMarkSpacing(): number;

Returns

Represents the axis title.

getTitle(): ChartAxisTitle;

Returns

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.

getTop(): number;

Returns

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

getType(): ChartAxisType;

Returns

Specifies if the axis is visible.

getVisible(): boolean;

Returns

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

getWidth(): number;

Returns

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

setAlignment(alignment: ChartTickLabelAlignment): void;

Parameters

Returns

Specifies the base unit for the specified category axis.

setBaseTimeUnit(baseTimeUnit: ChartAxisTimeUnit): void;

Parameters

Returns

Sets all the category names for the specified axis.

setCategoryNames(sourceData: Range): void;

Parameters

Returns

Specifies the category axis type.

setCategoryType(categoryType: ChartAxisCategoryType): void;

Parameters

Returns

Sets the axis display unit to a custom value.

setCustomDisplayUnit(value: number): void;

Parameters

Returns

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

setDisplayUnit(displayUnit: ChartAxisDisplayUnit): void;

Parameters

Returns

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

setIsBetweenCategories(isBetweenCategories: boolean): void;

Parameters

Returns

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.

setLinkNumberFormat(linkNumberFormat: boolean): void;

Parameters

Returns

Specifies the base of the logarithm when using logarithmic scales.

setLogBase(logBase: number): void;

Parameters

Returns

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

setMajorTickMark(majorTickMark: ChartAxisTickMark): void;

Parameters

Returns

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

setMajorTimeUnitScale(majorTimeUnitScale: ChartAxisTimeUnit): void;

Parameters

Returns

Specifies the interval between two major tick marks.

setMajorUnit(majorUnit: number): void;

Parameters

Returns

Specifies the maximum value on the value axis.

setMaximum(maximum: number): void;

Parameters

Returns

Specifies the minimum value on the value axis.

setMinimum(minimum: number): void;

Parameters

Returns

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

setMinorTickMark(minorTickMark: ChartAxisTickMark): void;

Parameters

Returns

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

setMinorTimeUnitScale(minorTimeUnitScale: ChartAxisTimeUnit): void;

Parameters

Returns

Specifies the interval between two minor tick marks.

setMinorUnit(minorUnit: number): void;

Parameters

Returns

Specifies if an axis is multilevel.

setMultiLevel(multiLevel: boolean): void;

Parameters

Returns

Specifies the format code for the axis tick label.

setNumberFormat(numberFormat: string): void;

Parameters

Returns

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.

setOffset(offset: number): void;

Parameters

Returns

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

setPosition(position: ChartAxisPosition): void;

Parameters

Returns

Sets the specified axis position where the other axis crosses.

setPositionAt(value: number): void;

Parameters

Returns

Specifies if Excel plots data points from last to first.

setReversePlotOrder(reversePlotOrder: boolean): void;

Parameters

Returns

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

setScaleType(scaleType: ChartAxisScaleType): void;

Parameters

Returns

Specifies if the axis display unit label is visible.

setShowDisplayUnitLabel(showDisplayUnitLabel: boolean): void;

Parameters

Returns

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.

setTextOrientation(textOrientation: number): void;

Parameters

Returns

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

setTickLabelPosition(
            tickLabelPosition: ChartAxisTickLabelPosition
        ): void;

Parameters

Returns

Specifies the number of categories or series between tick-mark labels. Can be a value from 1 through 31999.

setTickLabelSpacing(tickLabelSpacing: number): void;

Parameters

Returns

Specifies the number of categories or series between tick marks.

setTickMarkSpacing(tickMarkSpacing: number): void;

Parameters

Returns

Specifies if the axis is visible.

setVisible(visible: boolean): void;

Parameters

Returns