Represents a single axis in a chart.

Constructors

Section titled "Constructors"

Axis 

new Axis(a: IChartObject, b: AxisType, c: AxisGroup): Axis

Returns Axis

Properties

Section titled "Properties"

$t

Section titled "$t" 
$t: Type

Accessors

Section titled "Accessors"

axisBetweenCategories

Section titled "axisBetweenCategories"

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

 
get axisBetweenCategories(): boolean

Returns boolean 

set axisBetweenCategories(a: boolean): void

Parameters

  • a: boolean

Returns void

axisGroup

Section titled "axisGroup"

Returns the group for the specified axis. Read-only

 
get axisGroup(): AxisGroup

Returns AxisGroup

axisTitle

Section titled "axisTitle"

Returns or sets a [[ChartTitle]] object that represents the title of the axis.

 
get axisTitle(): ChartTitle

Returns ChartTitle 

set axisTitle(a: ChartTitle): void

Parameters

Returns void

baseUnit

Section titled "baseUnit"

Returns or sets the base unit for the axis. Setting this property has no visible effect if the [[categoryType]] property for the specified axis is set to 'CategoryScale'. The set value is retained, however, and takes effect when the CategoryType property is set to 'TimeScale'. 

get baseUnit(): TimeUnit

Returns TimeUnit 

set baseUnit(a: TimeUnit): void

Parameters

Returns void

baseUnitIsAuto

Section titled "baseUnitIsAuto"

True if Excel chooses appropriate base units for the specified category axis. The default value is True.

 
get baseUnitIsAuto(): boolean

Returns boolean 

set baseUnitIsAuto(a: boolean): void

Parameters

  • a: boolean

Returns void

categoryType

Section titled "categoryType"

Returns or sets the category axis type.

 
get categoryType(): CategoryType

Returns CategoryType 

set categoryType(a: CategoryType): void

Parameters

Returns void

chart

Section titled "chart"

Inherited from: ChartObject

Returns the owning chart (read-only)

 
get chart(): WorksheetChart

Returns WorksheetChart

crosses

Section titled "crosses"

Returns or sets the point on the specified axis where the other axis crosses.

 
get crosses(): AxisCrosses

Returns AxisCrosses 

set crosses(a: AxisCrosses): void

Parameters

Returns void

crossesAt

Section titled "crossesAt"

Returns or sets the point on the [[Axis]] at which the perpendicular axis intersects it.

 
get crossesAt(): number

Returns number 

set crossesAt(a: number): void

Parameters

  • a: number

Returns void

displayUnit

Section titled "displayUnit"

Returns or sets the unit label for the value axis.

 
get displayUnit(): DisplayUnit

Returns DisplayUnit 

set displayUnit(a: DisplayUnit): void

Parameters

Returns void

displayUnitCustom

Section titled "displayUnitCustom"

If the value of the DisplayUnit property 'Custom' , the DisplayUnitCustom property returns or sets the value of the displayed units. The value must be from 0 through 10E307

 
get displayUnitCustom(): number

Returns number 

set displayUnitCustom(a: number): void

Parameters

  • a: number

Returns void

displayUnitLabel

Section titled "displayUnitLabel"

Returns or sets an [[displayUnitLabel]] object.

 
get displayUnitLabel(): DisplayUnitLabel

Returns DisplayUnitLabel 

set displayUnitLabel(a: DisplayUnitLabel): void

Parameters

Returns void

gapWidth

Section titled "gapWidth"

Returns or sets a value indicating the width of the gaps between data points or series, expressed as a percentage.

 
get gapWidth(): number | null

Returns number | null 

set gapWidth(a: number | null): void

Parameters

  • a: number | null

Returns void

logBase

Section titled "logBase"

Returns or sets the base of the logarithm when you are using log scales. Attempting to set this property to a value less than 2 causes an error. The default value is 10. 

get logBase(): number

Returns number 

set logBase(a: number): void

Parameters

  • a: number

Returns void

majorGridLines

Section titled "majorGridLines"

Returns a [[ChartGridLines]] object which defines the color and weight of the major ticklines.

 
get majorGridLines(): ChartGridLines

Returns ChartGridLines 

set majorGridLines(a: ChartGridLines): void

Parameters

Returns void

majorTickMark

Section titled "majorTickMark"

Returns or sets the type of major tick mark for the specified axis.

 
get majorTickMark(): TickMark

Returns TickMark 

set majorTickMark(a: TickMark): void

Parameters

Returns void

majorUnit

Section titled "majorUnit"

Returns the major interval unit.

 
get majorUnit(): number

Returns number 

set majorUnit(a: number): void

Parameters

  • a: number

Returns void

majorUnitIsAuto

Section titled "majorUnitIsAuto"

True if Excel calculates the major units for the value axis.

 
get majorUnitIsAuto(): boolean

Returns boolean 

set majorUnitIsAuto(a: boolean): void

Parameters

  • a: boolean

Returns void

majorUnitScale

Section titled "majorUnitScale"

Returns or sets the major unit scale value for the category axis when the [[categoryType]] property is set to 'TimeScale'.

 
get majorUnitScale(): TimeUnit

Returns TimeUnit 

set majorUnitScale(a: TimeUnit): void

Parameters

Returns void

maximumScale

Section titled "maximumScale"

Returns or sets the maximum value on the value axis.

 
get maximumScale(): number

Returns number 

set maximumScale(a: number): void

Parameters

  • a: number

Returns void

maximumScaleIsAuto

Section titled "maximumScaleIsAuto"

True if Excel calculates the maximum value for the value axis.

 
get maximumScaleIsAuto(): boolean

Returns boolean 

set maximumScaleIsAuto(a: boolean): void

Parameters

  • a: boolean

Returns void

minimumScale

Section titled "minimumScale"

Returns or sets the minimum value on the value axis.

 
get minimumScale(): number

Returns number 

set minimumScale(a: number): void

Parameters

  • a: number

Returns void

minimumScaleIsAuto

Section titled "minimumScaleIsAuto"

True if Excel calculates the minimum value for the value axis.

 
get minimumScaleIsAuto(): boolean

Returns boolean 

set minimumScaleIsAuto(a: boolean): void

Parameters

  • a: boolean

Returns void

minorGridLines

Section titled "minorGridLines"

Returns a [[ChartGridLines]] object which defines the color and weight of the minor ticklines.

 
get minorGridLines(): ChartGridLines

Returns ChartGridLines 

set minorGridLines(a: ChartGridLines): void

Parameters

Returns void

minorTickMark

Section titled "minorTickMark"

Returns or sets the type of minor tick mark for the specified axis.

 
get minorTickMark(): TickMark

Returns TickMark 

set minorTickMark(a: TickMark): void

Parameters

Returns void

minorUnit

Section titled "minorUnit"

Returns the minor interval unit.

 
get minorUnit(): number

Returns number 

set minorUnit(a: number): void

Parameters

  • a: number

Returns void

minorUnitIsAuto

Section titled "minorUnitIsAuto"

True if Excel calculates the minor units for the value axis.

 
get minorUnitIsAuto(): boolean

Returns boolean 

set minorUnitIsAuto(a: boolean): void

Parameters

  • a: boolean

Returns void

minorUnitScale

Section titled "minorUnitScale"

Returns or sets the minor unit scale value for the category axis when the [[categoryType]] property is set to 'TimeScale'.

 
get minorUnitScale(): TimeUnit

Returns TimeUnit 

set minorUnitScale(a: TimeUnit): void

Parameters

Returns void

owner

Section titled "owner"

Inherited from: ChartObject

returns this object's owner. (read-only) The owner or null if this object is owned directly by the Chart

 
get owner(): ChartObject

Returns ChartObject

position

Section titled "position"

Returns or sets an [[AxisPosition]] value which determines the placement of the axis as relative to the chart space.

 
get position(): AxisPosition

Returns AxisPosition 

set position(a: AxisPosition): void

Parameters

Returns void

reversePlotOrder

Section titled "reversePlotOrder"

True if Excel plots data points from last to first.

 
get reversePlotOrder(): boolean

Returns boolean 

set reversePlotOrder(a: boolean): void

Parameters

  • a: boolean

Returns void

scaleType

Section titled "scaleType"

Returns or sets a value indicating whether the axis scale is linear or logarithmic.

 
get scaleType(): ScaleType

Returns ScaleType 

set scaleType(a: ScaleType): void

Parameters

Returns void

sheet

Section titled "sheet"

Inherited from: ChartObject

The owning sheet (read-only)

 
get sheet(): Sheet

Returns Sheet

tickLabelPosition

Section titled "tickLabelPosition"

Describes the position of tick-mark labels on the specified axis.

 
get tickLabelPosition(): TickLabelPosition

Returns TickLabelPosition 

set tickLabelPosition(a: TickLabelPosition): void

Parameters

Returns void

tickLabels

Section titled "tickLabels"

Returns a TickLabels object that represents the tick-mark labels for the specified axis. Read-only.

 
get tickLabels(): TickLabels

Returns TickLabels

tickLabelSpacing

Section titled "tickLabelSpacing"

Returns or sets the number of categories or series between tick-mark labels. Applies only to category and series axes. Can be a value from 1 through 31999.

 
get tickLabelSpacing(): number

Returns number 

set tickLabelSpacing(a: number): void

Parameters

  • a: number

Returns void

tickLabelSpacingIsAuto

Section titled "tickLabelSpacingIsAuto"

Returns or sets whether or not the tick label spacing is automatic.

 
get tickLabelSpacingIsAuto(): boolean

Returns boolean 

set tickLabelSpacingIsAuto(a: boolean): void

Parameters

  • a: boolean

Returns void

tickLines

Section titled "tickLines"

Determines the appearance of the tick lines.

 
get tickLines(): ChartTickLines

Returns ChartTickLines 

set tickLines(a: ChartTickLines): void

Parameters

Returns void

tickMarkSpacing

Section titled "tickMarkSpacing"

Returns or sets the number of categories or series between tick marks. Applies only to category and series axes. Can be a value from 1 through 31999.

 
get tickMarkSpacing(): number

Returns number 

set tickMarkSpacing(a: number): void

Parameters

  • a: number

Returns void

type

Section titled "type"

Returns the type of the axis (read-only)

 
get type(): AxisType

Returns AxisType

visible

Section titled "visible"

Returns or sets whether or not the axis is visible.

 
get visible(): boolean

Returns boolean 

set visible(a: boolean): void

Parameters

  • a: boolean

Returns void

workbook

Section titled "workbook"

Inherited from: ChartObject

The owning workbook (read-only)

 
get workbook(): Workbook

Returns Workbook

worksheet

Section titled "worksheet"

Inherited from: ChartObject

The owning worksheet (read-only)

 
get worksheet(): Worksheet

Returns Worksheet

Methods

Section titled "Methods"

setMajorMinorUnit

Section titled "setMajorMinorUnit"

Sets the values of the [[majorUnit]] and [[minorUnit]] properties.

 
setMajorMinorUnit(majorUnit: number, minorUnit: number): void

Parameters

  • majorUnit: number

    The new value for the [[majorUnit]] property.
  • minorUnit: number

    The new value for the [[minorUnit]] property.

Returns void