VectSharp.Plots.Swarm Class Reference

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

Inheritance diagram for VectSharp.Plots.Swarm:

Public Member Functions
	Swarm (IReadOnlyList< double > position, IReadOnlyList< double > direction, IEnumerable< double > data, IContinuousInvertibleCoordinateSystem coordinateSystem)
	Create a new Swarm instance. More...
void	Plot (Graphics target)
	Draw the plot element on the specified target &#160;Graphics. Parameters target The Graphics on which to draw. More...
void	Plot (Graphics target)
	Draw the plot element on the specified target &#160;Graphics. More...

Properties
IReadOnlyList< double >	Position [get, set]
	The position of the origin of the swarm (e.g., the 0 in data space coordinates). More...
IReadOnlyList< double >	Direction [get, set]
	The direction along which the swarm is drawn, in data space coordinates. More...
IReadOnlyList< double >	Data [get]
	The values whose distribution is displayed by the swarm plot. More...
double	PointSize = 2 [get, set]
	The size of the points in the swarm plot, in plot coordinates. More...
double	PointMargin = 0.25 [get, set]
	The minimum margin between points in the swarm plot, in plot coordinates. More...
IDataPointElement	SwarmPointElement = new PathDataPointElement() [get, set]
	The IDataPointElement used to draw the swarm points. More...
PlotElementPresentationAttributes	PresentationAttributes = new PlotElementPresentationAttributes() { Fill = Colours.White } [get, set]
	Presentation attributes for the swarm plot. More...
IContinuousInvertibleCoordinateSystem	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 swarm 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 swarm plot.

Definition at line 27 of file Swarm.cs.

Constructor & Destructor Documentation

Swarm()

VectSharp.Plots.Swarm.Swarm	(	IReadOnlyList< double >	position,
		IReadOnlyList< double >	direction,
		IEnumerable< double >	data,
		IContinuousInvertibleCoordinateSystem	coordinateSystem
	)

Create a new Swarm instance.

Parameters

position	The position of the origin of the swarm (e.g., the 0 in data space coordinates).
direction	The direction along which the swarm is drawn, in data space coordinates.
data	The values whose distribution is displayed by the swarm plot.
coordinateSystem	The coordinate system used to transform the points from data space to plot space.

Definition at line 82 of file Swarm.cs.

Member Function Documentation

Plot()

void VectSharp.Plots.Swarm.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 155 of file Swarm.cs.

Property Documentation

CoordinateSystem

IContinuousInvertibleCoordinateSystem VectSharp.Plots.Swarm.CoordinateSystem

getset

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

Implements VectSharp.Plots.IPlotElement.

Definition at line 67 of file Swarm.cs.

Data

IReadOnlyList<double> VectSharp.Plots.Swarm.Data

get

The values whose distribution is displayed by the swarm plot.

Definition at line 42 of file Swarm.cs.

Direction

IReadOnlyList<double> VectSharp.Plots.Swarm.Direction

getset

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

Definition at line 37 of file Swarm.cs.

PointMargin

double VectSharp.Plots.Swarm.PointMargin = 0.25

getset

The minimum margin between points in the swarm plot, in plot coordinates.

Definition at line 52 of file Swarm.cs.

PointSize

double VectSharp.Plots.Swarm.PointSize = 2

getset

The size of the points in the swarm plot, in plot coordinates.

Definition at line 47 of file Swarm.cs.

Position

IReadOnlyList<double> VectSharp.Plots.Swarm.Position

getset

The position of the origin of the swarm (e.g., the 0 in data space coordinates).

Definition at line 32 of file Swarm.cs.

PresentationAttributes

PlotElementPresentationAttributes VectSharp.Plots.Swarm.PresentationAttributes = new PlotElementPresentationAttributes() { Fill = Colours.White }

getset

Presentation attributes for the swarm plot.

Definition at line 62 of file Swarm.cs.

SwarmPointElement

IDataPointElement VectSharp.Plots.Swarm.SwarmPointElement = new PathDataPointElement()

getset

The IDataPointElement used to draw the swarm points.

Definition at line 57 of file Swarm.cs.

Tag

string VectSharp.Plots.Swarm.Tag

getset

A tag to identify the swarm in the plot.

Definition at line 73 of file Swarm.cs.

---

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

• VectSharp.Plots/Swarm.cs