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

An axis for displaying date/time values. More...

#include <dateaxis.h>

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

Public Member Functions

 DateAxis (AXIS_LOCATION location)
 
virtual bool UpdateBounds () wxOVERRIDE
 Performs axis bounds update after dataset/s change.
 
void SetDateFormat (const wxString &dateFormat)
 Sets date format for date labels. More...
 
virtual void GetDataBounds (double &minValue, double &maxValue) const
 Returns data bounds. More...
 
- Public Member Functions inherited from LabelAxis
 LabelAxis (AXIS_LOCATION location)
 
void SetTitle (const wxString &title)
 Sets axis title. More...
 
const wxString & GetTitle ()
 Returns axis title. More...
 
void SetTitleLocation (int location)
 Sets axis title location. More...
 
int GetTitleLocation ()
 Returns axis title location. More...
 
void SetTitleFont (wxFont &font)
 Sets axis title font. More...
 
const wxFont & GetTitleFont ()
 Returns axis title font. More...
 
void SetTitleColour (wxColour &colour)
 Sets axis title colour. More...
 
wxColour GetTitleColour ()
 Returns axis title colour. More...
 
void SetLabelPen (wxPen labelPen)
 Sets pen for label lines. More...
 
void SetLabelTextColour (wxColour labelTextColour)
 Sets colour for labels. More...
 
wxColour GetLabelTextColour ()
 Returns label colour. More...
 
void SetLabelTextFont (wxFont labelTextFont)
 Sets font for labels text. More...
 
const wxFont & GetLabelTextFont ()
 Returns label font. More...
 
void SetVerticalLabelText (bool verticalLabelText)
 Sets whether to draw labels text vertical. More...
 
bool GetVerticalLabelText ()
 Returns whether to draw labels text vertical. More...
 
 wxDEPRECATED_MSG ("Use SetMinorIntervalCount instead.") void SetMajorLabelSteps(size_t step)
 Sets major label steps. More...
 
void SetMinorIntervalCount (size_t count)
 Set the number of ticks between each label (major interval). More...
 
size_t GetMinorIntervalCout ()
 Get the number of ticks between each label (major interval). More...
 
void SetLabelSkip (int blankLabels)
 
int GetLabelSkip ()
 
void SetLabelColourer (LabelColourer *labelColourer)
 
LabelColourerGetLabelColourer ()
 
void SetAxisVisible (bool bVisible)
 Sets visibility of axis. More...
 
virtual void Draw (wxDC &dc, wxRect rc)
 Performs axis drawing. More...
 
virtual void DrawGridLines (wxDC &dc, wxRect rc)
 Draws grid lines for axis. 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...
 
- 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...
 
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...
 

Protected Member Functions

virtual bool AcceptDataset (Dataset *dataset)
 Checks whether dataset can be accepted by this axis. More...
 
virtual double GetValue (size_t step)
 Returns value on step. More...
 
virtual void GetLabel (size_t step, wxString &label)
 Returns label on step. More...
 
virtual bool IsEnd (size_t step)
 Check whether step is last. More...
 
virtual wxSize GetLongestLabelExtent (wxDC &dc)
 
- Protected Member Functions inherited from LabelAxis
virtual bool HasLabels ()
 

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

An axis for displaying date/time values.

TODO:

Definition at line 21 of file dateaxis.h.

Member Function Documentation

virtual bool DateAxis::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.

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

Returns data bounds.

Parameters
minValueoutput minimal data value
maxValueoutput maximal data value

Implements Axis.

virtual void DateAxis::GetLabel ( size_t  step,
wxString &  label 
)
protectedvirtual

Returns label on step.

Parameters
stepstep index
labeloutput label

Implements LabelAxis.

virtual double DateAxis::GetValue ( size_t  step)
protectedvirtual

Returns value on step.

Parameters
stepstep index
Returns
value on step

Implements LabelAxis.

virtual bool DateAxis::IsEnd ( size_t  step)
protectedvirtual

Check whether step is last.

Parameters
stepstep
Returns
true if step is last

Implements LabelAxis.

void DateAxis::SetDateFormat ( const wxString &  dateFormat)
inline

Sets date format for date labels.

Parameters
dateFormatdate format in strftime style

Definition at line 34 of file dateaxis.h.

References Axis::AcceptDataset(), Axis::GetDataBounds(), LabelAxis::GetLabel(), LabelAxis::GetValue(), and LabelAxis::IsEnd().


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