wxFreeChart
Public Member Functions | Protected Member Functions | List of all members
AxisShare Class Reference

Used to combine axes. More...

#include <axis.h>

Inheritance diagram for AxisShare:
Inheritance graph
[legend]
Collaboration diagram for AxisShare:
Collaboration graph
[legend]

Public Member Functions

 AxisShare (Axis *axis)
 
void SetShareVisible (bool shareVisible)
 Sets axis share visible or not. More...
 
virtual void GetDataBounds (double &minValue, double &maxValue) const
 Returns data bounds. More...
 
virtual wxCoord GetExtent (wxDC &dc)
 Used to determine minimal size needed to draw axis contents, minimal width for vertical axes, minimal height for horizontal. More...
 
virtual bool IsVisible (double value)
 Checks whether data value is visible. More...
 
virtual double BoundValue (double value)
 Returns nearest boundary value. More...
 
virtual wxCoord ToGraphics (wxDC &dc, int minCoord, int gRange, double value)
 Transforms coordinate from data space to graphics space. More...
 
virtual double ToData (wxDC &dc, int minCoord, int gRange, wxCoord g)
 Transforms coordinate from graphics space to data space. More...
 
virtual bool UpdateBounds () wxOVERRIDE
 Performs axis bounds update after dataset/s change.
 
virtual void Draw (wxDC &dc, wxRect rc)
 Performs axis drawing. More...
 
virtual void DrawGridLines (wxDC &dc, wxRect rcData)
 Draws grid lines for axis. More...
 
- Public Member Functions inherited from Axis
 Axis (AXIS_LOCATION location)
 Constructs new axis. More...
 
AXIS_LOCATION GetLocation ()
 Returns axis location. More...
 
bool IsVertical ()
 Checks whether axis is vertical. More...
 
bool IsHorizontal ()
 Checks whether axis is horizontal. More...
 
void SetMargins (wxCoord marginMin, wxCoord marginMax)
 Sets minimal/maximal margins for axis. More...
 
void SetMajorGridlinePen (const wxPen &pen)
 Sets the pen to be used for drawing major gridlines. More...
 
void SetMinorGridlinePen (const wxPen &pen)
 Sets the pen to be used for drawing minor gridlines. More...
 
const wxPen & GetMajorGridlinePen ()
 Gets the pen that is currently used to draw major gridlines on this axis. More...
 
const wxPen & GetMinorGridlinePen ()
 Gets the pen that is currently used to draw minor gridlines on this axis. More...
 
size_t GetDatasetCount ()
 Returns dataset counts, linked with this axis. More...
 
DatasetGetDataset (size_t index)
 Returns dataset, linked with this axis at specified index. More...
 
void SetZoomPanMode ()
 
void SetWindowWidth (double winWidth)
 Sets window width. More...
 
double GetWindowWidth ()
 Returns window width. More...
 
void SetWindowPosition (double winPos)
 Sets window position. More...
 
double GetWindowPosition ()
 Returns window position. More...
 
void SetUseWindow (bool useWin)
 Sets whether to use window. More...
 
void SetWindow (double winPos, double winWidth)
 Sets window params (position and width). More...
 
bool IntersectsWindow (double v0, double v1)
 Checks whether line in data space intersects window. More...
 
void GetWindowBounds (double &winMin, double &winMax)
 Returns window bounds. More...
 
void AddDataset (Dataset *dataset)
 internal. More...
 

Protected Member Functions

virtual bool AcceptDataset (Dataset *dataset)
 Checks whether dataset can be accepted by this axis. More...
 

Additional Inherited Members

- Protected Attributes inherited from Axis
DatasetArray m_datasets
 
wxPen m_majorGridlinePen
 
wxPen m_minorGridlinePen
 
wxCoord m_marginMin
 
wxCoord m_marginMax
 
double m_winPos
 
double m_winWidth
 
bool m_useWin
 

Detailed Description

Used to combine axes.

Shares axis between plots.

Definition at line 351 of file axis.h.

Member Function Documentation

virtual bool AxisShare::AcceptDataset ( Dataset dataset)
protectedvirtual

Checks whether dataset can be accepted by this axis.

Must be implemented by derivative classes. XXX: maybe remove this method later.

Parameters
datasetdataset to be checked
Returns
true - if dataset can be accepted, false overwise

Implements Axis.

Referenced by Axis::AddDataset().

virtual double AxisShare::BoundValue ( double  value)
virtual

Returns nearest boundary value.

Parameters
valueout of bounds value, for which will be returned boundary value
Returns
nearest boundary value

Reimplemented from Axis.

Referenced by Axis::AddDataset().

virtual void AxisShare::Draw ( wxDC &  dc,
wxRect  rc 
)
virtual

Performs axis drawing.

Parameters
dcdevice context
rcrectangle where to draw

Implements Axis.

Referenced by Axis::AddDataset().

virtual void AxisShare::DrawGridLines ( wxDC &  dc,
wxRect  rcData 
)
virtual

Draws grid lines for axis.

Parameters
dcdevice context
rcdata area rectangle of plot

Implements Axis.

Referenced by Axis::AddDataset().

virtual void AxisShare::GetDataBounds ( double &  minValue,
double &  maxValue 
) const
virtual

Returns data bounds.

Parameters
minValueoutput minimal data value
maxValueoutput maximal data value

Implements Axis.

Referenced by Axis::AddDataset(), and Axis::GetWindowBounds().

virtual wxCoord AxisShare::GetExtent ( wxDC &  dc)
virtual

Used to determine minimal size needed to draw axis contents, minimal width for vertical axes, minimal height for horizontal.

Parameters
dcdevice context
Returns
extent

Implements Axis.

Referenced by Axis::AddDataset().

virtual bool AxisShare::IsVisible ( double  value)
virtual

Checks whether data value is visible.

Parameters
valuevalue in data space
Returns
true if data value is visible

Reimplemented from Axis.

Referenced by Axis::AddDataset().

void AxisShare::SetShareVisible ( bool  shareVisible)

Sets axis share visible or not.

Note: by default axis share is invisible.

Parameters
shareVisibletrue to set share visible
virtual double AxisShare::ToData ( wxDC &  dc,
int  minCoord,
int  gRange,
wxCoord  g 
)
virtual

Transforms coordinate from graphics space to data space.

Parameters
dcdevice context
minCoordminimal graphics space coordinate
gRangegraphics space range
valuevalue in data space
Returns
coordinate in data space

Reimplemented from Axis.

Referenced by Axis::AddDataset().

virtual wxCoord AxisShare::ToGraphics ( wxDC &  dc,
int  minCoord,
int  gRange,
double  value 
)
virtual

Transforms coordinate from data space to graphics space.

Parameters
dcdevice context
minCoordminimal graphics space coordinate
gRangegraphics space range
valuevalue in data space
Returns
value in graphics space

Reimplemented from Axis.

Referenced by Axis::AddDataset().


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