Skip to content

@shbernal/pptxgenjs


@shbernal/pptxgenjs / index / ChartErrorBarOptions

Interface: ChartErrorBarOptions

Defined in: core-interfaces.ts:2099

Error-bar configuration for a chart series (<c:errBars>). Maps onto OOXML CT_ErrBars (errDir / errBarType / errValType / noEndCap / plus / minus / val).

Properties

barType?

optional barType?: "both" | "plus" | "minus"

Defined in: core-interfaces.ts:2110

Which sides of each marker draw a bar.

Default

ts
'both'

color?

optional color?: string

Defined in: core-interfaces.ts:2136

Error-bar line color (hex, e.g. 'FF0000').


direction?

optional direction?: "x" | "y"

Defined in: core-interfaces.ts:2105

Axis the error bars measure along.

  • 'y' (the value axis) for BAR/BAR3D/LINE/AREA; SCATTER may also use 'x'.

Default

ts
'y'

minusValues?

optional minusValues?: number[]

Defined in: core-interfaces.ts:2129

Per-point negative magnitudes; required when valueType === 'cust' (unless barType: 'plus'). Index-aligned with values[].


noEndCap?

optional noEndCap?: boolean

Defined in: core-interfaces.ts:2134

Hide the perpendicular end caps.

Default

ts
false

plusValues?

optional plusValues?: number[]

Defined in: core-interfaces.ts:2127

Per-point positive magnitudes; required when valueType === 'cust' (unless barType: 'minus'). Index-aligned with values[].


size?

optional size?: number

Defined in: core-interfaces.ts:2138

Error-bar line width (points).


value?

optional value?: number

Defined in: core-interfaces.ts:2125

Magnitude for 'fixedVal', 'percentage', or 'stdDev'. Ignored for 'stdErr' and 'cust'.

Default

ts
1

valueType?

optional valueType?: "cust" | "fixedVal" | "percentage" | "stdDev" | "stdErr"

Defined in: core-interfaces.ts:2120

How value (or plusValues/minusValues) is interpreted.

  • 'fixedVal' — fixed amount in axis units
  • 'percentage' — percent of each value (e.g. value: 5 → ±5%)
  • 'stdDev'value standard deviations
  • 'stdErr' — standard error (ignores value)
  • 'cust' — explicit per-point amounts via plusValues/minusValues

Default

ts
'fixedVal'