cee::plt::AxisSettings Class Reference

Axis settings for an OverlayPlot object. More...

Public Member Functions

Color3f axisColor () const
 Returns the color of the axes. More...
 
void setAxisColor (const Color3f &color)
 Sets the axis color. More...
 
Str xAxisTitle () const
 Returns the title of the x axis. More...
 
void setXAxisTitle (const Str &title)
 Sets the title of the x axis. More...
 
Str yAxisTitle () const
 Returns the title of the y axis. More...
 
void setYAxisTitle (const Str &title)
 Sets the title of the y axis. More...
 
bool drawGridLines () const
 Returns true if grid lines are drawn. More...
 
void setDrawGridLines (bool drawGridLines)
 Draws grid lines if set to true. Hides them if set two false. More...
 
bool showRangeInTitle () const
 Returns true if scalar minimum and maximum values should be included int the axis titles. More...
 
void setShowRangeInTitle (bool show)
 Sets if scalar minimum and maximum values should be included int the axis titles. More...
 
Color3f gridLinesColor () const
 Returns the grid line color. More...
 
void setGridLinesColor (const Color3f &color)
 Sets the grid line color. More...
 
bool useAutoRange () const
 Returns true if axis range is set using auto range. More...
 
void setUseAutoRange (bool autoRange)
 Sets the axis range to be set using auto range if set to true. More...
 
double xAxisRangeMinimum () const
 Returns the minimum range value for the x axis. More...
 
double xAxisRangeMaximum () const
 Returns the maximum range value for the x axis. More...
 
void setXAxisRange (double min, double max)
 Sets x axis range. More...
 
double yAxisRangeMinimum () const
 Returns the minimum range value for the y axis. More...
 
double yAxisRangeMaximum () const
 Returns the maximum range value for the y axis. More...
 
void setYAxisRange (double min, double max)
 Sets y axis range. More...
 
void setYAxisUseLogarithmicScale (bool useLog)
 If true, uses logarithmic scaling on y axis. More...
 
bool yAxisUseLogarithmicScale () const
 Returns true if y axis uses logarithmic scaling. More...
 
void setXAxisUseLogarithmicScale (bool useLog)
 If true, uses logarithmic scaling on y axis. More...
 
bool xAxisUseLogarithmicScale () const
 Returns true if X axis uses logarithmic scaling. More...
 
void forceRangeUpdate ()
 Recalculates axis ranges. More...
 

Detailed Description

Axis settings for an OverlayPlot object.

See also
OverlayPlot

Member Function Documentation

cee::Color3f cee::plt::AxisSettings::axisColor ( ) const

Returns the color of the axes.

bool cee::plt::AxisSettings::drawGridLines ( ) const

Returns true if grid lines are drawn.

void cee::plt::AxisSettings::forceRangeUpdate ( )

Recalculates axis ranges.

Used when curve values have been changed manually. (Curve::setValues())

cee::Color3f cee::plt::AxisSettings::gridLinesColor ( ) const

Returns the grid line color.

void cee::plt::AxisSettings::setAxisColor ( const Color3f color)

Sets the axis color.

void cee::plt::AxisSettings::setDrawGridLines ( bool  drawGridLines)

Draws grid lines if set to true. Hides them if set two false.

void cee::plt::AxisSettings::setGridLinesColor ( const Color3f color)

Sets the grid line color.

void cee::plt::AxisSettings::setShowRangeInTitle ( bool  show)

Sets if scalar minimum and maximum values should be included int the axis titles.

void cee::plt::AxisSettings::setUseAutoRange ( bool  autoRange)

Sets the axis range to be set using auto range if set to true.

void cee::plt::AxisSettings::setXAxisRange ( double  min,
double  max 
)

Sets x axis range.

Will only apply if auto range is toggled off. The manually set range will be reset when auto range is toggled on.

void cee::plt::AxisSettings::setXAxisTitle ( const Str title)

Sets the title of the x axis.

void cee::plt::AxisSettings::setXAxisUseLogarithmicScale ( bool  useLog)

If true, uses logarithmic scaling on y axis.

void cee::plt::AxisSettings::setYAxisRange ( double  min,
double  max 
)

Sets y axis range.

Will only apply if auto range is toggled off. The manually set range will be reset when auto range is toggled on.

void cee::plt::AxisSettings::setYAxisTitle ( const Str title)

Sets the title of the y axis.

void cee::plt::AxisSettings::setYAxisUseLogarithmicScale ( bool  useLog)

If true, uses logarithmic scaling on y axis.

bool cee::plt::AxisSettings::showRangeInTitle ( ) const

Returns true if scalar minimum and maximum values should be included int the axis titles.

bool cee::plt::AxisSettings::useAutoRange ( ) const

Returns true if axis range is set using auto range.

double cee::plt::AxisSettings::xAxisRangeMaximum ( ) const

Returns the maximum range value for the x axis.

double cee::plt::AxisSettings::xAxisRangeMinimum ( ) const

Returns the minimum range value for the x axis.

cee::Str cee::plt::AxisSettings::xAxisTitle ( ) const

Returns the title of the x axis.

bool cee::plt::AxisSettings::xAxisUseLogarithmicScale ( ) const

Returns true if X axis uses logarithmic scaling.

double cee::plt::AxisSettings::yAxisRangeMaximum ( ) const

Returns the maximum range value for the y axis.

double cee::plt::AxisSettings::yAxisRangeMinimum ( ) const

Returns the minimum range value for the y axis.

cee::Str cee::plt::AxisSettings::yAxisTitle ( ) const

Returns the title of the y axis.

bool cee::plt::AxisSettings::yAxisUseLogarithmicScale ( ) const

Returns true if y axis uses logarithmic scaling.