vtkChart Class Reference

#include <vtkChart.h>

Inheritance diagram for vtkChart:

[legend]

Collaboration diagram for vtkChart:

[legend]

List of all members.

Detailed Description

Factory class for drawing 2D charts.

This defines the interface for a chart.

Examples:: vtkChart (Examples)

Tests:: vtkChart (Tests)

Definition at line 46 of file vtkChart.h.


Public Types
typedef vtkContextItem	Superclass

enum	{ LINE, POINTS, BAR, STACKED }

enum	{ PAN = 0, ZOOM, SELECT, NOTIFY }
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual bool	Paint (vtkContext2D *painter)=0
virtual vtkPlot *	AddPlot (int type)
virtual vtkIdType	AddPlot (vtkPlot *plot)
virtual bool	RemovePlot (vtkIdType index)
virtual bool	RemovePlotInstance (vtkPlot *plot)
virtual void	ClearPlots ()
virtual vtkPlot *	GetPlot (vtkIdType index)
virtual vtkIdType	GetNumberOfPlots ()
virtual vtkAxis *	GetAxis (int axisIndex)
virtual vtkIdType	GetNumberOfAxes ()
virtual void	RecalculateBounds ()
virtual void	SetAnnotationLink (vtkAnnotationLink *link)
virtual vtkChartLegend *	GetLegend ()
void	SetBorders (int left, int bottom, int right, int top)
void	SetSize (const vtkRectf &rect)
vtkRectf	GetSize ()
virtual void	SetActionToButton (int action, int button)
virtual int	GetActionToButton (int action)
virtual void	SetClickActionToButton (int action, int button)
virtual int	GetClickActionToButton (int action)

virtual vtkAnnotationLink *	GetAnnotationLink ()

virtual void	SetGeometry (int, int)
void	SetGeometry (int[2])
virtual int *	GetGeometry ()
virtual void	GetGeometry (int &, int &)
virtual void	GetGeometry (int[2])

virtual void	SetPoint1 (int, int)
void	SetPoint1 (int[2])
virtual int *	GetPoint1 ()
virtual void	GetPoint1 (int &, int &)
virtual void	GetPoint1 (int[2])

virtual void	SetPoint2 (int, int)
void	SetPoint2 (int[2])
virtual int *	GetPoint2 ()
virtual void	GetPoint2 (int &, int &)
virtual void	GetPoint2 (int[2])

virtual void	SetShowLegend (bool visible)
virtual bool	GetShowLegend ()

virtual void	SetTitle (const vtkStdString &title)
virtual vtkStdString	GetTitle ()

virtual vtkTextProperty *	GetTitleProperties ()

void	SetBottomBorder (int border)
void	SetTopBorder (int border)
void	SetLeftBorder (int border)
void	SetRightBorder (int border)

virtual void	SetAutoSize (bool)
virtual bool	GetAutoSize ()

virtual void	SetRenderEmpty (bool)
virtual bool	GetRenderEmpty ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkChart *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkChart ()
	~vtkChart ()

bool	CalculatePlotTransform (vtkAxis x, vtkAxis y, vtkTransform2D *transform)
Protected Attributes
vtkAnnotationLink *	AnnotationLink
int	Geometry [2]
int	Point1 [2]
int	Point2 [2]
bool	ShowLegend
vtkStdString	Title
vtkTextProperty *	TitleProperties
vtkRectf	Size
bool	AutoSize
bool	RenderEmpty
MouseActions	Actions
MouseClickActions	ActionsClick
Classes
class	MouseActions
class	MouseClickActions

Member Typedef Documentation

typedef vtkContextItem vtkChart::Superclass

Reimplemented from vtkContextItem.

Reimplemented in vtkChartHistogram2D, vtkChartParallelCoordinates, vtkChartPie, and vtkChartXY.

Definition at line 49 of file vtkChart.h.

Member Enumeration Documentation

anonymous enum

Enum of the available chart types

Enumerator:

LINE
POINTS
BAR
STACKED

Definition at line 55 of file vtkChart.h.

anonymous enum

Enum of valid chart action types

Enumerator:

PAN
ZOOM
SELECT
NOTIFY

Definition at line 64 of file vtkChart.h.

Constructor & Destructor Documentation

vtkChart::vtkChart ( ) [protected]

vtkChart::~vtkChart ( ) [protected]

Member Function Documentation

virtual const char* vtkChart::GetClassName ( ) [virtual]

Reimplemented from vtkContextItem.

Reimplemented in vtkChartHistogram2D, vtkChartParallelCoordinates, vtkChartPie, and vtkChartXY.

static int vtkChart::IsTypeOf ( const char * name ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkContextItem.

Reimplemented in vtkChartHistogram2D, vtkChartParallelCoordinates, vtkChartPie, and vtkChartXY.

virtual int vtkChart::IsA ( const char * name ) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkContextItem.

Reimplemented in vtkChartHistogram2D, vtkChartParallelCoordinates, vtkChartPie, and vtkChartXY.

static vtkChart* vtkChart::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkContextItem.

Reimplemented in vtkChartHistogram2D, vtkChartParallelCoordinates, vtkChartPie, and vtkChartXY.

virtual void vtkChart::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[virtual]`

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkContextItem.

Reimplemented in vtkChartHistogram2D, vtkChartParallelCoordinates, vtkChartPie, and vtkChartXY.

virtual bool vtkChart::Paint ( vtkContext2D * painter ) [pure virtual]

Paint event for the chart, called whenever the chart needs to be drawn

Reimplemented from vtkAbstractContextItem.

Implemented in vtkChartParallelCoordinates, vtkChartPie, and vtkChartXY.

virtual vtkPlot* vtkChart::AddPlot ( int type ) [virtual]

Add a plot to the chart, defaults to using the name of the y column

Reimplemented in vtkChartPie, and vtkChartXY.

virtual vtkIdType vtkChart::AddPlot ( vtkPlot * plot ) [virtual]

Add a plot to the chart. Return the index of the plot, -1 if it failed.

Reimplemented in vtkChartPie, and vtkChartXY.

virtual bool vtkChart::RemovePlot ( vtkIdType index ) [virtual]

Remove the plot at the specified index, returns true if successful, false if the index was invalid.

Reimplemented in vtkChartXY.

virtual bool vtkChart::RemovePlotInstance ( vtkPlot * plot ) [virtual]

Remove the given plot. Returns true if successful, false if the plot was not contained in this chart. Note, the base implementation of this method performs a linear search to locate the plot.

virtual void vtkChart::ClearPlots ( ) [virtual]

Remove all plots from the chart.

Reimplemented in vtkChartXY.

virtual vtkPlot* vtkChart::GetPlot ( vtkIdType index ) [virtual]

Get the plot at the specified index, returns null if the index is invalid.

Reimplemented in vtkChartParallelCoordinates, vtkChartPie, and vtkChartXY.

virtual vtkIdType vtkChart::GetNumberOfPlots ( ) [virtual]

Get the number of plots the chart contains.

Reimplemented in vtkChartParallelCoordinates, vtkChartPie, and vtkChartXY.

virtual vtkAxis* vtkChart::GetAxis ( int axisIndex ) [virtual]

Get the axis specified by axisIndex. 0 is x, 1 is y. This should probably be improved either using a string or enum to select the axis.

Reimplemented in vtkChartParallelCoordinates, and vtkChartXY.

virtual vtkIdType vtkChart::GetNumberOfAxes ( ) [virtual]

Get the number of axes in the current chart.

Reimplemented in vtkChartParallelCoordinates, and vtkChartXY.

virtual void vtkChart::RecalculateBounds ( ) [virtual]

Request that the chart recalculates the range of its axes. Especially useful in applications after the parameters of plots have been modified.

Reimplemented in vtkChartParallelCoordinates, and vtkChartXY.

virtual void vtkChart::SetAnnotationLink ( vtkAnnotationLink * link ) [virtual]

Set the vtkAnnotationLink for the chart.

virtual vtkAnnotationLink* vtkChart::GetAnnotationLink ( ) [virtual]

Get the vtkAnnotationLink for the chart.

virtual void vtkChart::SetGeometry	(	int	,
		int
	)			`[virtual]`

Set/get the width and the height of the chart.

void vtkChart::SetGeometry ( int [2] )

Set/get the width and the height of the chart.

virtual int* vtkChart::GetGeometry ( ) [virtual]

Set/get the width and the height of the chart.

virtual void vtkChart::GetGeometry	(	int &	,
		int &
	)			`[virtual]`

Set/get the width and the height of the chart.

virtual void vtkChart::GetGeometry ( int [2] ) [virtual]

Set/get the width and the height of the chart.

virtual void vtkChart::SetPoint1	(	int	,
		int
	)			`[virtual]`

Set/get the first point in the chart (the bottom left).

void vtkChart::SetPoint1 ( int [2] )

Set/get the first point in the chart (the bottom left).

virtual int* vtkChart::GetPoint1 ( ) [virtual]

Set/get the first point in the chart (the bottom left).

virtual void vtkChart::GetPoint1	(	int &	,
		int &
	)			`[virtual]`

Set/get the first point in the chart (the bottom left).

virtual void vtkChart::GetPoint1 ( int [2] ) [virtual]

Set/get the first point in the chart (the bottom left).

virtual void vtkChart::SetPoint2	(	int	,
		int
	)			`[virtual]`

Set/get the second point in the chart (the top right).

void vtkChart::SetPoint2 ( int [2] )

Set/get the second point in the chart (the top right).

virtual int* vtkChart::GetPoint2 ( ) [virtual]

Set/get the second point in the chart (the top right).

virtual void vtkChart::GetPoint2	(	int &	,
		int &
	)			`[virtual]`

Set/get the second point in the chart (the top right).

virtual void vtkChart::GetPoint2 ( int [2] ) [virtual]

Set/get the second point in the chart (the top right).

virtual void vtkChart::SetShowLegend ( bool visible ) [virtual]

Set/get whether the chart should draw a legend.

Reimplemented in vtkChartPie, and vtkChartXY.

virtual bool vtkChart::GetShowLegend ( ) [virtual]

Set/get whether the chart should draw a legend.

virtual vtkChartLegend* vtkChart::GetLegend ( ) [virtual]

Get the legend for the chart, if available. Can return NULL if there is no legend.

Reimplemented in vtkChartPie, and vtkChartXY.

virtual void vtkChart::SetTitle ( const vtkStdString & title ) [virtual]

Get/set the title text of the chart.

virtual vtkStdString vtkChart::GetTitle ( ) [virtual]

Get/set the title text of the chart.

virtual vtkTextProperty* vtkChart::GetTitleProperties ( ) [virtual]

Get the vtkTextProperty that governs how the chart title is displayed.

void vtkChart::SetBottomBorder ( int border )