#

API Docs for: 3.10.3
Show: Inherited Protected Private Deprecated

# StackingUtil Class

Defined in: `charts/js/StackingUtil.js:9`
Module: series-stacked
Parent Module: charts

Utility class used for creating stacked series.

## Constructor

### `StackingUtil`

()

Defined in `charts/js/StackingUtil.js:9`

- Index
- Methods
- Properties

## Item Index

### Methods

- _cleanXNaN
- _cleanYNaN
- _getNextValidCoordValue
- _getPreviousValidCoordValue
- _stackCoordinates
- _stackXCoords
- _stackYCoords

### Properties

- _stacked

## Methods

### `_cleanXNaN`

(

- `xcoords`
- `ycoords`

)
private

Defined in `charts/js/StackingUtil.js:207`

Cleans invalid x-coordinates by calculating their value based on the corresponding y-coordinate, the previous valid x-coordinate with its corresponding y-coordinate and the next valid x-coordinate with its corresponding y-coordinate. If there is no previous or next valid x-coordinate, the value will not be altered.

#### Parameters:

- `xcoords` Array

  An array of x-coordinate values

- `ycoords` Array

  An arry of y-coordinate values

### `_cleanYNaN`

(

- `xcoords`
- `ycoords`

)
private

Defined in `charts/js/StackingUtil.js:301`

Cleans invalid y-coordinates by calculating their value based on the corresponding x-coordinate, the previous valid y-coordinate with its corresponding x-coordinate and the next valid y-coordinate with its corresponding x-coordinate. If there is no previous or next valid y-coordinate, the value will not be altered.

#### Parameters:

- `xcoords` Array

  An array of x-coordinate values

- `ycoords` Array

  An arry of y-coordinate values

### `_getNextValidCoordValue`

(

- `coords`
- `index`

)
private

Defined in `charts/js/StackingUtil.js:279`

Returns the next valid (numeric) value in an array if available.

#### Parameters:

- `coords` Array

  Array of values

- `index` Number

  The index in the array in which to begin searching.

#### Returns:

Number

### `_getPreviousValidCoordValue`

(

- `coords`
- `index`

)
private

Defined in `charts/js/StackingUtil.js:257`

Returns the previous valid (numeric) value in an array if available.

#### Parameters:

- `coords` Array

  Array of values

- `index` Number

  The index in the array in which to begin searching.

#### Returns:

Number

### `_stackCoordinates`

() protected

Defined in `charts/js/StackingUtil.js:28`

### `_stackXCoords`

() protected

Defined in `charts/js/StackingUtil.js:47`

Stacks coordinates for a stacked vertical series.

### `_stackYCoords`

() protected

Defined in `charts/js/StackingUtil.js:126`

Stacks coordinates for a stacked horizontal series.

## Properties

### `_stacked`

Unknown private

Defined in `charts/js/StackingUtil.js:20`

Indicates whether the series is stacked.