Skip to content

Class: ChartAxis ​

One axis (c:catAx/c:valAx/c:dateAx/c:serAx) of a chart's plot area. All four share the scaling/delete/position/tickmark structure; kind distinguishes them.

Constructors ​

Constructor ​

new ChartAxis(ax, part): ChartAxis

Parameters ​

ParameterTypeDescription
axElement-
partPartThe owning chart's OPC part, so markDirty can reach it from element_.

Returns ​

ChartAxis

Accessors ​

element_ ​

Get Signature ​

get element_(): Element

Escape hatch: the underlying axis element. After mutating it call markDirty, or save() writes the original bytes.

Returns ​

Element


hidden ​

Get Signature ​

get hidden(): boolean

Whether the axis is hidden (c:delete/@val = 1).

Returns ​

boolean


id ​

Get Signature ​

get id(): number | null

Axis id (c:axId/@val).

Returns ​

number | null


kind ​

Get Signature ​

get kind(): "val" | "cat" | "date" | "ser" | null

Axis kind derived from the element name: cat/val/date/ser.

Returns ​

"val" | "cat" | "date" | "ser" | null


logBase ​

Get Signature ​

get logBase(): number | null

Logarithmic scale base (c:scaling/c:logBase/@val), or null when linear.

Returns ​

number | null


majorGridlines ​

Get Signature ​

get majorGridlines(): boolean

Whether the axis draws major gridlines (c:majorGridlines).

Returns ​

boolean


majorTickMark ​

Get Signature ​

get majorTickMark(): string | null

Major tick-mark style (c:majorTickMark/@val): out/in/cross/none.

Returns ​

string | null


majorUnit ​

Get Signature ​

get majorUnit(): number | null

Major unit (c:majorUnit/@val), or null when auto.

Returns ​

number | null


max ​

Get Signature ​

get max(): number | null

Scale maximum (c:scaling/c:max/@val), or null when auto.

Returns ​

number | null


min ​

Get Signature ​

get min(): number | null

Scale minimum (c:scaling/c:min/@val), or null when auto.

Returns ​

number | null


minorGridlines ​

Get Signature ​

get minorGridlines(): boolean

Whether the axis draws minor gridlines (c:minorGridlines).

Returns ​

boolean


minorTickMark ​

Get Signature ​

get minorTickMark(): string | null

Minor tick-mark style (c:minorTickMark/@val).

Returns ​

string | null


minorUnit ​

Get Signature ​

get minorUnit(): number | null

Minor unit (c:minorUnit/@val), or null when auto.

Returns ​

number | null


numberFormat ​

Get Signature ​

get numberFormat(): AxisNumberFormat | null

Axis number format (c:numFmt), or null when absent.

Returns ​

AxisNumberFormat | null


orientation ​

Get Signature ​

get orientation(): string | null

Scaling orientation (c:scaling/c:orientation/@val): minMax/maxMin.

Returns ​

string | null


position ​

Get Signature ​

get position(): string | null

Axis position (c:axPos/@val): b/l/r/t.

Returns ​

string | null


tickLabelPosition ​

Get Signature ​

get tickLabelPosition(): string | null

Tick-label position (c:tickLblPos/@val): nextTo/high/low/none.

Returns ​

string | null


title ​

Get Signature ​

get title(): string | null

Axis title text (c:title rich text), or null when absent.

Returns ​

string | null

Methods ​

markDirty() ​

markDirty(): void

Mark the owning chart part dirty so save() reserializes it. Call after mutating element_.

Returns ​

void