- SpreadJS Overview
- Getting Started
- JavaScript Frameworks
- Best Practices
- Features
- SpreadJS Designer
- SpreadJS Designer Component
- Touch Support
-
Formula Reference
- Formula Overview
-
Formula Functions
- Barcode Functions
- Compatibility Functions
- Database Functions
- Date and Time Functions
- Engineering Functions
- Financial Functions
- Information Functions
- Logical Functions
- Lookup and Reference Functions
- Math and Trigonometric Functions
- Statistical Functions
-
Sparkline Functions
- AREASPARKLINE
-
BOXPLOTSPARKLINE
- BULLETSPARKLINE
- CASCADESPARKLINE
- COLUMNSPARKLINE
- GAUGEKPISPARKLINE
- HBARSPARKLINE
- HISTOGRAMSPARKLINE
- IMAGE
- LINESPARKLINE
- MONTHSPARKLINE
- PARETOSPARKLINE
- PIESPARKLINE
- RANGEBLOCKSPARKLINE
- SCATTERSPARKLINE
- SPREADSPARKLINE
- STACKEDSPARKLINE
- VARISPARKLINE
- VBARSPARKLINE
- WINLOSSSPARKLINE
- YEARSPARKLINE
- Text Functions
- Web Functions
- Other Functions
- RegEx Functions
- Import and Export Reference
- Frequently Used Events
- API Documentation
- Release Notes
BOXPLOTSPARKLINE
This function returns a data set used for representing a boxplot sparkline.
Syntax
BOXPLOTSPARKLINE( points, boxPlotClass, [showAverage, scaleStart, scaleEnd, acceptableStart, acceptableEnd, colorScheme, style, vertical] )
Arguments
Argument | Description |
|---|---|
Points | A reference that represents the cell range that contains the values, such as "A1:A4". |
boxPlotClass | Q1–>25% percentile, Q3–>75% percentile, IQR-->Q3-Q1. |
5ns: whisker ends at minimum and maximum, median, no outliers. | |
7ns: whisker ends at 2% percentile and 98% percentile, hatch marks at 9% percentile and 91% percentile, outliers beyond 2% percentile and 98% percentile. | |
tukey: whisker ends at a value (the minimum of the points between Q1 and Q1 - 1.5*IQR, use the point if it exists or use the minimum) and a value (the maximum of the points between Q3 and Q3 + 1.5 * IQR, use the point if it exists or use the maximum), outliers beyond Q1 - 1.5*IQR and Q3 + 1.5 * IQR, and extreme outliers beyond Q1 - 3 * IQR and Q3 + 3 * IQR. | |
bowley: whisker ends at minimum and maximum, hatch marks at 10% percentile and 90% percentile, no outliers. | |
sigma3: whisker ends at a value (average - 2 * StDev > scaleStart ? average - 2 * StDev : minimum) and a value (average + 2 * StDev < scaleEnd ? average = 2 * StDev : maximum), box at average +/- stdev, outliers beyond average - 2 * StDev and average + 2 * StDev, and extreme outliers beyond average - 3 * StDev and average + 3 * StDev. | |
showAverage | (Optional) A boolean that represents whether to show the average. The default value is FALSE. |
scaleStart | (Optional) A number or reference that represents the minimum boundary of the sparkline, such as 1 or "A6". The default value is the minimum of all values. |
scaleEnd | (Optional) A number or reference that represents the maximum boundary of the sparkline, such as 8 or "A7". The default value is the maximum of all values. |
acceptableStart | (Optional) A number or reference that represents the start of the acceptable line, such as 3 or "A8". The default value is None. |
colorScheme | (Optional) A string that represents the color of the sparkline's box. The default value is "#D2D2D2". |
style | (Optional) A number or reference that represents the sparkline style. This setting is optional. The default value is 0 (Classical). The style can be 0 or 1.
|
vertical | (Optional) A boolean that represents whether to display the sparkline vertically. The default value is FALSE. |
Data Types
Returns sparkline.
Examples
activeSheet.setFormula(0,1,'=BOXPLOTSPARKLINE(C1:P1,"5ns",TRUE,0,100,-1,100,"red",0,FALSE)');