VTK
Public Types | Signals | Public Member Functions | List of all members
vtkQtStatisticalBoxChartOptions Class Reference

The vtkQtStatisticalBoxChartOptions class stores the drawing options for a box chart. More...

#include <vtkQtStatisticalBoxChartOptions.h>

Public Types

enum  OutlineStyle { Darker, Black }

Signals

void axesCornerChanged ()
 Emitted when the box chart axes change.
void boxFractionChanged ()
 Emitted when the box width fraction changes.
void outlineStyleChanged ()
 Emitted when the outline style changes.

Public Member Functions

 vtkQtStatisticalBoxChartOptions (QObject *parent=0)
 Creates a box chart options instance.
 vtkQtStatisticalBoxChartOptions (const vtkQtStatisticalBoxChartOptions &other)
 Makes a copy of another box chart options instance.
virtual ~vtkQtStatisticalBoxChartOptions ()
vtkQtChartLayer::AxesCorner getAxesCorner () const
 Gets the pair of axes used by the box chart.
void setAxesCorner (vtkQtChartLayer::AxesCorner axes)
 Sets the pair of axes used by the box chart.
float getBoxWidthFraction () const
 Gets the box width fraction.
void setBoxWidthFraction (float fraction)
 Sets the box width fraction.
OutlineStyle getOutlineStyle () const
 Gets the outline style for the boxes.
void setOutlineStyle (OutlineStyle style)
 Sets the outline style for the boxes.
vtkQtChartHelpFormattergetHelpFormat ()
 Gets the chart help text formatter.
const vtkQtChartHelpFormattergetHelpFormat () const
 Gets the chart help text formatter.
vtkQtChartHelpFormattergetOutlierFormat ()
 Gets the outlier help text formatter.
const vtkQtChartHelpFormattergetOutlierFormat () const
 Gets the outlier help text formatter.
vtkQtStatisticalBoxChartOptionsoperator= (const vtkQtStatisticalBoxChartOptions &other)
 Makes a copy of another box chart options instance.

Detailed Description

The vtkQtStatisticalBoxChartOptions class stores the drawing options for a box chart.

The default settings are as follows:

Definition at line 44 of file vtkQtStatisticalBoxChartOptions.h.

Member Enumeration Documentation

Enumerator:
Darker 

Draws the box outline in a darker color.

Black 

Draws a black box outline.

Definition at line 49 of file vtkQtStatisticalBoxChartOptions.h.

Constructor & Destructor Documentation

vtkQtStatisticalBoxChartOptions::vtkQtStatisticalBoxChartOptions ( QObject *  parent = 0)

Creates a box chart options instance.

Parameters
parentThe parent object.
vtkQtStatisticalBoxChartOptions::vtkQtStatisticalBoxChartOptions ( const vtkQtStatisticalBoxChartOptions other)

Makes a copy of another box chart options instance.

Parameters
otherThe box chart options to copy.
virtual vtkQtStatisticalBoxChartOptions::~vtkQtStatisticalBoxChartOptions ( )
virtual

Member Function Documentation

vtkQtChartLayer::AxesCorner vtkQtStatisticalBoxChartOptions::getAxesCorner ( ) const
inline

Gets the pair of axes used by the box chart.

Returns
The pair of axes used by the box chart.

Definition at line 72 of file vtkQtStatisticalBoxChartOptions.h.

void vtkQtStatisticalBoxChartOptions::setAxesCorner ( vtkQtChartLayer::AxesCorner  axes)

Sets the pair of axes used by the box chart.

Parameters
axesThe new chart axes.
float vtkQtStatisticalBoxChartOptions::getBoxWidthFraction ( ) const
inline

Gets the box width fraction.

The box width fraction is used to set the spacing between the boxs of different series.

Returns
The box width fraction.

Definition at line 87 of file vtkQtStatisticalBoxChartOptions.h.

void vtkQtStatisticalBoxChartOptions::setBoxWidthFraction ( float  fraction)

Sets the box width fraction.

Parameters
fractionThe new box width fraction.
OutlineStyle vtkQtStatisticalBoxChartOptions::getOutlineStyle ( ) const
inline

Gets the outline style for the boxes.

Returns
The current outline style.

Definition at line 98 of file vtkQtStatisticalBoxChartOptions.h.

void vtkQtStatisticalBoxChartOptions::setOutlineStyle ( OutlineStyle  style)

Sets the outline style for the boxes.

The default style is Darker.

Parameters
styleThe outline style to use.
vtkQtChartHelpFormatter* vtkQtStatisticalBoxChartOptions::getHelpFormat ( )
inline

Gets the chart help text formatter.

The help text formatter stores the format string. It is also used to generate the help text.

Returns
A pointer to the chart help text formatter.

Definition at line 116 of file vtkQtStatisticalBoxChartOptions.h.

const vtkQtChartHelpFormatter* vtkQtStatisticalBoxChartOptions::getHelpFormat ( ) const
inline

Gets the chart help text formatter.

Returns
A pointer to the chart help text formatter.

Definition at line 122 of file vtkQtStatisticalBoxChartOptions.h.

vtkQtChartHelpFormatter* vtkQtStatisticalBoxChartOptions::getOutlierFormat ( )
inline

Gets the outlier help text formatter.

The help text formatter stores the format string. It is also used to generate the help text.

Returns
A pointer to the outlier help text formatter.

Definition at line 132 of file vtkQtStatisticalBoxChartOptions.h.

const vtkQtChartHelpFormatter* vtkQtStatisticalBoxChartOptions::getOutlierFormat ( ) const
inline

Gets the outlier help text formatter.

Returns
A pointer to the outlier help text formatter.

Definition at line 138 of file vtkQtStatisticalBoxChartOptions.h.

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

Makes a copy of another box chart options instance.

Parameters
otherThe box chart options to copy.
Returns
A reference to the object being assigned.
void vtkQtStatisticalBoxChartOptions::axesCornerChanged ( )
signal

Emitted when the box chart axes change.

void vtkQtStatisticalBoxChartOptions::boxFractionChanged ( )
signal

Emitted when the box width fraction changes.

void vtkQtStatisticalBoxChartOptions::outlineStyleChanged ( )
signal

Emitted when the outline style changes.


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