ts-pptx

Appearance

Interface: ChartPropsAxisCat ​

Extended by ​

Properties ​

catAxes? ​

optional catAxes?: ChartPropsAxisCat[]

Multi-Chart prop: array of cat axes

catAxisBaseTimeUnit? ​

optional catAxisBaseTimeUnit?: "years" | "months" | "days"

The unit a date axis counts from in (c:baseTimeUnit/@val, ST_TimeUnit).

The canonical spelling is lower-case, and the check forgives case at run time, so 'Days' is taken as days. The type names the canonical three so the call site offers them; do not read the narrower type as permission to drop the tolerance, which a JavaScript caller with no types still relies on. Anything else warns chart/invalid-axis-time-unit and leaves the element off, because a garbage unit makes PowerPoint render nothing at all.

catAxisCrossesAt? ​

optional catAxisCrossesAt?: number | "autoZero"

catAxisHidden? ​

optional catAxisHidden?: boolean

catAxisLabelColor? ​

optional catAxisLabelColor?: string

catAxisLabelFontBold? ​

optional catAxisLabelFontBold?: boolean

catAxisLabelFontFace? ​

optional catAxisLabelFontFace?: string

catAxisLabelFontItalic? ​

optional catAxisLabelFontItalic?: boolean

catAxisLabelFontSize? ​

optional catAxisLabelFontSize?: number

catAxisLabelFormatCode? ​

optional catAxisLabelFormatCode?: string

Number format code for the category (X) axis labels on scatter and bubble charts. Falls back to valAxisLabelFormatCode when not set.

  • Example: '0.00', '#,##0', 'mmm yyyy'
  • PowerPoint: Format Axis > Number > Format Code

catAxisLabelFrequency? ​

optional catAxisLabelFrequency?: string | number

Show every Nth category label (c:tickLblSkip, ST_Skip), e.g. 2 for every other one.

  • a whole number of at least 1; anything else warns and leaves the element off

Pass a number. The string half is a compatibility hangover — this was typed as a free-form string and emitted verbatim, which both rejected the natural 2 and let 'every other' reach the attribute — and is read with Number() like any other.

catAxisLabelPos? ​

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

catAxisLabelRotate? ​

optional catAxisLabelRotate?: number

catAxisLine? ​

optional catAxisLine?: StrokeProps

The category axis line, as a stroke: width, dashType, type, color, cap and transparency under the same names a table border and a gridline use.

type: 'none' paints no line (an <a:noFill/> on the axis' own <c:spPr>), which is what catAxisLineShow: false used to say. Omitted, the line is drawn at 1 pt in DEF_GRIDLINE_COLOR, solid, flat-capped.

The four flat catAxisLine* keys below are the pre-4.0 spellings. Anything set here wins over its flat counterpart. They cannot express a cap, a transparency, or any dash outside solid/dash/dot, which is why they are superseded rather than widened.

Example ​

ts
{ width: 1.5, dashType: 'lgDashDot', color: SchemeColor.accent1, transparency: 40 }

catAxisLineColor? ​

optional catAxisLineColor?: string

Category-axis line colour.

Deprecated ​

Use catAxisLine.color.

catAxisLineShow? ​

optional catAxisLineShow?: boolean

Draw the category-axis line at all.

Deprecated ​

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

Default ​

ts
true

catAxisLineSize? ​

optional catAxisLineSize?: number

Category-axis line width in points.

Deprecated ​

Use catAxisLine.width.

catAxisLineStyle? ​

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

Category-axis line dash.

Deprecated ​

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

catAxisMajorTickMark? ​

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

catAxisMajorTimeUnit? ​

optional catAxisMajorTimeUnit?: "years" | "months" | "days"

The unit a date axis counts major tick marks in (c:majorTimeUnit/@val, ST_TimeUnit).

The canonical spelling is lower-case, and the check forgives case at run time, so 'Days' is taken as days. The type names the canonical three so the call site offers them; do not read the narrower type as permission to drop the tolerance, which a JavaScript caller with no types still relies on. Anything else warns chart/invalid-axis-time-unit and leaves the element off, because a garbage unit makes PowerPoint render nothing at all.

catAxisMajorUnit? ​

optional catAxisMajorUnit?: number

Spacing between major tick marks on a date axis or a scatter's X axis (c:majorUnit, ST_AxisUnit).

  • above 0; anything else warns and leaves the element off

catAxisMaxVal? ​

optional catAxisMaxVal?: number

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

catAxisMinorTickMark? ​

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

catAxisMinorTimeUnit? ​

optional catAxisMinorTimeUnit?: "years" | "months" | "days"

The unit a date axis counts minor tick marks in (c:minorTimeUnit/@val, ST_TimeUnit).

The canonical spelling is lower-case, and the check forgives case at run time, so 'Days' is taken as days. The type names the canonical three so the call site offers them; do not read the narrower type as permission to drop the tolerance, which a JavaScript caller with no types still relies on. Anything else warns chart/invalid-axis-time-unit and leaves the element off, because a garbage unit makes PowerPoint render nothing at all.

catAxisMinorUnit? ​

optional catAxisMinorUnit?: number

Spacing between minor tick marks; the same rule as ChartPropsAxisCat.catAxisMajorUnit.

catAxisMinVal? ​

optional catAxisMinVal?: number

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

catAxisMultiLevelLabels? ​

optional catAxisMultiLevelLabels?: boolean

catAxisOrientation? ​

optional catAxisOrientation?: "maxMin" | "minMax"

catAxisTitle? ​

optional catAxisTitle?: string

catAxisTitleColor? ​

optional catAxisTitleColor?: string

catAxisTitleFontFace? ​

optional catAxisTitleFontFace?: string

catAxisTitleFontSize? ​

optional catAxisTitleFontSize?: number

catAxisTitleRotate? ​

optional catAxisTitleRotate?: number

catGridLine? ​

optional catGridLine?: OptsChartGridLine

catLabelFormatCode? ​

optional catLabelFormatCode?: string

secondaryCatAxis? ​

optional secondaryCatAxis?: boolean

Whether data should use secondary category 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 secondaryValAxis, the secondary value axis is written hidden; valAxes[1] can show it.

Default ​

ts
false

showCatAxisTitle? ​

optional showCatAxisTitle?: boolean