A plot element that draws a box plot. More...

Inheritance diagram for VectSharp.Plots.BoxPlot:

Public Member Functions

BoxPlot (IReadOnlyList< double > position, IReadOnlyList< double > direction, double whisker1, double box1, double box2, double whisker2, ICoordinateSystem< IReadOnlyList< double > > coordinateSystem)

Create a new BoxPlot instance. More...

void Plot (Graphics target)

Draw the plot element on the specified target  Graphics.

Parameters

target The Graphics on which to draw.

More...

void Plot (Graphics target)

Draw the plot element on the specified target Graphics. More...

Properties
IReadOnlyList< double >	Position `[get, set]`
	The position of the centre (e.g., median or mean) of the box plot, in data space coordinates. More...

IReadOnlyList< double >	Direction `[get, set]`
	The direction along which the box plot is drawn, in data space coordinates. More...

double	Whisker1 `[get, set]`
	The distance between the centre of the box plot and the first whisker, expressed as a multiple of Direction. More...

double	Box1 `[get, set]`
	The distance between the centre of the box plot and the first side of the box, expressed as a multiple of Direction. More...

double	Box2 `[get, set]`
	The distance between the centre of the box plot and the second side of the box, expressed as a multiple of Direction. More...

double	Whisker2 `[get, set]`
	The distance between the centre of the box plot and the second whisker, expressed as a multiple of Direction. More...

double	Width = 10 `[get, set]`
	The width of the box plot, in data space coordinates. More...

double	WhiskerWidth = 0.5 `[get, set]`
	The width of the whiskers, expressed as a multiple of the Width of the box. More...

double	NotchWidth = 0.5 `[get, set]`
	The width of the notch, expressed as a multiple of the Width of the box. More...

double	NotchSize = 0 `[get, set]`
	The distance between the centre of the box plot and the end of the notch, expressed as a multiple of Direction. More...

PlotElementPresentationAttributes	BoxPresentationAttributes = new PlotElementPresentationAttributes() { Fill = Colours.White } `[get, set]`
	Presentation attributes for the box. More...

PlotElementPresentationAttributes	WhiskersPresentationAttributes = new PlotElementPresentationAttributes() { Fill = null } `[get, set]`
	Presentation attributes for the whiskers. More...

PlotElementPresentationAttributes	CentreSymbolPresentationAttributes = new PlotElementPresentationAttributes() { Fill = null, Stroke = null } `[get, set]`
	Presentation attributes for the symbol drawn at the centre of the box plot. More...

IDataPointElement	CentreSymbol = new PathDataPointElement() `[get, set]`
	Symbol drawn at the centre of the box plot. More...

ICoordinateSystem< IReadOnlyList< double > >	CoordinateSystem `[get, set]`
	The coordinate system used to transform the points from data space to plot space. More...

string	Tag `[get, set]`
	A tag to identify the box in the plot. More...

Properties inherited from VectSharp.Plots.IPlotElement
ICoordinateSystem	CoordinateSystem `[get]`
	The coordinate system used to transform the points from data space to plot space. More...

Detailed Description

A plot element that draws a box plot.

Definition at line 26 of file BoxPlot.cs.

Constructor & Destructor Documentation

◆ BoxPlot()

VectSharp.Plots.BoxPlot.BoxPlot	(	IReadOnlyList< double >	position,
		IReadOnlyList< double >	direction,
		double	whisker1,
		double	box1,
		double	box2,
		double	whisker2,
		ICoordinateSystem< IReadOnlyList< double > >	coordinateSystem
	)

Create a new BoxPlot instance.

Parameters

position	The position of the centre (e.g., median or mean) of the box plot, in data space coordinates.
direction	The direction along which the box plot is drawn, in data space coordinates.
whisker1	The distance between the centre of the box plot and the first whisker, expressed as a multiple of direction .
box1	The distance between the centre of the box plot and the first side of the box, expressed as a multiple of direction .
box2	The distance between the centre of the box plot and the second side of the box, expressed as a multiple of direction .
whisker2	The distance between the centre of the box plot and the second whisker, expressed as a multiple of direction .
coordinateSystem	The coordinate system used to transform the points from data space to plot space.

Definition at line 129 of file BoxPlot.cs.

Member Function Documentation

◆ Plot()

void VectSharp.Plots.BoxPlot.Plot ( Graphics target )

Draw the plot element on the specified target  Graphics.

Parameters

target The Graphics on which to draw.

Implements VectSharp.Plots.IPlotElement.

Definition at line 141 of file BoxPlot.cs.

Property Documentation

◆ Box1

double VectSharp.Plots.BoxPlot.Box1

getset

The distance between the centre of the box plot and the first side of the box, expressed as a multiple of Direction.

Definition at line 48 of file BoxPlot.cs.

◆ Box2

double VectSharp.Plots.BoxPlot.Box2

getset

The distance between the centre of the box plot and the second side of the box, expressed as a multiple of Direction.

Definition at line 54 of file BoxPlot.cs.

◆ BoxPresentationAttributes

PlotElementPresentationAttributes VectSharp.Plots.BoxPlot.BoxPresentationAttributes = new PlotElementPresentationAttributes() { Fill = Colours.White }

getset

Presentation attributes for the box.

Definition at line 86 of file BoxPlot.cs.

◆ CentreSymbol

IDataPointElement VectSharp.Plots.BoxPlot.CentreSymbol = new PathDataPointElement()

getset

Symbol drawn at the centre of the box plot.

Definition at line 101 of file BoxPlot.cs.

◆ CentreSymbolPresentationAttributes

PlotElementPresentationAttributes VectSharp.Plots.BoxPlot.CentreSymbolPresentationAttributes = new PlotElementPresentationAttributes() { Fill = null, Stroke = null }

getset

Presentation attributes for the symbol drawn at the centre of the box plot.

Definition at line 96 of file BoxPlot.cs.

◆ CoordinateSystem

ICoordinateSystem<IReadOnlyList<double> > VectSharp.Plots.BoxPlot.CoordinateSystem

getset

The coordinate system used to transform the points from data space to plot space.

Implements VectSharp.Plots.IPlotElement.

Definition at line 106 of file BoxPlot.cs.

◆ Direction

IReadOnlyList<double> VectSharp.Plots.BoxPlot.Direction

getset

The direction along which the box plot is drawn, in data space coordinates.

Definition at line 36 of file BoxPlot.cs.

◆ NotchSize

double VectSharp.Plots.BoxPlot.NotchSize = 0

getset

The distance between the centre of the box plot and the end of the notch, expressed as a multiple of Direction.

Definition at line 81 of file BoxPlot.cs.

◆ NotchWidth

double VectSharp.Plots.BoxPlot.NotchWidth = 0.5

getset

The width of the notch, expressed as a multiple of the Width of the box.

Definition at line 75 of file BoxPlot.cs.

◆ Position

IReadOnlyList<double> VectSharp.Plots.BoxPlot.Position

getset

The position of the centre (e.g., median or mean) of the box plot, in data space coordinates.

Definition at line 31 of file BoxPlot.cs.

◆ Tag

string VectSharp.Plots.BoxPlot.Tag

getset

A tag to identify the box in the plot.

Definition at line 111 of file BoxPlot.cs.

◆ Whisker1

double VectSharp.Plots.BoxPlot.Whisker1

getset

The distance between the centre of the box plot and the first whisker, expressed as a multiple of Direction.

Definition at line 42 of file BoxPlot.cs.

◆ Whisker2

double VectSharp.Plots.BoxPlot.Whisker2

getset

The distance between the centre of the box plot and the second whisker, expressed as a multiple of Direction.

Definition at line 60 of file BoxPlot.cs.

◆ WhiskersPresentationAttributes

PlotElementPresentationAttributes VectSharp.Plots.BoxPlot.WhiskersPresentationAttributes = new PlotElementPresentationAttributes() { Fill = null }

getset

Presentation attributes for the whiskers.

Definition at line 91 of file BoxPlot.cs.

◆ WhiskerWidth

double VectSharp.Plots.BoxPlot.WhiskerWidth = 0.5

getset

The width of the whiskers, expressed as a multiple of the Width of the box.

Definition at line 70 of file BoxPlot.cs.

◆ Width

double VectSharp.Plots.BoxPlot.Width = 10

getset

The width of the box plot, in data space coordinates.

Definition at line 65 of file BoxPlot.cs.

The documentation for this class was generated from the following file:

VectSharp.Plots/BoxPlot.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ BoxPlot()

Member Function Documentation

◆ Plot()

Property Documentation

◆ Box1

◆ Box2

◆ BoxPresentationAttributes

◆ CentreSymbol

◆ CentreSymbolPresentationAttributes

◆ CoordinateSystem

◆ Direction

◆ NotchSize

◆ NotchWidth

◆ Position

◆ Tag

◆ Whisker1

◆ Whisker2

◆ WhiskersPresentationAttributes

◆ WhiskerWidth

◆ Width