VectSharp.Plots.Plot Class Reference

Represents a collection of plot elements. More...

Public Types
enum	WhiskerType
	Describes the types of whiskers for a box plot. More...
enum	NormalisationMode
	Describes the kind of normalisation that is performed. More...

Public Member Functions
void	AddPlotElement (IPlotElement plotElement)
	Add the specified plot element to the plot. More...
void	AddPlotElements (IEnumerable< IPlotElement > plotElements)
	Add the specified plot elements to the plot. More...
void	AddPlotElements (params IPlotElement[] plotElements)
	Add the specified plot elements to the plot. More...
void	RemovePlotElement (IPlotElement plotElement)
	Remove the specified plot element from the plot. More...
void	Render (Graphics target)
	Render the plot on the specified target Graphics. More...
T	GetFirst< T > ()
	Get the first IPlotElement of the specified type, or the first ICoordinateSystem of the specified type. More...
IEnumerable< T >	GetAll< T > ()
	Get all IPlotElements of the specified type, or all ICoordinateSystems of the specified type. More...
Page	Render ()
	Render the plot to a suitably cropped Page object. More...
	Plot ()
	Create a new empty Plot. More...

Properties
ImmutableList< IPlotElement >	PlotElements = ImmutableList.Create<IPlotElement>() [get]
	The elements contained in the plot. More...

Detailed Description

Represents a collection of plot elements.

Definition at line 24 of file Plot.Area.cs.

Member Enumeration Documentation

NormalisationMode

enum VectSharp.Plots.Plot.NormalisationMode

Describes the kind of normalisation that is performed.

Definition at line 29 of file Plot.Histogram.cs.

WhiskerType

enum VectSharp.Plots.Plot.WhiskerType

Describes the types of whiskers for a box plot.

Definition at line 30 of file Plot.BoxPlot.cs.

Constructor & Destructor Documentation

Plot()

VectSharp.Plots.Plot.Plot

(

)

Create a new empty Plot.

Definition at line 260 of file Plot.cs.

Member Function Documentation

AddPlotElement()

void VectSharp.Plots.Plot.AddPlotElement

(

IPlotElement

plotElement

)

Add the specified plot element to the plot.

Parameters

plotElement

The plot element to add.

Definition at line 154 of file Plot.cs.

AddPlotElements() [1/2]

void VectSharp.Plots.Plot.AddPlotElements

(

IEnumerable< IPlotElement >

plotElements

)

Add the specified plot elements to the plot.

Parameters

plotElements

The plot elements to add.

Definition at line 163 of file Plot.cs.

AddPlotElements() [2/2]

void VectSharp.Plots.Plot.AddPlotElements

(

params IPlotElement[]

plotElements

)

Add the specified plot elements to the plot.

Parameters

plotElements

The plot elements to add.

Definition at line 172 of file Plot.cs.

GetAll< T >()

IEnumerable< T > VectSharp.Plots.Plot.GetAll< T >

(

)

Get all IPlotElements of the specified type, or all ICoordinateSystems of the specified type.

Template Parameters

T	The type of plot element or coordinate system to get.

Returns

All IPlotElements of the specified type, or all ICoordinateSystems of the specified type.

Type Constraints

T	:	class
T	:	IPlotElement

Definition at line 225 of file Plot.cs.

GetFirst< T >()

T VectSharp.Plots.Plot.GetFirst< T >

(

)

Get the first IPlotElement of the specified type, or the first ICoordinateSystem of the specified type.

Template Parameters

T	The type of plot element or coordinate system to get.

Returns

The first IPlotElement of the specified type, or the first ICoordinateSystem of the specified type, or null if none could be found.

Type Constraints

T

:

class

Definition at line 203 of file Plot.cs.

RemovePlotElement()

void VectSharp.Plots.Plot.RemovePlotElement

(

IPlotElement

plotElement

)

Remove the specified plot element from the plot.

Parameters

plotElement

The plot element to remove.

Definition at line 181 of file Plot.cs.

Render() [1/2]

Page VectSharp.Plots.Plot.Render

(

)

Render the plot to a suitably cropped Page object.

Returns

A Page object containing the rendered plot.

Definition at line 244 of file Plot.cs.

Render() [2/2]

void VectSharp.Plots.Plot.Render

(

Graphics

target

)

Render the plot on the specified target Graphics.

Parameters

target

The Graphics on which the plot should be drawn.

Definition at line 190 of file Plot.cs.

Property Documentation

PlotElements

ImmutableList<IPlotElement> VectSharp.Plots.Plot.PlotElements = ImmutableList.Create<IPlotElement>()

get

The elements contained in the plot.

Definition at line 148 of file Plot.cs.

---

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

• VectSharp.Plots/Plot.Area.cs
• VectSharp.Plots/Plot.cs
• VectSharp.Plots/Plot.Histogram.cs