NPlot::StepPlot Class Reference

Encapsulates functionality for plotting data as a stepped line. More...

Inheritance diagram for NPlot::StepPlot:

NPlot::BaseSequencePlot NPlot::IPlot NPlot::ISequencePlot NPlot::BasePlot NPlot::ISequencePlot NPlot::IDrawable List of all members.

Public Member Functions

 StepPlot ()
 Constructor.
virtual void Draw (Graphics g, PhysicalAxis xAxis, PhysicalAxis yAxis)
 Draws the step plot on a GDI+ surface against the provided x and y axes.
Axis SuggestXAxis ()
 Returns an X-axis suitable for use by this plot.
Axis SuggestYAxis ()
 Returns an Y-axis suitable for use by this plot.
virtual void DrawInLegend (Graphics g, Rectangle startEnd)
 Draws a representation of this plot in the legend.

Properties

bool Center
 Gets or sets whether or not steps should be centered.
bool center_
System.Drawing.Pen Pen
 The pen used to draw the plot.
System.Drawing.Pen pen_ = new Pen(Color.Black)
System.Drawing.Color Color
 The color of the pen used to draw lines in this plot.
bool HideVerticalSegments
 If true, then vertical lines are hidden.
bool hideVerticalSegments_ = false
bool HideHorizontalSegments
 If true, then vertical lines are hidden.
bool hideHorizontalSegments_ = false
float WidthScale
 The horizontal line length is multiplied by this amount.
float scale_ = 1.0f

Detailed Description

Encapsulates functionality for plotting data as a stepped line.

Definition at line 61 of file StepPlot.cs.


Constructor & Destructor Documentation

NPlot::StepPlot::StepPlot  )  [inline]
 

Constructor.

Definition at line 67 of file StepPlot.cs.


Member Function Documentation

virtual void NPlot::StepPlot::Draw Graphics  g,
PhysicalAxis  xAxis,
PhysicalAxis  yAxis
[inline, virtual]
 

Draws the step plot on a GDI+ surface against the provided x and y axes.

Parameters:
g The GDI+ surface on which to draw.
xAxis The X-Axis to draw against.
yAxis The Y-Axis to draw against.

Implements NPlot::IDrawable.

Definition at line 79 of file StepPlot.cs.

References NPlot::BaseSequencePlot::AbscissaData, center_, NPlot::SequenceAdapter::Count, NPlot::ISequencePlot::DataMember, NPlot::ISequencePlot::DataSource, hideHorizontalSegments_, hideVerticalSegments_, NPlot::BaseSequencePlot::OrdinateData, Pen, scale_, NPlot::PhysicalAxis::WorldToPhysical(), NPlot::PointD::X, and NPlot::PointD::Y.

virtual void NPlot::StepPlot::DrawInLegend Graphics  g,
Rectangle  startEnd
[inline, virtual]
 

Draws a representation of this plot in the legend.

Parameters:
g The graphics surface on which to draw.
startEnd A rectangle specifying the bounds of the area in the legend set aside for drawing.

Implements NPlot::IPlot.

Definition at line 237 of file StepPlot.cs.

References pen_.

Axis NPlot::StepPlot::SuggestXAxis  )  [inline]
 

Returns an X-axis suitable for use by this plot.

The axis will be one that is just long enough to show all data.

Returns:
X-axis suitable for use by this plot.

Implements NPlot::IPlot.

Definition at line 159 of file StepPlot.cs.

References NPlot::BaseSequencePlot::AbscissaData, center_, NPlot::SequenceAdapter::Count, NPlot::ISequencePlot::DataMember, NPlot::ISequencePlot::DataSource, NPlot::BaseSequencePlot::OrdinateData, NPlot::SequenceAdapter::SuggestXAxis(), NPlot::Axis::WorldMax, NPlot::Axis::WorldMin, and NPlot::PointD::X.

Axis NPlot::StepPlot::SuggestYAxis  )  [inline]
 

Returns an Y-axis suitable for use by this plot.

The axis will be one that is just long enough to show all data.

Returns:
Y-axis suitable for use by this plot.

Implements NPlot::IPlot.

Definition at line 204 of file StepPlot.cs.

References NPlot::BaseSequencePlot::AbscissaData, NPlot::ISequencePlot::DataMember, NPlot::ISequencePlot::DataSource, NPlot::BaseSequencePlot::OrdinateData, and NPlot::SequenceAdapter::SuggestYAxis().


Property Documentation

bool NPlot::StepPlot::Center [get, set]
 

Gets or sets whether or not steps should be centered.

If true, steps will be centered on the X abscissa values. If false, the step corresponding to a given x-value will be drawn between this x-value and the next x-value at the current y-height.

Definition at line 219 of file StepPlot.cs.

bool NPlot::StepPlot::center_ [private]
 

Definition at line 229 of file StepPlot.cs.

Referenced by Draw(), and SuggestXAxis().

System.Drawing.Color NPlot::StepPlot::Color [get, set]
 

The color of the pen used to draw lines in this plot.

Definition at line 265 of file StepPlot.cs.

bool NPlot::StepPlot::HideHorizontalSegments [get, set]
 

If true, then vertical lines are hidden.

Definition at line 305 of file StepPlot.cs.

bool NPlot::StepPlot::hideHorizontalSegments_ = false [private]
 

Definition at line 315 of file StepPlot.cs.

Referenced by Draw().

bool NPlot::StepPlot::HideVerticalSegments [get, set]
 

If true, then vertical lines are hidden.

Definition at line 288 of file StepPlot.cs.

bool NPlot::StepPlot::hideVerticalSegments_ = false [private]
 

Definition at line 298 of file StepPlot.cs.

Referenced by Draw().

System.Drawing.Pen NPlot::StepPlot::Pen [get, set]
 

The pen used to draw the plot.

Definition at line 248 of file StepPlot.cs.

Referenced by Draw().

System.Drawing.Pen NPlot::StepPlot::pen_ = new Pen(Color.Black) [private]
 

Definition at line 258 of file StepPlot.cs.

Referenced by DrawInLegend().

float NPlot::StepPlot::scale_ = 1.0f [private]
 

Definition at line 333 of file StepPlot.cs.

Referenced by Draw().

float NPlot::StepPlot::WidthScale [get, set]
 

The horizontal line length is multiplied by this amount.

Default corresponds to a value of 1.0.

Definition at line 323 of file StepPlot.cs.


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