NPlot::IPlotSurface2D Interface Reference

Defines the PlotSurface2D interface - All specific PlotSurface2D classes that use PlotSurface2D for their underlying operations should implement this class. More...

Inheritance diagram for NPlot::IPlotSurface2D:

NPlot::Bitmap::PlotSurface2D NPlot::PlotSurface2D NPlot::Web::PlotSurface2D NPlot::Windows::PlotSurface2D List of all members.

Public Member Functions

void Add (IDrawable p, int zOrder)
 Adds a drawable object to the plot surface.
void Add (IDrawable p, NPlot.PlotSurface2D.XAxisPosition xp, NPlot.PlotSurface2D.YAxisPosition yp, int zOrder)
 Adds a drawable object to the plot surface against the specified axes.
void Add (IDrawable p)
 Adds a drawable object to the plot surface.
void Add (IDrawable p, NPlot.PlotSurface2D.XAxisPosition xax, NPlot.PlotSurface2D.YAxisPosition yax)
 Adds a drawable object to the plot surface against the specified axes.
void Clear ()
 Clears the PlotSurface2D.
void AddAxesConstraint (AxesConstraint c)
 Add an axis constraint to the plot surface.
void Remove (IDrawable p, bool updateAxes)
 Remove a drawable object from the plot surface.

Properties

NPlot.Legend Legend
 Gets or Sets the legend to use with this plot surface.
int LegendZOrder
 Setting this value determines the order (relative to IDrawables added to the plot surface) that the legend is drawn.
int Padding
 The distance in pixels to leave between of the edge of the bounding rectangle supplied to the Draw method, and the markings that make up the plot.
System.Drawing.Color PlotBackColor
 A color used to paint the plot background.
System.Drawing.Bitmap PlotBackImage
 An imaged used to paint the plot background.
IRectangleBrush PlotBackBrush
 A Rectangle brush used to paint the plot background.
string Title
 The plot surface title.
bool AutoScaleTitle
 Whether or not the title will be scaled according to size of the plot surface.
bool AutoScaleAutoGeneratedAxes
 When plots are added to the plot surface, the axes they are attached to are immediately modified to reflect data of the plot.
System.Drawing.Color TitleColor
 Sets the title to be drawn using a solid brush of this color.
System.Drawing.Brush TitleBrush
 The brush used for drawing the title.
System.Drawing.Font TitleFont
 The plot title font.
System.Drawing.Drawing2D.SmoothingMode SmoothingMode
 Smoothing mode to use when drawing plots.
Axis XAxis1
 The bottom abscissa axis.
Axis XAxis2
 The top abscissa axis.
Axis YAxis1
 The left ordinate axis.
Axis YAxis2
 The right ordinate axis.
ArrayList Drawables
 Gets an array list containing all drawables currently added to the PlotSurface2D.

Detailed Description

Defines the PlotSurface2D interface - All specific PlotSurface2D classes that use PlotSurface2D for their underlying operations should implement this class.

Definition at line 62 of file IPlotSurface2D.cs.


Member Function Documentation

void NPlot::IPlotSurface2D::Add IDrawable  p,
NPlot.PlotSurface2D.XAxisPosition  xax,
NPlot.PlotSurface2D.YAxisPosition  yax
 

Adds a drawable object to the plot surface against the specified axes.

If the object is an IPlot, the PlotSurface2D axes will also be updated.

Parameters:
p the IDrawable object to add to the plot surface
xax the x-axis to add the plot against.
yax the y-axis to add the plot against.

void NPlot::IPlotSurface2D::Add IDrawable  p  ) 
 

Adds a drawable object to the plot surface.

If the object is an IPlot, the PlotSurface2D axes will also be updated.

Parameters:
p The IDrawable object to add to the plot surface.

Implemented in NPlot::Bitmap::PlotSurface2D, NPlot::PlotSurface2D, NPlot::Web::PlotSurface2D, and NPlot::Windows::PlotSurface2D.

void NPlot::IPlotSurface2D::Add IDrawable  p,
NPlot.PlotSurface2D.XAxisPosition  xp,
NPlot.PlotSurface2D.YAxisPosition  yp,
int  zOrder
 

Adds a drawable object to the plot surface against the specified axes.

If the object is an IPlot, the PlotSurface2D axes will also be updated.

Parameters:
p the IDrawable object to add to the plot surface
xp the x-axis to add the plot against.
yp the y-axis to add the plot against.
zOrder The z-ordering when drawing (objects with lower numbers are drawn first)

void NPlot::IPlotSurface2D::Add IDrawable  p,
int  zOrder
 

Adds a drawable object to the plot surface.

If the object is an IPlot, the PlotSurface2D axes will also be updated.

Parameters:
p The IDrawable object to add to the plot surface.
zOrder The z-ordering when drawing (objects with lower numbers are drawn first)

Implemented in NPlot::Bitmap::PlotSurface2D, NPlot::PlotSurface2D, NPlot::Web::PlotSurface2D, and NPlot::Windows::PlotSurface2D.

void NPlot::IPlotSurface2D::AddAxesConstraint AxesConstraint  c  ) 
 

Add an axis constraint to the plot surface.

Axis constraints can specify relative world-pixel scalings, absolute axis positions etc.

Parameters:
c The axis constraint to add.

Implemented in NPlot::Bitmap::PlotSurface2D, NPlot::PlotSurface2D, NPlot::Web::PlotSurface2D, and NPlot::Windows::PlotSurface2D.

void NPlot::IPlotSurface2D::Clear  ) 
 

Clears the PlotSurface2D.

Implemented in NPlot::Bitmap::PlotSurface2D, NPlot::PlotSurface2D, NPlot::Web::PlotSurface2D, and NPlot::Windows::PlotSurface2D.

void NPlot::IPlotSurface2D::Remove IDrawable  p,
bool  updateAxes
 

Remove a drawable object from the plot surface.

Parameters:
p the object to remove
updateAxes whether or not to update the axes after removal.

Implemented in NPlot::Bitmap::PlotSurface2D, NPlot::PlotSurface2D, NPlot::Web::PlotSurface2D, and NPlot::Windows::PlotSurface2D.


Property Documentation

bool NPlot::IPlotSurface2D::AutoScaleAutoGeneratedAxes [get, set]
 

When plots are added to the plot surface, the axes they are attached to are immediately modified to reflect data of the plot.

If AutoScaleAutoGeneratedAxes is true when a plot is added, the axes will be turned in to auto scaling ones if they are not already [tick marks, tick text and label size scaled to size of plot surface]. If false, axes will not be autoscaling.

Implemented in NPlot::Bitmap::PlotSurface2D, NPlot::PlotSurface2D, NPlot::Web::PlotSurface2D, and NPlot::Windows::PlotSurface2D.

Definition at line 166 of file IPlotSurface2D.cs.

bool NPlot::IPlotSurface2D::AutoScaleTitle [get, set]
 

Whether or not the title will be scaled according to size of the plot surface.

Implemented in NPlot::Bitmap::PlotSurface2D, NPlot::PlotSurface2D, NPlot::Web::PlotSurface2D, and NPlot::Windows::PlotSurface2D.

Definition at line 155 of file IPlotSurface2D.cs.

ArrayList NPlot::IPlotSurface2D::Drawables [get]
 

Gets an array list containing all drawables currently added to the PlotSurface2D.

Implemented in NPlot::Bitmap::PlotSurface2D, NPlot::PlotSurface2D, NPlot::Web::PlotSurface2D, and NPlot::Windows::PlotSurface2D.

Definition at line 236 of file IPlotSurface2D.cs.

NPlot.Legend NPlot::IPlotSurface2D::Legend [get, set]
 

Gets or Sets the legend to use with this plot surface.

Implemented in NPlot::Bitmap::PlotSurface2D, NPlot::PlotSurface2D, NPlot::Web::PlotSurface2D, and NPlot::Windows::PlotSurface2D.

Definition at line 112 of file IPlotSurface2D.cs.

int NPlot::IPlotSurface2D::LegendZOrder [get, set]
 

Setting this value determines the order (relative to IDrawables added to the plot surface) that the legend is drawn.

Implemented in NPlot::Bitmap::PlotSurface2D, NPlot::PlotSurface2D, NPlot::Web::PlotSurface2D, and NPlot::Windows::PlotSurface2D.

Definition at line 118 of file IPlotSurface2D.cs.

int NPlot::IPlotSurface2D::Padding [get, set]
 

The distance in pixels to leave between of the edge of the bounding rectangle supplied to the Draw method, and the markings that make up the plot.

Implemented in NPlot::Bitmap::PlotSurface2D, NPlot::PlotSurface2D, NPlot::Web::PlotSurface2D, and NPlot::Windows::PlotSurface2D.

Definition at line 124 of file IPlotSurface2D.cs.

IRectangleBrush NPlot::IPlotSurface2D::PlotBackBrush [set]
 

A Rectangle brush used to paint the plot background.

Mutually exclusive with PlotBackColor and PlotBackBrush

Implemented in NPlot::Bitmap::PlotSurface2D, NPlot::PlotSurface2D, NPlot::Web::PlotSurface2D, and NPlot::Windows::PlotSurface2D.

Definition at line 142 of file IPlotSurface2D.cs.

System.Drawing.Color NPlot::IPlotSurface2D::PlotBackColor [set]
 

A color used to paint the plot background.

Mutually exclusive with PlotBackImage and PlotBackBrush

Implemented in NPlot::Bitmap::PlotSurface2D, NPlot::PlotSurface2D, NPlot::Web::PlotSurface2D, and NPlot::Windows::PlotSurface2D.

Definition at line 130 of file IPlotSurface2D.cs.

System.Drawing.Bitmap NPlot::IPlotSurface2D::PlotBackImage [set]
 

An imaged used to paint the plot background.

Mutually exclusive with PlotBackColor and PlotBackBrush

Implemented in NPlot::Bitmap::PlotSurface2D, NPlot::PlotSurface2D, NPlot::Web::PlotSurface2D, and NPlot::Windows::PlotSurface2D.

Definition at line 136 of file IPlotSurface2D.cs.

System.Drawing.Drawing2D.SmoothingMode NPlot::IPlotSurface2D::SmoothingMode [get, set]
 

Smoothing mode to use when drawing plots.

Implemented in NPlot::Bitmap::PlotSurface2D, NPlot::PlotSurface2D, NPlot::Web::PlotSurface2D, and NPlot::Windows::PlotSurface2D.

Definition at line 190 of file IPlotSurface2D.cs.

string NPlot::IPlotSurface2D::Title [get, set]
 

The plot surface title.

Implemented in NPlot::Bitmap::PlotSurface2D, NPlot::PlotSurface2D, NPlot::Web::PlotSurface2D, and NPlot::Windows::PlotSurface2D.

Definition at line 148 of file IPlotSurface2D.cs.

System.Drawing.Brush NPlot::IPlotSurface2D::TitleBrush [get, set]
 

The brush used for drawing the title.

Implemented in NPlot::Bitmap::PlotSurface2D, NPlot::PlotSurface2D, NPlot::Web::PlotSurface2D, and NPlot::Windows::PlotSurface2D.

Definition at line 178 of file IPlotSurface2D.cs.

System.Drawing.Color NPlot::IPlotSurface2D::TitleColor [set]
 

Sets the title to be drawn using a solid brush of this color.

Implemented in NPlot::Bitmap::PlotSurface2D, NPlot::PlotSurface2D, NPlot::Web::PlotSurface2D, and NPlot::Windows::PlotSurface2D.

Definition at line 172 of file IPlotSurface2D.cs.

System.Drawing.Font NPlot::IPlotSurface2D::TitleFont [get, set]
 

The plot title font.

Implemented in NPlot::Bitmap::PlotSurface2D, NPlot::PlotSurface2D, NPlot::Web::PlotSurface2D, and NPlot::Windows::PlotSurface2D.

Definition at line 184 of file IPlotSurface2D.cs.

Axis NPlot::IPlotSurface2D::XAxis1 [get, set]
 

The bottom abscissa axis.

Implemented in NPlot::Bitmap::PlotSurface2D, NPlot::PlotSurface2D, NPlot::Web::PlotSurface2D, and NPlot::Windows::PlotSurface2D.

Definition at line 204 of file IPlotSurface2D.cs.

Axis NPlot::IPlotSurface2D::XAxis2 [get, set]
 

The top abscissa axis.

Implemented in NPlot::Bitmap::PlotSurface2D, NPlot::PlotSurface2D, NPlot::Web::PlotSurface2D, and NPlot::Windows::PlotSurface2D.

Definition at line 210 of file IPlotSurface2D.cs.

Axis NPlot::IPlotSurface2D::YAxis1 [get, set]
 

The left ordinate axis.

Implemented in NPlot::Bitmap::PlotSurface2D, NPlot::PlotSurface2D, NPlot::Web::PlotSurface2D, and NPlot::Windows::PlotSurface2D.

Definition at line 216 of file IPlotSurface2D.cs.

Axis NPlot::IPlotSurface2D::YAxis2 [get, set]
 

The right ordinate axis.

Implemented in NPlot::Bitmap::PlotSurface2D, NPlot::PlotSurface2D, NPlot::Web::PlotSurface2D, and NPlot::Windows::PlotSurface2D.

Definition at line 222 of file IPlotSurface2D.cs.


The documentation for this interface was generated from the following file:
Generated on Sat Nov 5 01:04:08 2005 for NPlot by  doxygen 1.4.5