Series Stack Config

Configure the stacking of series.

seriesStacks is a list section: it takes an array of config objects (a single object is also accepted and treated as a one-entry array). Values shared by every entry can be set once in seriesStackDefaults; a value set on an individual entry wins over the shared one.

• Validation: should be an array with elements that should be an object with any of the properties { axis, id, ignore, outerCap }

Every property is optional and falls back to its default. Property anchors are stable: link to any entry as #seriesStacks.propertyName, and to a member of a nested property as #seriesStacks.propertyName.memberName.

axis

The unique identifier of the value axis that the series stack belongs to.

• Default: sole axis id
• Validation: should be a string; should equal the id property of one of the valueAxes
• Used in: Stacked · Axis Filtering Adjustment · Threshold Line · +1 more

id

The unique identifier for the series stack so it can be referenced by series that belong to it.

Referenced by series[].stack to place series in this stack. Stacked series draw on top of one another and animate as a single gapless unit — each segment’s baseline follows the tweened top of the segment below it throughout a transition.

• Default: SS${index}
• Validation: should be a string of letters, digits, dashes and underscores; should be unique
• Used in: Home · Stacked bars · Colors and theming · Stacked · Stacked & Grouped · Missing Pos/Neg Stacked Values · +2 more

ignore

Whether to ignore this series stack and treat it as though it were not specified.

• Default: false
• Validation: should be a boolean

outerCap

The cap drawn on the outer end of the stack, on the series that are its outer series.

• Default: { size: 5, type: null, expand: true }
• Validation: should be an object with any of the properties { expand, size, type }
• Used in: Capping a stack

outerCap.expand

Whether to expand the base of caps for series that are an outer series of the stack when the size of the cap is greater than the extent of the bar.

• Default: true
• Validation: should be a boolean

outerCap.size

The size of the cap (in pixels) for series that are an outer series of the stack.

• Default: 5
• Validation: should be a number >= to 0
• Used in: Capping a stack

outerCap.type

The type (point, curve, round, use null for none) of cap for series that are an outer series of the stack.

Caps only the outer end of the whole stack rather than every segment; pairs with series[].cap.onlyStackOuter.

• Default: null
• Validation: should be one of [ "point", "curve", "round" ] or be equal to null
• Used in: Capping a stack