Documentation v1.0.0

---

Documentation / @openassistant/plots / createBoxplot

Function: createBoxplot()

createBoxplot(props): BoxplotDataProps

Defined in: echarts/boxplot/utils.ts:93

Create a boxplot from a list of numbers and option boundIQR (1.5 or 3.0)

Parameters

props

CreateBoxplotProps

The properties object containing:

Returns

BoxplotDataProps

The boxplot data containing statistical properties and mean points

Example: single boxplot

const data = {
  'samples': [1, 2, 3, 4, 5],
};
const boundIQR = 1.5;
const boxplotData = createBoxplot({data, boundIQR});

Example: multiple boxplots

const data = {
  'samples': [1, 2, 3, 4, 5],
  'samples2': [6, 7, 8, 9, 10],
};
const boundIQR = 1.5;
const boxplotData = createBoxplot({data, boundIQR});