Factory class for drawing 2D charts. More...

#include <vtkChart.h>

Inheritance diagram for vtkChart:

Collaboration diagram for vtkChart:

Classes
class	MouseActions
	Hold mouse action mappings. More...

class	MouseClickActions

Public Types
enum	{ LINE , POINTS , BAR , STACKED , BAG , FUNCTIONALBAG , AREA }
	Enum of the available chart types. More...

enum	{ PAN = 0 , ZOOM , ZOOM_AXIS , SELECT , SELECT_RECTANGLE = SELECT , SELECT_POLYGON , CLICK_AND_DRAG , NOTIFY , ACTION_TYPES_COUNT }
	Enum of valid chart action types. More...

enum	EventIds { UpdateRange = 1002 }
	Enum of event type that are triggered by the charts. More...

enum	{ SELECTION_ROWS , SELECTION_PLOTS , SELECTION_COLUMNS }
	Enumeration of the possible selection methods in a chart. More...

enum	{ FILL_SCENE , FILL_RECT , AXES_TO_RECT }
	Enum of the available layout strategies for the charts. More...

typedef vtkContextItem	Superclass

Public Types inherited from vtkContextItem
typedef vtkAbstractContextItem	Superclass

Public Types inherited from vtkAbstractContextItem
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkChart *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

bool	Paint (vtkContext2D *painter) override=0
	Paint event for the chart, called whenever the chart needs to be drawn.

virtual vtkPlot *	AddPlot (int type)
	Add a plot to the chart, defaults to using the name of the y column.

virtual vtkIdType	AddPlot (vtkPlot *plot)
	Add a plot to the chart.

virtual bool	RemovePlot (vtkIdType index)
	Remove the plot at the specified index, returns true if successful, false if the index was invalid.

virtual bool	RemovePlotInstance (vtkPlot *plot)
	Remove the given plot.

bool	RemovePlot (vtkPlot *plot)

virtual void	ClearPlots ()
	Remove all plots from the chart.

void	RemoveAllPlots ()

virtual vtkPlot *	GetPlot (vtkIdType index)
	Get the plot at the specified index, returns null if the index is invalid.

virtual vtkIdType	GetNumberOfPlots ()
	Get the number of plots the chart contains.

virtual vtkAxis *	GetAxis (int axisIndex)
	Get the axis specified by axisIndex.

virtual void	SetAxis (int axisIndex, vtkAxis *)
	Set the axis specified by axisIndex.

virtual vtkIdType	GetNumberOfAxes ()
	Get the number of axes in the current chart.

virtual void	RecalculateBounds ()
	Request that the chart recalculates the range of its axes.

virtual void	SetAnnotationLink (vtkAnnotationLink *link)
	Set the vtkAnnotationLink for the chart.

virtual vtkChartLegend *	GetLegend ()
	Get the legend for the chart, if available.

void	SetBorders (int left, int bottom, int right, int top)
	Set/get the borders of the chart (space in pixels around the chart).

virtual void	SetSize (const vtkRectf &rect)
	Set the size of the chart.

vtkRectf	GetSize ()
	Get the current size of the chart.

virtual void	SetActionToButton (int action, int button)
	Assign action types to mouse buttons.

virtual int	GetActionToButton (int action)
	Get the mouse button associated with the supplied action.

virtual void	SetClickActionToButton (int action, int button)
	Assign action types to single mouse clicks.

virtual int	GetClickActionToButton (int action)
	Get the mouse button associated with the supplied click action.


virtual void	SetSelectionMethod (int method)
	Set the selection method, which controls how selections are handled by the chart.

virtual int	GetSelectionMethod ()
	Set the selection method, which controls how selections are handled by the chart.


virtual vtkAnnotationLink *	GetAnnotationLink ()
	Get the vtkAnnotationLink for the chart.


virtual void	SetGeometry (int, int)
	Set/get the width and the height of the chart.

void	SetGeometry (int[2])
	Set/get the width and the height of the chart.

virtual int *	GetGeometry ()
	Set/get the width and the height of the chart.

virtual void	GetGeometry (int &, int &)
	Set/get the width and the height of the chart.

virtual void	GetGeometry (int[2])
	Set/get the width and the height of the chart.


virtual void	SetPoint1 (int, int)
	Set/get the first point in the chart (the bottom left).

void	SetPoint1 (int[2])
	Set/get the first point in the chart (the bottom left).

virtual int *	GetPoint1 ()
	Set/get the first point in the chart (the bottom left).

virtual void	GetPoint1 (int &, int &)
	Set/get the first point in the chart (the bottom left).

virtual void	GetPoint1 (int[2])
	Set/get the first point in the chart (the bottom left).


virtual void	SetPoint2 (int, int)
	Set/get the second point in the chart (the top right).

void	SetPoint2 (int[2])
	Set/get the second point in the chart (the top right).

virtual int *	GetPoint2 ()
	Set/get the second point in the chart (the top right).

virtual void	GetPoint2 (int &, int &)
	Set/get the second point in the chart (the top right).

virtual void	GetPoint2 (int[2])
	Set/get the second point in the chart (the top right).


virtual void	SetShowLegend (bool visible)
	Set/get whether the chart should draw a legend.

virtual bool	GetShowLegend ()
	Set/get whether the chart should draw a legend.


virtual void	SetTitle (const vtkStdString &title)
	Get/set the title text of the chart.

virtual vtkStdString	GetTitle ()
	Get/set the title text of the chart.


virtual vtkTextProperty *	GetTitleProperties ()
	Get the vtkTextProperty that governs how the chart title is displayed.


void	SetBottomBorder (int border)
	Set/get the borders of the chart (space in pixels around the chart).

void	SetTopBorder (int border)
	Set/get the borders of the chart (space in pixels around the chart).

void	SetLeftBorder (int border)
	Set/get the borders of the chart (space in pixels around the chart).

void	SetRightBorder (int border)
	Set/get the borders of the chart (space in pixels around the chart).


virtual void	SetLayoutStrategy (int)
	Set/get the layout strategy that should be used by the chart.

virtual int	GetLayoutStrategy ()
	Set/get the layout strategy that should be used by the chart.


virtual void	SetAutoSize (bool isAutoSized)
	Set/get whether the chart should automatically resize to fill the current render window.

virtual bool	GetAutoSize ()
	Set/get whether the chart should automatically resize to fill the current render window.


virtual void	SetRenderEmpty (bool)
	Set/get whether the chart should still render its axes and decorations even if the chart has no visible plots.

virtual bool	GetRenderEmpty ()
	Set/get whether the chart should still render its axes and decorations even if the chart has no visible plots.


void	SetBackgroundBrush (vtkBrush *brush)
	Set/Get the brush to use for the background color.

vtkBrush *	GetBackgroundBrush ()
	Set/Get the brush to use for the background color.


virtual void	SetSelectionMode (int)
	Set/get the Selection Mode that will be used by the chart while doing selection.

virtual int	GetSelectionMode ()
	Set/get the Selection Mode that will be used by the chart while doing selection.

Public Member Functions inherited from vtkContextItem
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkContextItem *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual void	SetTransform (vtkContextTransform *)
	Set the transform of the item.

virtual double	GetOpacity ()
	Get the opacity of the item.

virtual void	SetOpacity (double)
	Set the opacity of the item.

Public Member Functions inherited from vtkAbstractContextItem
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkAbstractContextItem *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual void	Update ()
	Perform any updates to the item that may be necessary before rendering.

virtual bool	Paint (vtkContext2D *painter)
	Paint event for the item, called whenever the item needs to be drawn.

virtual bool	PaintChildren (vtkContext2D *painter)
	Paint the children of the item, should be called whenever the children need to be rendered.

virtual void	ReleaseGraphicsResources ()
	Release graphics resources hold by the item.

vtkIdType	AddItem (vtkAbstractContextItem *item)
	Add child items to this item.

bool	RemoveItem (vtkAbstractContextItem *item)
	Remove child item from this item.

bool	RemoveItem (vtkIdType index)
	Remove child item from this item.

vtkAbstractContextItem *	GetItem (vtkIdType index)
	Get the item at the specified index.

vtkIdType	GetItemIndex (vtkAbstractContextItem *item)
	Get the index of the specified item in itemIndex.

vtkIdType	GetNumberOfItems ()
	Get the number of child items.

void	ClearItems ()
	Remove all child items from this item.

vtkIdType	Raise (vtkIdType index)
	Raises the child to the top of the item's stack.

virtual vtkIdType	StackAbove (vtkIdType index, vtkIdType under)
	Raises the child above the under sibling.

vtkIdType	Lower (vtkIdType index)
	Lowers the child to the bottom of the item's stack.

virtual vtkIdType	StackUnder (vtkIdType child, vtkIdType above)
	Lowers the child under the above sibling.

virtual bool	Hit (const vtkContextMouseEvent &mouse)
	Return true if the supplied x, y coordinate is inside the item.

virtual vtkAbstractContextItem *	GetPickedItem (const vtkContextMouseEvent &mouse)
	Return the item under the mouse.

virtual bool	MouseEnterEvent (const vtkContextMouseEvent &mouse)
	Mouse enter event.

virtual bool	MouseMoveEvent (const vtkContextMouseEvent &mouse)
	Mouse move event.

virtual bool	MouseLeaveEvent (const vtkContextMouseEvent &mouse)
	Mouse leave event.

virtual bool	MouseButtonPressEvent (const vtkContextMouseEvent &mouse)
	Mouse button down event Return true if the item holds the event, false if the event can be propagated to other items.

virtual bool	MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)
	Mouse button release event.

virtual bool	MouseDoubleClickEvent (const vtkContextMouseEvent &mouse)
	Mouse button double click event.

virtual bool	MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
	Mouse wheel event, positive delta indicates forward movement of the wheel.

virtual bool	KeyPressEvent (const vtkContextKeyEvent &key)
	Key press event.

virtual bool	KeyReleaseEvent (const vtkContextKeyEvent &key)
	Key release event.

virtual void	SetScene (vtkContextScene *scene)
	Set the vtkContextScene for the item, always set for an item in a scene.

vtkContextScene *	GetScene ()
	Get the vtkContextScene for the item, always set for an item in a scene.

virtual void	SetParent (vtkAbstractContextItem *parent)
	Set the parent item.

vtkAbstractContextItem *	GetParent ()
	Get the parent item.

virtual vtkVector2f	MapToParent (const vtkVector2f &point)
	Maps the point to the parent coordinate system.

virtual vtkVector2f	MapFromParent (const vtkVector2f &point)
	Maps the point from the parent coordinate system.

virtual vtkVector2f	MapToScene (const vtkVector2f &point)
	Maps the point to the scene coordinate system.

virtual vtkVector2f	MapFromScene (const vtkVector2f &point)
	Maps the point from the scene coordinate system.

virtual bool	GetVisible ()
	Get the visibility of the item (should it be drawn).

virtual void	SetVisible (bool)
	Set the visibility of the item (should it be drawn).

virtual bool	GetInteractive ()
	Get if the item is interactive (should respond to mouse events).

virtual void	SetInteractive (bool)
	Set if the item is interactive (should respond to mouse events).

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkChart *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkContextItem
static vtkTypeBool	IsTypeOf (const char *type)

static vtkContextItem *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAbstractContextItem
static vtkTypeBool	IsTypeOf (const char *type)

static vtkAbstractContextItem *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkChart ()

	~vtkChart () override

bool	CalculatePlotTransform (vtkAxis x, vtkAxis y, vtkTransform2D *transform)
	Given the x and y vtkAxis, and a transform, calculate the transform that the points in a chart would need to be drawn within the axes.

bool	CalculateUnscaledPlotTransform (vtkAxis x, vtkAxis y, vtkTransform2D *transform)
	Calculate the unshifted, and unscaled plot transform for the x and y axis.

void	AttachAxisRangeListener (vtkAxis *)
	Attach axis range listener so we can forward those events at the chart level.

void	AxisRangeForwarderCallback (vtkObject , unsigned long, void )

Protected Member Functions inherited from vtkContextItem
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkContextItem ()=default

	~vtkContextItem () override

Protected Member Functions inherited from vtkAbstractContextItem
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAbstractContextItem ()

	~vtkAbstractContextItem () override

virtual void	ReleaseGraphicsCache ()
	Release cache entries created by this context item.

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkAnnotationLink *	AnnotationLink
	Our annotation link, used for sharing selections etc.

int	Geometry [2]
	The width and the height of the chart.

int	Point1 [2]
	The position of the lower left corner of the chart.

int	Point2 [2]
	The position of the upper right corner of the chart.

int	Borders [4]
	The borders around the chart.

bool	ShowLegend
	Display the legend?

vtkStdString	Title
	The title of the chart.

vtkTextProperty *	TitleProperties
	The text properties associated with the chart.

vtkRectf	Size

int	LayoutStrategy

bool	RenderEmpty

vtkSmartPointer< vtkBrush >	BackgroundBrush
	Brush to use for drawing the background.

int	SelectionMode

int	SelectionMethod

MouseActions	Actions

MouseClickActions	ActionsClick

Protected Attributes inherited from vtkContextItem
double	Opacity = 1.0

vtkContextTransform *	Transform = nullptr

Protected Attributes inherited from vtkAbstractContextItem
vtkContextScene *	Scene
	Point to the scene the item is on - can be null.

vtkAbstractContextItem *	Parent
	Point to the parent item - can be null.

vtkContextScenePrivate *	Children
	This structure provides a list of children, along with convenience functions to paint the children etc.

bool	Visible
	Store the visibility of the item (default is true).

bool	Interactive
	Store whether the item should respond to interactions (default is true).

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

Factory class for drawing 2D charts.

This defines the interface for a chart.

Examples:: vtkChart (Examples)

Online Examples:

KDTreeTimingDemo

ModifiedBSPTreeTimingDemo

Tests:: vtkChart (Tests)

Definition at line 150 of file vtkChart.h.

Member Typedef Documentation

◆ Superclass

typedef vtkContextItem vtkChart::Superclass

Definition at line 153 of file vtkChart.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enum of the available chart types.

Enumerator
LINE
POINTS
BAR
STACKED
BAG
FUNCTIONALBAG
AREA

Definition at line 159 of file vtkChart.h.

◆ anonymous enum

anonymous enum

Enum of valid chart action types.

PAN - moves the axis range ZOOM - zooms to a selected rectangle ZOOM_AXIS - zooms the x and y axis range SELECT_RECTANGLE - selects points within a rectangle SELECT_POLYGON - selects points within a polygon SELECT - alias for SELECT_RECTANGLE CLICKANDDRAG - move one point selected by a click NOTIFY - Post vtkCommand::InteractionEvent on selection of a point ACTION_TYPES_COUNT - total action types count (needed in ParaView, see pqChartSelectionReaction.h)

Enumerator
PAN
ZOOM
ZOOM_AXIS
SELECT
SELECT_RECTANGLE
SELECT_POLYGON
CLICK_AND_DRAG
NOTIFY
ACTION_TYPES_COUNT

Definition at line 184 of file vtkChart.h.

◆ EventIds

enum vtkChart::EventIds

Enum of event type that are triggered by the charts.

Enumerator
UpdateRange

Definition at line 200 of file vtkChart.h.

◆ anonymous enum

anonymous enum

Enumeration of the possible selection methods in a chart.

SELECTION_ROWS is the default and simply selects the row in a table in all plots showing that table. SELECTION_PLOTS will make a selection in each plot, and that selection remains specific to the plot object. SELECTION_COLUMNS selects the plots that use as input the selected columns of a table.

Enumerator
SELECTION_ROWS
SELECTION_PLOTS
SELECTION_COLUMNS

Definition at line 280 of file vtkChart.h.

◆ anonymous enum

anonymous enum

Enum of the available layout strategies for the charts.

Enumerator
FILL_SCENE
FILL_RECT
AXES_TO_RECT

Definition at line 395 of file vtkChart.h.

Constructor & Destructor Documentation

◆ vtkChart()

vtkChart::vtkChart ( )

protected

◆ ~vtkChart()

vtkChart::~vtkChart ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkChart::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool 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 vtkChartBox, vtkChartHistogram2D, vtkChartParallelCoordinates, vtkChartPie, and vtkChartXY.

◆ SafeDownCast()

static vtkChart * vtkChart::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkChart::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkContextItem.

Reimplemented in vtkChartBox, vtkChartHistogram2D, vtkChartParallelCoordinates, vtkChartPie, and vtkChartXY.

◆ NewInstance()

vtkChart * vtkChart::NewInstance ( ) const

◆ PrintSelf()

void vtkChart::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

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 vtkAbstractContextItem.

Reimplemented in vtkChartBox, vtkChartHistogram2D, vtkChartParallelCoordinates, vtkChartPie, and vtkChartXY.

◆ Paint()

bool vtkChart::Paint ( vtkContext2D * painter )

overridepure virtual

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

Reimplemented from vtkAbstractContextItem.

Implemented in vtkChartBox, vtkChartParallelCoordinates, vtkChartPie, and vtkChartXY.

◆ AddPlot() [1/2]

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, vtkChartPie, and vtkChartXY.

◆ AddPlot() [2/2]

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.

◆ RemovePlot() [1/2]

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.

◆ RemovePlotInstance()

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.

◆ RemovePlot() [2/2]

bool vtkChart::RemovePlot ( vtkPlot * plot )

inline

Definition at line 232 of file vtkChart.h.

◆ ClearPlots()

virtual void vtkChart::ClearPlots ( )

virtual

Remove all plots from the chart.

Reimplemented in vtkChartXY.

◆ RemoveAllPlots()

void vtkChart::RemoveAllPlots ( )

inline

Definition at line 238 of file vtkChart.h.

◆ GetPlot()

virtual vtkPlot * vtkChart::GetPlot ( vtkIdType index )

virtual

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

Reimplemented in vtkChartBox, vtkChartHistogram2D, vtkChartParallelCoordinates, vtkChartPie, and vtkChartXY.

◆ GetNumberOfPlots()

virtual vtkIdType vtkChart::GetNumberOfPlots ( )

virtual

Get the number of plots the chart contains.

Reimplemented in vtkChartBox, vtkChartParallelCoordinates, vtkChartPie, and vtkChartXY.

◆ GetAxis()

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.

◆ SetAxis()

virtual void vtkChart::SetAxis	(	int	axisIndex,
		vtkAxis *
	)

virtual

Set 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 vtkChartXY.

◆ GetNumberOfAxes()

virtual vtkIdType vtkChart::GetNumberOfAxes ( )

virtual

Get the number of axes in the current chart.

Reimplemented in vtkChartParallelCoordinates, and vtkChartXY.

◆ RecalculateBounds()

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.

◆ SetSelectionMethod()

virtual void vtkChart::SetSelectionMethod ( int method )

virtual

Set the selection method, which controls how selections are handled by the chart.

The default is SELECTION_ROWS which selects all points in all plots in a chart that have values in the rows selected. SELECTION_PLOTS allows for finer-grained selections specific to each plot, and so to each XY column pair. SELECTION_COLUMNS selects all points of plots that correspond to selected columns.

Reimplemented in vtkChartXY.

◆ GetSelectionMethod()

virtual int vtkChart::GetSelectionMethod ( )

virtual

Set the selection method, which controls how selections are handled by the chart.

The default is SELECTION_ROWS which selects all points in all plots in a chart that have values in the rows selected. SELECTION_PLOTS allows for finer-grained selections specific to each plot, and so to each XY column pair. SELECTION_COLUMNS selects all points of plots that correspond to selected columns.

◆ SetAnnotationLink()

virtual void vtkChart::SetAnnotationLink ( vtkAnnotationLink * link )

virtual

Set the vtkAnnotationLink for the chart.

◆ GetAnnotationLink()

virtual vtkAnnotationLink * vtkChart::GetAnnotationLink ( )

virtual

Get the vtkAnnotationLink for the chart.

◆ SetGeometry() [1/2]

virtual void vtkChart::SetGeometry	(	int	,
		int
	)

virtual

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

Reimplemented in vtkChartBox.

◆ SetGeometry() [2/2]

void vtkChart::SetGeometry ( int [2] )

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

◆ GetGeometry() [1/3]

virtual int * vtkChart::GetGeometry ( )

virtual

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

◆ GetGeometry() [2/3]

virtual void vtkChart::GetGeometry	(	int &	,
		int &
	)

virtual

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

◆ GetGeometry() [3/3]

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

virtual

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

◆ SetPoint1() [1/2]

virtual void vtkChart::SetPoint1	(	int	,
		int
	)

virtual

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

◆ SetPoint1() [2/2]

void vtkChart::SetPoint1 ( int [2] )

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

◆ GetPoint1() [1/3]

virtual int * vtkChart::GetPoint1 ( )

virtual

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

◆ GetPoint1() [2/3]

virtual void vtkChart::GetPoint1	(	int &	,
		int &
	)

virtual

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

◆ GetPoint1() [3/3]

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

virtual

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

◆ SetPoint2() [1/2]

virtual void vtkChart::SetPoint2	(	int	,
		int
	)

virtual

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

◆ SetPoint2() [2/2]

void vtkChart::SetPoint2 ( int [2] )

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

◆ GetPoint2() [1/3]

virtual int * vtkChart::GetPoint2 ( )

virtual

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

◆ GetPoint2() [2/3]

virtual void vtkChart::GetPoint2	(	int &	,
		int &
	)

virtual

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

◆ GetPoint2() [3/3]

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

virtual

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

◆ SetShowLegend()

virtual void vtkChart::SetShowLegend ( bool visible )

virtual

Set/get whether the chart should draw a legend.

Reimplemented in vtkChartParallelCoordinates, vtkChartPie, and vtkChartXY.

◆ GetShowLegend()

virtual bool vtkChart::GetShowLegend ( )

virtual

Set/get whether the chart should draw a legend.

◆ GetLegend()

virtual vtkChartLegend * vtkChart::GetLegend ( )

virtual

Get the legend for the chart, if available.

Can return null if there is no legend.

Reimplemented in vtkChartParallelCoordinates, vtkChartPie, and vtkChartXY.

◆ SetTitle()

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

virtual

Get/set the title text of the chart.

◆ GetTitle()

virtual vtkStdString vtkChart::GetTitle ( )

virtual

Get/set the title text of the chart.

◆ GetTitleProperties()

virtual vtkTextProperty * vtkChart::GetTitleProperties ( )

virtual

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