BoxPlot

Draw a basic box-and-whisker plot. The plots are drawn centered at Y coordinates [0, 1, ..., N) unless the offset property is set to something else (which is useful for putting multiple box pots with different color boxes on the same figure).

class BoxPlot : Plot {

void drawPlot(Figure form, double leftMargin, double topMargin, double plotWidth, double plotHeight);

void drawLegendSymbol(FigureBase fig, PlotRect where);

static BoxPlot opCall(double whiskerPercentile);

This addData(R data);

double offset();

This offset(double newOffset);

Color color();

This color(Color newColor);

int nBoxes();

}

Members

Functions

addData This addData(R data): Add data to the box plot. data may be any combination of ranges of ranges and individual ranges.
color Color color(): The color that the boxes, whiskers and outliers are drawn in.
color This color(Color newColor): Setter.
drawLegendSymbol void drawLegendSymbol(FigureBase fig, PlotRect where): Undocumented in source. Be warned that the author may not have intended to support it.
drawPlot void drawPlot(Figure form, double leftMargin, double topMargin, double plotWidth, double plotHeight): Undocumented in source. Be warned that the author may not have intended to support it.
nBoxes int nBoxes(): The number of boxes currently on the plot.
offset double offset(): The offset from zero at which the first box is centered.
offset This offset(double newOffset): Setter

Static functions

opCall BoxPlot opCall(double whiskerPercentile): Create a BoxPlot. whiskerPercentile controls the percentile at which data points are considered outliers and plotted as individual points. For any x, a percentile of x is equivalent to a percentile of 1 - x. For example, if whiskerPercentile is either 0 or 1, no data is plotted as individual points and the whiskers extend all the way to the extrema.

Inherited Members

From Plot

upperLim double upperLim;: Undocumented in source.
lowerLim double lowerLim;: Undocumented in source.
leftLim double leftLim;: Undocumented in source.
rightLim double rightLim;: Undocumented in source.
_legendText string _legendText;: Undocumented in source.
resetLimits void resetLimits(Figure figure): Undocumented in source. Be warned that the author may not have intended to support it.
measureLegend PlotSize measureLegend(Font legendFont, FigureBase fig): Undocumented in source. Be warned that the author may not have intended to support it.
drawLegendSymbol void drawLegendSymbol(FigureBase fig, PlotRect where): Undocumented in source.
drawPlot void drawPlot(Figure , double , double , double , double ): Undocumented in source.
hasLegend bool hasLegend(): Returns true if this plot type supports legends, otherwise false.
toFigure Figure toFigure(): Convenience method that instantiates a Figure object with this plot. Useful for creating single-plot figures w/o a lot of boilerplate.
toLabeledFigure Figure toLabeledFigure(): Instantiates a Figure object with this plot and also places the default axes and tick labeling and title for the plot type, if any, on the Figure. If a plot type has no default labeling, simply forwards to toFigure().
leftMost double leftMost(): The leftmost point on the plot.
rightMost double rightMost(): The rightmost point on the plot.
topMost double topMost(): The topmost point on the plot.
bottomMost double bottomMost(): The bottommost point on the plot.
legendText string legendText()
legendText This legendText(string newText)