xmCHART Functions | User Guide

Home › User Guide › Functions › BoxPlotOptions

Functions
- BoxPlot()
Function Groups
- Axes
- Backgrounds
- Curve Fitting
- Data
- Drop Lines
- Error Bars
- Grids
- Legend
- Moving Averages
- Styles
- Title
- Functions by Group
- Functions by Name

BoxPlotOptions

BoxPlotOptions ( itemGap ; isPercentileGraph ; doFillBox ; showMean ; showMedian ; showOutliersOnly ; showCapsOnly ; capLength ; confidenceInterval )

Argument	Type	Range	Default	Note
itemGap	num	-100..1000000	100	In % of box width
isPercentileGraph	int	0..1	off
doFillBox	int	0..1	off
showMean	int	0..1	off
showMedian	int	0..1	off
showOutliersOnly	int	0..1	off
showCapsOnly	int	0..1	off
capLength	num	0..1000	50	In % of box width
confidenceInterval	num	0..99.9999	0	In % probability

Examples

BoxPlotOptions(;;;on;on;on)

BoxPlotOptions(50;on)

BoxPlotOptions(;on;on;on;on;off;off;;95)

Description

The BoxPlotOptions() function should be listed after the BoxPlot() function and opens up a variety of options. By using the 1st argument itemGap, the space between the individual series can be controlled. The space is entered in percent of the box width. As the default, the space equals the box width (itemGap = 100). For values greater than 100 (e.g. itemGap = 400) the boxes are narrower and the spaces between them bigger; for values less than 100 (e.g. itemGap = 50) the boxes are wider and the spaces smaller.

BOX_PLOT_OPTIONS_01

1	OpenDrawing(250;120)
2	ChartData(1 1 8 9.9 5 7.2 3 4 5 3 6; /* 1st series. */
3	3 5 3.2 4.1 8 9 5 3.5 4.9 6.1) /* 2nd series. */
4	BoxPlot(horizontal)
5	BoxPlotOptions(300) /* After BoxPlot() */
6	/* Set up styles. */
7	BorderStyle(all;;0.75;#4682b4)
8	/* Set up axes. */
9	ScalingOptions(y;on) /* y-scale top to bottom. */
10	AxisLine(all;0)
11	AxisMajorTicks(all;0)
12	AxisMajorTickLabelTexts(y;"Series-1";"Series-2")
13	/* Set up grid. */
14	MajorGridLineWidths(x;y;0)
15	MajorGridLineWidths(y;x;0.25)
16	CloseDrawing()

By activating the 2nd argument isPercentileGraph = on, the box is extended to the whisker percentile.

BOX_PLOT_OPTIONS_02

1	OpenDrawing(250;120)
2	ChartData(1 1 8 9.9 5 7.2 3 4 5 3 6)
3	BoxPlot(horizontal+symbol)
4	BoxPlotOptions(;on) /* After BoxPlot() */
5	/* Set up styles. */
6	BorderStyle(1;;0.75;#4682b4)
7	SymbolStyle(1;bullet;4;1;#4682b4;shaded)
8	/* Set up axes. */
9	AxisLine(all;0)
10	AxisMajorTicks(all;0)
11	/* Set up grid. */
12	MajorGridLineWidths(x;y;0)
13	MajorGridLineWidths(y;x;0.25)
14	CloseDrawing()

The fill of the box can be controlled by using the 3rd argument doFillBox = on and the FillColorScheme() , FillStyle() or PictureStyle() function.

BOX_PLOT_OPTIONS_03

1	OpenDrawing(250;120)
2	ChartData(1 1 8 9.9 5 7.2 3 4 5 3 6)
3	BoxPlot(horizontal)
4	BoxPlotOptions(200;off;on) /* After BoxPlot() */
5	/* Set up styles. */
6	FillStyle(1;#4682b415)
7	BorderStyle(1;;0.75;#4682b4)
8	/* Set up axes. */
9	AxisLine(all;0)
10	AxisMajorTicks(all;0)
11	/* Set up grid. */
12	MajorGridLineWidths(x;y;0)
13	MajorGridLineWidths(y;x;0.25)
14	CloseDrawing()

Furthermore, marker lines can be added for the arithmetic mean and median value by activating the arguments showMean = on and showMedian = on. The depiction of the mean value line is identical to the border and is controlled by the BorderStyle() function. The appearance of the median line can be controlled by the LineStyle() function.

BOX_PLOT_OPTIONS_04

1	OpenDrawing(250;120)
2	ChartData(1 1 8 9.9 5 7.2 3 4 5 3 6)
3	BoxPlot(horizontal)
4	BoxPlotOptions(200;off;off;on) /* After BoxPlot() */
5	/* Set up styles. */
6	BorderStyle(1;;0.75;#4682b4)
7	/* Set up axes. */
8	AxisLine(all;0)
9	AxisMajorTicks(all;0)
10	/* Set up grid. */
11	MajorGridLineWidths(x;y;0)
12	MajorGridLineWidths(y;x;0.25)
13	CloseDrawing()

BOX_PLOT_OPTIONS_05

1	OpenDrawing(250;120)
2	ChartData(1.5 1 8 9.6 5 7.2 10 9 3 4 4.5 3 6)
3	BoxPlot(horizontal+symbol)
4	BoxPlotOptions(100;off;off;on;on) /* After BoxPlot() */
5	/* Set up styles. */
6	BorderStyle(1;;0.75;#4682b4)
7	LineStyle(1;;0.75;darkRed) /* Median */
8	SymbolStyle(1;bullet;3;1;#4682b4;solid)
9	/* Set up axes. */
10	AxisLine(all;0)
11	AxisMajorTicks(all;0)
12	/* Set up grid. */
13	MajorGridLineWidths(x;y;0)
14	MajorGridLineWidths(y;x;0.25)
15	CloseDrawing()

By activating the argument showOutliersOnly = on, the depiction of the symbols is limited to the "outliers", i.e. to those values which lie outside of the whisker percentile. The depiction of symbols is activated by appearanceConstants = symbol in the BoxPlot() function.

BOX_PLOT_OPTIONS_06

1	OpenDrawing(250;120)
2	ChartData(0.5 1 1 8 8.8 5 7.2 3 4 5 3 6; /* 1st series. */
3	3 5 3.2 4.1 8 9 5 3.5 4.9 6.1) /* 2nd series. */
4	BoxPlot(horizontal+symbol)
5	BoxPlotOptions(100;off;on;on;off;on) /* After BoxPlot() */
6	/* Set up styles. */
7	FillStyle(all;#4682b415)
8	BorderStyle(all;;0.75;#4682b4)
9	SymbolStyle(all;bullet;4;1;#4682b4;solid)
10	/* Set up axes. */
11	ScalingOptions(y;on) /* y-scale top to bottom. */
12	AxisLine(all;0)
13	AxisMajorTicks(all;0)
14	/* Set up grid. */
15	MajorGridLineWidths(x;y;0)
16	MajorGridLineWidths(y;x;0.25)
17	CloseDrawing()

By using the argument showCapsOnly = on, the lines between the box and the whisker caps can be surpressed.

BOX_PLOT_OPTIONS_07

1	OpenDrawing(250;120)
2	ChartData(1 1.5 8.2 9.9 5 7.5 3 4 4.5 3.3 6)
3	BoxPlot(horizontal+symbol)
4	BoxPlotOptions(200;off;on;on;off;off;on)
5	/* Set up styles. */
6	FillStyle(all;#4682b415)
7	BorderStyle(all;;0.75;#4682b4)
8	SymbolStyle(all;bullet;3;1;#4682b4;solid)
9	/* Set up axes. */
10	AxisLine(all;0)
11	AxisMajorTicks(all;0)
12	/* Set up grid. */
13	MajorGridLineWidths(x;y;0)
14	MajorGridLineWidths(y;x;0.25)
15	CloseDrawing()

The marker length of the whisker percentile can be controlled by using the last argument capLength. The marker length should be entered in percent of the box width. The default is 50, i.e. half of the width of the box.

BOX_PLOT_OPTIONS_08

1	OpenDrawing(200;200)
2	ChartData(1 1 8 9.9 5 7.2 3 4 5 3 6; /* 1st series. */
3	3 5 3.2 4.1 8 9 5 3.5 4.9 6.1) /* 2nd series. */
4	BoxPlot(symbol)
5	BoxPlotOptions(200;off;on;on;on;off;on;100)
6	/* Set up styles. */
7	FillStyle(all;#4682b415)
8	BorderStyle(all;;0.75;#4682b4)
9	LineStyle(all;;0.75;darkRed) /* Median */
10	SymbolStyle(all;bullet;2;1;#4682b4;solid)
11	/* Set up axes. */
12	ScalingOptions(y;on) /* y-scale top to bottom. */
13	AxisLine(all;0)
14	AxisMajorTicks(all;0)
15	/* Set up grid. */
16	MajorGridLineWidths(x;y;0.25)
17	MajorGridLineWidths(y;x;0)
18	CloseDrawing()

Box plots can also be used to represent quartiles. The upper box percentile is set to equal 75% (that corresponds to the 3rd quartile) and the lower box percentile to equal 25% (that corresponds to the 1st quartile). The 2nd quartile (= 50% percentile) corresponds to the median. The quartiles are limited by the upper whisker percentile equaling 100% and by the lower whisker percentile equaling 0%.

BOX_PLOT_OPTIONS_09

1	OpenDrawing(200;200)
2	ChartData(1 1 8 9 5 7.2 3 4 5 3 6; /* 1st series. */
3	3 5 3 4.1 7 3 5 2 5 3.5 4.9 6) /* 2nd series. */
4	BoxPlot(;75;25;100;0)
5	BoxPlotOptions(;on; /* Percentile graph. */
6	off; /* No fill. */
7	off; /* No mean. */
8	on) /* Median (= 2nd quartile) */
9	/* Set up styles. */
10	FillStyle(all;#4682b415)
11	BorderStyle(all;;0.75;#4682b4)
12	LineStyle(all;;0.75;#4682b4)
13	/* Set up axes. */
14	ScalingOptions(y;on) /* y-scale top to bottom. */
15	AxisLine(all;0)
16	AxisMajorTicks(all;0)
17	AxisMajorTickLabelTexts(x;"Series 1";"Series 2")
18	AxisMajorTickLabelTexts(y;"\|u\|%")
19	/* Set up grid. */
20	MajorGridLineWidths(x;y;0.25)
21	MajorGridLineWidths(y;x;0)
22	CloseDrawing()

As an option, a predefined confidence interval can be made visible by notching the rectangular box using the argument confidenceInterval.

BOX_PLOT_OPTIONS_10

1	OpenDrawing(250;120)
2	ChartData(1 1 8 9.9 5 7.2 3 4 5 3 6)
3	BoxPlot(horizontal)
4	BoxPlotOptions(200;off;on;
5	on; /* Show mean. */
6	off;
7	off;
8	off;
9	50; /* Cap length. */
10	90) /* 90% confidence interval. */
11	/* Set up styles. */
12	FillStyle(all;#4682b415)
13	BorderStyle(all;;0.75;#4682b4)
14	/* Set up axes. */
15	AxisLine(all;0)
16	AxisMajorTicks(all;0)
17	/* Set up grid. */
18	MajorGridLineWidths(x;y;0)
19	MajorGridLineWidths(y;x;0.25)
20	CloseDrawing()

Legal Newsletter Contact

Site Map