AxisPlot Class Reference

#include <axisplot.h>

Inheritance diagram for AxisPlot:

Inheritance graph
[legend]
Collaboration diagram for AxisPlot:

Collaboration graph
[legend]

List of all members.

Public Member Functions

void AddAxis (Axis *axis)
void AddDataset (Dataset *dataset)
void AddObjects (Dataset *dataset, Axis *verticalAxis, Axis *horizontalAxis)
size_t GetDatasetCount ()
DatasetGetDataset (size_t index)
void LinkDataHorizontalAxis (size_t nData, size_t nAxis)
void LinkDataVerticalAxis (size_t nData, size_t nAxis)
AxisGetDatasetAxis (Dataset *dataset, size_t index, bool vertical)
AxisGetDatasetAxis (Dataset *dataset, bool vertical)
AxisGetDatasetVerticalAxis (Dataset *dataset)
AxisGetDatasetHorizontalAxis (Dataset *dataset)
DatasetGetAxisDataset (Axis *axis, size_t index)
void SetDrawGrid (bool drawGridVertical, bool drawGridHorizontal)
void SetDataBackground (AreaDraw *dataBackground)
void SetLegend (Legend *legend)
bool ToDataCoords (size_t nData, wxDC &dc, wxRect rc, wxCoord gx, wxCoord gy, double *x, double *y)
virtual void NeedRedraw (DrawObject *obj)
virtual void DatasetChanged (Dataset *dataset)
virtual void AxisChanged (Axis *axis)
virtual void BoundsChanged (Axis *axis)

Protected Member Functions

virtual bool AcceptAxis (Axis *axis)=0
virtual bool AcceptDataset (Dataset *dataset)=0
virtual void DrawDatasets (wxDC &dc, wxRect rc)=0
wxCoord GetAxesExtent (wxDC &dc, AxisArray *axes)


Detailed Description

Base class for plots that supports axes.

Member Function Documentation

virtual bool AxisPlot::AcceptAxis ( Axis axis  )  [protected, pure virtual]

Checks whether axis is acceptable with this plot.

Parameters:
axis axis to be checked
Returns:
true if axis can be accepted, false overwise

Implemented in BarPlot, GanttPlot, OHLCPlot, XYPlot, and BubblePlot.

virtual bool AxisPlot::AcceptDataset ( Dataset dataset  )  [protected, pure virtual]

Checks whether dataset is acceptable with this plot.

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

Implemented in BarPlot, GanttPlot, OHLCPlot, XYPlot, and BubblePlot.

void AxisPlot::AddAxis ( Axis axis  ) 

Adds axis to plot.

Parameters:
axis axis to be added

void AxisPlot::AddDataset ( Dataset dataset  ) 

Adds dataset to plot.

Parameters:
dataset dataset to be added

void AxisPlot::AddObjects ( Dataset dataset,
Axis verticalAxis,
Axis horizontalAxis 
)

Adds dataset and vertical and horizontal axes to plot. And links it all together.

Parameters:
dataset dataset to be added
verticalAxis vertical axis to be added
horizontalAxis horizontal axis to be added

virtual void AxisPlot::AxisChanged ( Axis axis  )  [virtual]

Called when axis is changed.

Parameters:
axis changed axis

Implements AxisObserver.

virtual void AxisPlot::BoundsChanged ( Axis axis  )  [virtual]

Called when axis bounds are changed.

Parameters:
axis axis that bounds are changed

Implements AxisObserver.

virtual void AxisPlot::DrawDatasets ( wxDC &  dc,
wxRect  rc 
) [protected, pure virtual]

Called to draw all datasets.

Parameters:
dc device context
rc rectangle where to draw

Implemented in BarPlot, GanttPlot, OHLCPlot, XYPlot, and BubblePlot.

Dataset* AxisPlot::GetAxisDataset ( Axis axis,
size_t  index 
) [inline]

Returns dataset, linked with axis at specified index.

Parameters:
axis axis
index dataset index
Returns:
dataset at index

References Axis::GetDataset().

Dataset* AxisPlot::GetDataset ( size_t  index  ) 

Return dataset with index

Parameters:
index index of dataset
Returns:
dataset or NULL if index is out of bounds

Axis* AxisPlot::GetDatasetAxis ( Dataset dataset,
bool  vertical 
)

Returns main dataset axis. NOTE: main axis is the first axis linked with dataset. Main axis is used to scale dataset values.

Parameters:
dataset dataset
vertical true if you want to get vertical axis, false - horizontal
Returns:
main axis for dataset or NULL if dataset has no main axis

Axis* AxisPlot::GetDatasetAxis ( Dataset dataset,
size_t  index,
bool  vertical 
)

Returns dataset axis.

Parameters:
dataset dataset
index axis index, 0 - for main axis
vertical true if you want to get vertical axis, false - horizontal
Returns:
main axis for dataset or NULL if dataset has no main axis

size_t AxisPlot::GetDatasetCount (  ) 

Returns dataset count.

Returns:
dataset count

Axis* AxisPlot::GetDatasetHorizontalAxis ( Dataset dataset  )  [inline]

Returns main horizontal dataset axis. NOTE: main axis is the first axis linked with dataset. Main axis is used to scale dataset values.

Parameters:
dataset dataset
Returns:
main axis for dataset or NULL if dataset has no main axis

Axis* AxisPlot::GetDatasetVerticalAxis ( Dataset dataset  )  [inline]

Returns main vertical dataset axis. NOTE: main axis is the first axis linked with dataset. Main axis is used to scale dataset values.

Parameters:
dataset dataset
Returns:
main axis for dataset or NULL if dataset has no main axis

void AxisPlot::LinkDataHorizontalAxis ( size_t  nData,
size_t  nAxis 
)

Links dataset with horizontal axis

Parameters:
nData index of dataset
nAxis index of horizontal axis

void AxisPlot::LinkDataVerticalAxis ( size_t  nData,
size_t  nAxis 
)

Links dataset with vertical axis

Parameters:
nData index of dataset
nAxis index of vertical axis

void AxisPlot::SetDataBackground ( AreaDraw dataBackground  ) 

Sets background for data area.

Parameters:
dataBackground background for data area

void AxisPlot::SetDrawGrid ( bool  drawGridVertical,
bool  drawGridHorizontal 
)

Set whether to draw grid lines.

Parameters:
drawGridVertical if true - plot will draw vertical grid lines
drawGridHorizontal if true - plot will draw horizontal grid lines

void AxisPlot::SetLegend ( Legend legend  ) 

Sets legend to plot. Plot take ownership of legend.

Parameters:
legend new legend for plot

bool AxisPlot::ToDataCoords ( size_t  nData,
wxDC &  dc,
wxRect  rc,
wxCoord  gx,
wxCoord  gy,
double *  x,
double *  y 
)

Translate coordinate from graphics to data space.

Parameters:
nData number of dataset
dc device context
rc plot rectangle
gx x coordinate in graphics space
gy y coordinate in graphics space
x output for x coordinate in data space
y output for y coordinate in data space
Returns:
true if coordinate was succesfully translated, false - overwise


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

Generated on Mon Feb 15 21:32:22 2010 for wxFreeChart by  doxygen 1.5.8