vtkQtChartAxisOptions Class Reference

#include <vtkQtChartAxisOptions.h>

Detailed Description

The vtkQtChartAxisOptions class stores the drawing options for a chart axis.

Definition at line 42 of file vtkQtChartAxisOptions.h.


Public Types
enum	NotationType { Standard = 0, Exponential, Engineering, StandardOrExponential }
enum	AxisGridColor { Lighter = 0, Specified }
enum	AxisScale { Linear, Logarithmic }
Signals
void	visibilityChanged ()
	Emitted when the axis or label visibility changes.
void	colorChanged ()
	Emitted when the axis or label color changes.
void	fontChanged ()
	Emitted when the label font changes.
void	axisScaleChanged ()
	Emitted when the axis scale changes.
void	presentationChanged ()
	Emitted when the precision or notation changes.
void	gridChanged ()
	Emitted when the grid color or visibility changes.
Public Member Functions
	vtkQtChartAxisOptions (QObject *parent=0)
	Creates a chart axis options instance.
	vtkQtChartAxisOptions (const vtkQtChartAxisOptions &other)
	Makes a copy of another axis options instance.
virtual	~vtkQtChartAxisOptions ()
bool	isVisible () const
	Gets whether or not the axis is visible.
void	setVisible (bool visible)
	Sets whether or not the axis should be visible.
bool	areLabelsVisible () const
	Gets whether or not the axis labels are visible.
void	setLabelsVisible (bool visible)
	Sets whether or not the axis labels should be visible.
bool	isGridVisible () const
	Gets whether or not the axis grid is visible.
void	setGridVisible (bool visible)
	Sets whether or not the axis grid should be visible.
const QColor &	getAxisColor () const
	Gets the axis color.
void	setAxisColor (const QColor &color)
	Sets the axis color.
const QColor &	getLabelColor () const
	Gets the color of the axis labels.
void	setLabelColor (const QColor &color)
	Sets the color of the axis labels.
const QFont &	getLabelFont () const
	Gets the font used to draw the axis labels.
void	setLabelFont (const QFont &font)
	Sets the font used to draw the axis labels.
AxisScale	getAxisScale () const
	Gets the axis scale (linear or logarithmic).
void	setAxisScale (AxisScale scale)
	Sets the axis scale (linear or logarithmic).
int	getPrecision () const
	Gets the decimal precision of the axis labels.
void	setPrecision (int precision)
	Sets the decimal precision of the axis labels.
NotationType	getNotation () const
	Gets the notation type for the axis labels.
void	setNotation (NotationType notation)
	Sets the notation type for the axis labels.
void	setGridColorType (AxisGridColor type)
	Sets the axis grid color type.
AxisGridColor	getGridColorType () const
	Gets the axis grid color type.
QColor	getGridColor () const
	Gets the axis grid color.
void	setGridColor (const QColor &color)
	Sets the axis grid color.
vtkQtChartAxisOptions &	operator= (const vtkQtChartAxisOptions &other)
	Makes a copy of another axis options instance.
QString	formatValue (const QVariant &value) const
	Formats the given value according to the axis options.

Member Enumeration Documentation

enum vtkQtChartAxisOptions::NotationType

Enumerator:

Standard
Exponential
Engineering
StandardOrExponential

Definition at line 47 of file vtkQtChartAxisOptions.h.

enum vtkQtChartAxisOptions::AxisGridColor

Enumerator:

Lighter	The grid color is based on the axis color.
Specified	The grid color is specified.

Definition at line 55 of file vtkQtChartAxisOptions.h.

enum vtkQtChartAxisOptions::AxisScale

Enumerator:

Linear	Use a linear scale.
Logarithmic	Use a logarithmic scale.

Definition at line 61 of file vtkQtChartAxisOptions.h.

Constructor & Destructor Documentation

vtkQtChartAxisOptions::vtkQtChartAxisOptions ( QObject * parent = 0 )

Creates a chart axis options instance.

Parameters:

parent

The parent object.

vtkQtChartAxisOptions::vtkQtChartAxisOptions ( const vtkQtChartAxisOptions & other )

Makes a copy of another axis options instance.

Parameters:

other

The axis options to copy.

virtual vtkQtChartAxisOptions::~vtkQtChartAxisOptions ( ) [inline, virtual]

Definition at line 77 of file vtkQtChartAxisOptions.h.

Member Function Documentation

bool vtkQtChartAxisOptions::isVisible ( ) const [inline]

Gets whether or not the axis is visible.

Returns:: True if the axis is visible.

Definition at line 83 of file vtkQtChartAxisOptions.h.

void vtkQtChartAxisOptions::setVisible ( bool visible )

Sets whether or not the axis should be visible.

Parameters:

visible

True if the axis should be visible.

bool vtkQtChartAxisOptions::areLabelsVisible ( ) const [inline]

Gets whether or not the axis labels are visible.

Returns:: True if the axis labels are visible.

Definition at line 94 of file vtkQtChartAxisOptions.h.

void vtkQtChartAxisOptions::setLabelsVisible ( bool visible )

Sets whether or not the axis labels should be visible.

Parameters:

visible

True if the axis labels should be visible.

bool vtkQtChartAxisOptions::isGridVisible ( ) const [inline]

Gets whether or not the axis grid is visible.

Returns:: True if the axis grid is visible.

Definition at line 105 of file vtkQtChartAxisOptions.h.

void vtkQtChartAxisOptions::setGridVisible ( bool visible )

Sets whether or not the axis grid should be visible.

Parameters:

visible

True if the axis grid should be visible.

const QColor& vtkQtChartAxisOptions::getAxisColor ( ) const [inline]

Gets the axis color.

Returns:: The axis color.

Definition at line 116 of file vtkQtChartAxisOptions.h.

void vtkQtChartAxisOptions::setAxisColor ( const QColor & color )

Sets the axis color.

If the grid color is tied to the axis color, the grid color will also be set.

Parameters:

color

The new axis color.

See also:: vtkQtChartAxisOptions::setGridColorType(AxisGridColor)

const QColor& vtkQtChartAxisOptions::getLabelColor ( ) const [inline]

Gets the color of the axis labels.

Returns:: The color of the axis labels.

Definition at line 132 of file vtkQtChartAxisOptions.h.

void vtkQtChartAxisOptions::setLabelColor ( const QColor & color )

Sets the color of the axis labels.

Parameters:

color

The new axis label color.

const QFont& vtkQtChartAxisOptions::getLabelFont ( ) const [inline]

Gets the font used to draw the axis labels.

Returns:: The font used to draw the axis labels.

Definition at line 143 of file vtkQtChartAxisOptions.h.

void vtkQtChartAxisOptions::setLabelFont ( const QFont & font )

Sets the font used to draw the axis labels.

Parameters:

font

The font to use.

AxisScale vtkQtChartAxisOptions::getAxisScale ( ) const [inline]

Gets the axis scale (linear or logarithmic).

Returns:: The axis scale.

Definition at line 154 of file vtkQtChartAxisOptions.h.

void vtkQtChartAxisOptions::setAxisScale ( AxisScale scale )

Sets the axis scale (linear or logarithmic).

Parameters:

scale

The new axis scale.

int vtkQtChartAxisOptions::getPrecision ( ) const [inline]

Gets the decimal precision of the axis labels.

Returns:: The decimal precision of the axis labels.

See also:: pqChartValue::getString()

Definition at line 166 of file vtkQtChartAxisOptions.h.

void vtkQtChartAxisOptions::setPrecision ( int precision )

Sets the decimal precision of the axis labels.

Parameters:

precision

The number of decimal places to use.

See also:: pqChartValue::getString()

NotationType vtkQtChartAxisOptions::getNotation ( ) const [inline]

Gets the notation type for the axis labels.

Returns:: The notation type for the axis labels.

See also:: pqChartValue::getString()

Definition at line 179 of file vtkQtChartAxisOptions.h.

void vtkQtChartAxisOptions::setNotation ( NotationType notation )

Sets the notation type for the axis labels.

Parameters:

notation

The new axis notation type.

See also:: pqChartValue::getString()

void vtkQtChartAxisOptions::setGridColorType ( AxisGridColor type )

Sets the axis grid color type.

The axis grid color type determines if the grid color is tied to the axis color. If the grid color type is Lighter, the grid color will be a lighter version of the axis color.

Parameters:

type

The new axis grid color type.

AxisGridColor vtkQtChartAxisOptions::getGridColorType ( ) const [inline]

Gets the axis grid color type.

Returns:: The axis grid color type.

See also:: vtkQtChartAxisOptions::setGridColorType(AxisGridColor)

Definition at line 202 of file vtkQtChartAxisOptions.h.

QColor vtkQtChartAxisOptions::getGridColor ( ) const

Gets the axis grid color.

If the grid color type is Lighter, the color returned will be a lighter version of the axis color. Otherwise, the specified color will be returned.

Returns:: The axis grid color.

See also:: vtkQtChartAxisOptions::setGridColorType(AxisGridColor)

void vtkQtChartAxisOptions::setGridColor ( const QColor & color )

Sets the axis grid color.

If the axis grid color type is Lighter, calling this method will not change the color used for drawing the grid. It will still set the specified grid color in case the type changes.

Parameters:

color

The new axis grid color.

vtkQtChartAxisOptions& vtkQtChartAxisOptions::operator= ( const vtkQtChartAxisOptions & other )

Makes a copy of another axis options instance.

Parameters:

other

The axis options to copy.

Returns:: A reference to the object being assigned.

QString vtkQtChartAxisOptions::formatValue ( const QVariant & value ) const

Formats the given value according to the axis options.

Parameters:

value

The value to convert to a string.

Returns:: The value formatted as a string.

void vtkQtChartAxisOptions::visibilityChanged ( ) [signal]

Emitted when the axis or label visibility changes.

void vtkQtChartAxisOptions::colorChanged ( ) [signal]

Emitted when the axis or label color changes.

void vtkQtChartAxisOptions::fontChanged ( ) [signal]

Emitted when the label font changes.

void vtkQtChartAxisOptions::axisScaleChanged ( ) [signal]

Emitted when the axis scale changes.

void vtkQtChartAxisOptions::presentationChanged ( ) [signal]

Emitted when the precision or notation changes.

void vtkQtChartAxisOptions::gridChanged ( ) [signal]

Emitted when the grid color or visibility changes.

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

dox/GUISupport/Qt/Chart/vtkQtChartAxisOptions.h

vtkQtChartAxisOptions Class Reference

Detailed Description

Public Types

Signals

Public Member Functions

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation