ts-pptx

Appearance

Interface: ChartPropsAxisVal ​

Extended by ​

Properties ​

secondaryValAxis? ​

optional secondaryValAxis?: boolean

Whether data should use secondary value axis (instead of primary)

A combo subchart plots on the secondary category and value axes together, because a plot's two axes have to cross each other. When no subchart sets secondaryCatAxis, the secondary category axis is written hidden, as PowerPoint does for a series moved to its secondary axis; catAxes[1] can show it.

Default ​

ts
false

showValAxisTitle? ​

optional showValAxisTitle?: boolean

valAxes? ​

optional valAxes?: ChartPropsAxisVal[]

Multi-Chart prop: array of val axes

valAxisCrossBetween? ​

optional valAxisCrossBetween?: "between" | "midCat"

Controls where axis values are plotted relative to tick marks

  • 'between' = values plotted between tick marks (default for bar/column/line)
  • 'midCat' = values plotted on tick marks (default for scatter/area)
  • PowerPoint: Format Axis > Axis Options > Axis crosses > On tick marks / Between tick marks

valAxisCrossesAt? ​

optional valAxisCrossesAt?: number | "autoZero"

valAxisDisplayUnit? ​

optional valAxisDisplayUnit?: "hundreds" | "thousands" | "tenThousands" | "hundredThousands" | "millions" | "tenMillions" | "hundredMillions" | "billions" | "trillions"

valAxisDisplayUnitLabel? ​

optional valAxisDisplayUnitLabel?: boolean

valAxisHidden? ​

optional valAxisHidden?: boolean

valAxisLabelColor? ​

optional valAxisLabelColor?: string

valAxisLabelFontBold? ​

optional valAxisLabelFontBold?: boolean

valAxisLabelFontFace? ​

optional valAxisLabelFontFace?: string

valAxisLabelFontItalic? ​

optional valAxisLabelFontItalic?: boolean

valAxisLabelFontSize? ​

optional valAxisLabelFontSize?: number

valAxisLabelFormatCode? ​

optional valAxisLabelFormatCode?: string

valAxisLabelPos? ​

optional valAxisLabelPos?: "none" | "high" | "low" | "nextTo"

valAxisLabelRotate? ​

optional valAxisLabelRotate?: number

valAxisLine? ​

optional valAxisLine?: StrokeProps

The value axis line, as a stroke — the same StrokeProps the other two axes and every gridline take. See ChartPropsAxisCat.catAxisLine.

valAxisLineColor? ​

optional valAxisLineColor?: string

Value-axis line colour.

Deprecated ​

Use valAxisLine.color.

valAxisLineShow? ​

optional valAxisLineShow?: boolean

Draw the value-axis line at all.

Deprecated ​

Use valAxisLine.type: 'none' to suppress it.

Default ​

ts
true

valAxisLineSize? ​

optional valAxisLineSize?: number

Value-axis line width in points.

Deprecated ​

Use valAxisLine.width.

valAxisLineStyle? ​

optional valAxisLineStyle?: "dash" | "solid" | "dot"

Value-axis line dash.

Deprecated ​

Use valAxisLine.dashType, which takes the full ST_PresetLineDashVal set.

valAxisLogScaleBase? ​

optional valAxisLogScaleBase?: number

PowerPoint: Format Axis > Axis Options > Logarithmic scale - Base

  • range: 2-1000 (ST_LogBase); a value outside it clamps with a warning, and NaN throws

valAxisMajorTickMark? ​

optional valAxisMajorTickMark?: "none" | "cross" | "in" | "out"

valAxisMajorUnit? ​

optional valAxisMajorUnit?: number

Spacing between major tick marks on the value axis (c:majorUnit, ST_AxisUnit).

  • above 0; anything else warns and leaves the element off
  • PowerPoint: Format Axis > Axis Options > Units > Major

valAxisMaxVal? ​

optional valAxisMaxVal?: number

Axis maximum (c:max). A value that is not a finite number throws.

valAxisMinorTickMark? ​

optional valAxisMinorTickMark?: "none" | "cross" | "in" | "out"

valAxisMinorUnit? ​

optional valAxisMinorUnit?: number

Spacing between minor tick marks on the value axis (c:minorUnit) — the sibling valAxisMajorUnit had had for years, while the category and series axes carried both.

  • PowerPoint: Format Axis > Axis Options > Units > Minor

valAxisMinVal? ​

optional valAxisMinVal?: number

Axis minimum (c:min). A value that is not a finite number throws.

valAxisOrientation? ​

optional valAxisOrientation?: "maxMin" | "minMax"

valAxisTitle? ​

optional valAxisTitle?: string

valAxisTitleColor? ​

optional valAxisTitleColor?: string

valAxisTitleFontFace? ​

optional valAxisTitleFontFace?: string

valAxisTitleFontSize? ​

optional valAxisTitleFontSize?: number

valAxisTitleRotate? ​

optional valAxisTitleRotate?: number

valGridLine? ​

optional valGridLine?: OptsChartGridLine

valLabelFormatCode? ​

optional valLabelFormatCode?: string

Value label format code

  • this also directs Data Table formatting

Examples ​

ts
'#%' // round percent
ts
'0.00%' // shows values as '0.00%'
ts
'$0.00' // shows values as '$0.00'