VTK
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkChart Class Referenceabstract

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

#include <vtkChart.h>

Inheritance diagram for vtkChart:
[legend]
Collaboration diagram for vtkChart:
[legend]

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
}
 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. More...
 
vtkChartNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
bool Paint (vtkContext2D *painter) override=0
 Paint event for the chart, called whenever the chart needs to be drawn. More...
 
virtual vtkPlotAddPlot (int type)
 Add a plot to the chart, defaults to using the name of the y column. More...
 
virtual vtkIdType AddPlot (vtkPlot *plot)
 Add a plot to the chart. More...
 
virtual bool RemovePlot (vtkIdType index)
 Remove the plot at the specified index, returns true if successful, false if the index was invalid. More...
 
virtual bool RemovePlotInstance (vtkPlot *plot)
 Remove the given plot. More...
 
virtual void ClearPlots ()
 Remove all plots from the chart. More...
 
virtual vtkPlotGetPlot (vtkIdType index)
 Get the plot at the specified index, returns null if the index is invalid. More...
 
virtual vtkIdType GetNumberOfPlots ()
 Get the number of plots the chart contains. More...
 
virtual vtkAxisGetAxis (int axisIndex)
 Get the axis specified by axisIndex. More...
 
virtual void SetAxis (int axisIndex, vtkAxis *)
 Set the axis specified by axisIndex. More...
 
virtual vtkIdType GetNumberOfAxes ()
 Get the number of axes in the current chart. More...
 
virtual void RecalculateBounds ()
 Request that the chart recalculates the range of its axes. More...
 
virtual void SetSelectionMethod (int method)
 Set the selection method, which controls how selections are handled by the chart. More...
 
virtual int GetSelectionMethod ()
 
virtual void SetAnnotationLink (vtkAnnotationLink *link)
 Set the vtkAnnotationLink for the chart. More...
 
virtual vtkAnnotationLinkGetAnnotationLink ()
 Get the vtkAnnotationLink for the chart. More...
 
virtual void SetGeometry (int, int)
 Set/get the width and the height of the chart. More...
 
void SetGeometry (int[2])
 
virtual intGetGeometry ()
 
virtual void GetGeometry (int &, int &)
 
virtual void GetGeometry (int[2])
 
virtual void SetPoint1 (int, int)
 Set/get the first point in the chart (the bottom left). More...
 
void SetPoint1 (int[2])
 
virtual intGetPoint1 ()
 
virtual void GetPoint1 (int &, int &)
 
virtual void GetPoint1 (int[2])
 
virtual void SetPoint2 (int, int)
 Set/get the second point in the chart (the top right). More...
 
void SetPoint2 (int[2])
 
virtual intGetPoint2 ()
 
virtual void GetPoint2 (int &, int &)
 
virtual void GetPoint2 (int[2])
 
virtual void SetShowLegend (bool visible)
 Set/get whether the chart should draw a legend. More...
 
virtual bool GetShowLegend ()
 
virtual vtkChartLegendGetLegend ()
 Get the legend for the chart, if available. More...
 
virtual void SetTitle (const vtkStdString &title)
 Get/set the title text of the chart. More...
 
virtual vtkStdString GetTitle ()
 
virtual vtkTextPropertyGetTitleProperties ()
 Get the vtkTextProperty that governs how the chart title is displayed. More...
 
void SetBottomBorder (int border)
 Set/get the borders of the chart (space in pixels around the chart). More...
 
void SetTopBorder (int border)
 
void SetLeftBorder (int border)
 
void SetRightBorder (int border)
 
void SetBorders (int left, int bottom, int right, int top)
 Set/get the borders of the chart (space in pixels around the chart). More...
 
void SetSize (const vtkRectf &rect)
 Set the size of the chart. More...
 
vtkRectf GetSize ()
 Get the current size of the chart. More...
 
virtual void SetLayoutStrategy (int)
 Set/get the layout strategy that should be used by the chart. More...
 
virtual int GetLayoutStrategy ()
 
virtual void SetAutoSize (bool isAutoSized)
 Set/get whether the chart should automatically resize to fill the current render window. More...
 
virtual bool GetAutoSize ()
 
virtual void SetRenderEmpty (bool)
 Set/get whether the chart should still render its axes and decorations even if the chart has no visible plots. More...
 
virtual bool GetRenderEmpty ()
 
virtual void SetActionToButton (int action, int button)
 Assign action types to mouse buttons. More...
 
virtual int GetActionToButton (int action)
 Get the mouse button associated with the supplied action. More...
 
virtual void SetClickActionToButton (int action, int button)
 Assign action types to single mouse clicks. More...
 
virtual int GetClickActionToButton (int action)
 Get the mouse button associated with the supplied click action. More...
 
void SetBackgroundBrush (vtkBrush *brush)
 Set/Get the brush to use for the background color. More...
 
vtkBrushGetBackgroundBrush ()
 
virtual void SetSelectionMode (int)
 Set/get the Selection Mode that will be used by the chart while doing selection. More...
 
virtual int GetSelectionMode ()
 
- Public Member Functions inherited from vtkContextItem
vtkContextItemNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual double GetOpacity ()
 Get the opacity of the item. More...
 
virtual void SetOpacity (double)
 Set the opacity of the item. More...
 
- Public Member Functions inherited from vtkAbstractContextItem
vtkAbstractContextItemNewInstance () const
 
virtual void Update ()
 Perform any updates to the item that may be necessary before rendering. More...
 
virtual bool PaintChildren (vtkContext2D *painter)
 Paint the children of the item, should be called whenever the children need to be rendered. More...
 
virtual void ReleaseGraphicsResources ()
 Release graphics resources hold by the item. More...
 
vtkIdType AddItem (vtkAbstractContextItem *item)
 Add child items to this item. More...
 
bool RemoveItem (vtkAbstractContextItem *item)
 Remove child item from this item. More...
 
bool RemoveItem (vtkIdType index)
 Remove child item from this item. More...
 
vtkAbstractContextItemGetItem (vtkIdType index)
 Get the item at the specified index. More...
 
vtkIdType GetItemIndex (vtkAbstractContextItem *item)
 Get the index of the specified item in itemIndex. More...
 
vtkIdType GetNumberOfItems ()
 Get the number of child items. More...
 
void ClearItems ()
 Remove all child items from this item. More...
 
vtkIdType Raise (vtkIdType index)
 Raises the child to the top of the item's stack. More...
 
virtual vtkIdType StackAbove (vtkIdType index, vtkIdType under)
 Raises the child above the under sibling. More...
 
vtkIdType Lower (vtkIdType index)
 Lowers the child to the bottom of the item's stack. More...
 
virtual vtkIdType StackUnder (vtkIdType child, vtkIdType above)
 Lowers the child under the above sibling. More...
 
virtual bool Hit (const vtkContextMouseEvent &mouse)
 Return true if the supplied x, y coordinate is inside the item. More...
 
virtual vtkAbstractContextItemGetPickedItem (const vtkContextMouseEvent &mouse)
 Return the item under the mouse. More...
 
virtual bool MouseEnterEvent (const vtkContextMouseEvent &mouse)
 Mouse enter event. More...
 
virtual bool MouseMoveEvent (const vtkContextMouseEvent &mouse)
 Mouse move event. More...
 
virtual bool MouseLeaveEvent (const vtkContextMouseEvent &mouse)
 Mouse leave event. More...
 
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. More...
 
virtual bool MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)
 Mouse button release event. More...
 
virtual bool MouseDoubleClickEvent (const vtkContextMouseEvent &mouse)
 Mouse button double click event. More...
 
virtual bool MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
 Mouse wheel event, positive delta indicates forward movement of the wheel. More...
 
virtual bool KeyPressEvent (const vtkContextKeyEvent &key)
 Key press event. More...
 
virtual bool KeyReleaseEvent (const vtkContextKeyEvent &key)
 Key release event. More...
 
virtual void SetScene (vtkContextScene *scene)
 Set the vtkContextScene for the item, always set for an item in a scene. More...
 
vtkContextSceneGetScene ()
 Get the vtkContextScene for the item, always set for an item in a scene. More...
 
virtual void SetParent (vtkAbstractContextItem *parent)
 Set the parent item. More...
 
vtkAbstractContextItemGetParent ()
 Get the parent item. More...
 
virtual vtkVector2f MapToParent (const vtkVector2f &point)
 Maps the point to the parent coordinate system. More...
 
virtual vtkVector2f MapFromParent (const vtkVector2f &point)
 Maps the point from the parent coordinate system. More...
 
virtual vtkVector2f MapToScene (const vtkVector2f &point)
 Maps the point to the scene coordinate system. More...
 
virtual vtkVector2f MapFromScene (const vtkVector2f &point)
 Maps the point from the scene coordinate system. More...
 
virtual bool GetVisible ()
 Get the visibility of the item (should it be drawn). More...
 
virtual void SetVisible (bool)
 Set the visibility of the item (should it be drawn). More...
 
virtual bool GetInteractive ()
 Get if the item is interactive (should respond to mouse events). More...
 
virtual void SetInteractive (bool)
 Set if the item is interactive (should respond to mouse events). More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
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. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkChartSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkContextItem
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkContextItemSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractContextItem
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractContextItemSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () 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. More...
 
bool CalculateUnscaledPlotTransform (vtkAxis *x, vtkAxis *y, vtkTransform2D *transform)
 Calculate the unshifted, and unscaled plot transform for the x and y axis. More...
 
void AttachAxisRangeListener (vtkAxis *)
 Attach axis range listener so we can forward those events at the chart level. More...
 
void AxisRangeForwarderCallback (vtkObject *, unsigned long, void *)
 
- Protected Member Functions inherited from vtkContextItem
 vtkContextItem ()
 
 ~vtkContextItem () override
 
- Protected Member Functions inherited from vtkAbstractContextItem
 vtkAbstractContextItem ()
 
 ~vtkAbstractContextItem () override
 
- 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. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkAnnotationLinkAnnotationLink
 Our annotation link, used for sharing selections etc. More...
 
int Geometry [2]
 The width and the height of the chart. More...
 
int Point1 [2]
 The position of the lower left corner of the chart. More...
 
int Point2 [2]
 The position of the upper right corner of the chart. More...
 
bool ShowLegend
 Display the legend? More...
 
vtkStdString Title
 The title of the chart. More...
 
vtkTextPropertyTitleProperties
 The text properties associated with the chart. More...
 
vtkRectf Size
 
int LayoutStrategy
 
bool RenderEmpty
 
vtkSmartPointer< vtkBrushBackgroundBrush
 Brush to use for drawing the background. More...
 
int SelectionMode
 
int SelectionMethod
 
MouseActions Actions
 
MouseClickActions ActionsClick
 
- Protected Attributes inherited from vtkContextItem
double Opacity
 
- Protected Attributes inherited from vtkAbstractContextItem
vtkContextSceneScene
 Point to the scene the item is on - can be null. More...
 
vtkAbstractContextItemParent
 Point to the parent item - can be null. More...
 
vtkContextScenePrivateChildren
 This structure provides a list of children, along with convenience functions to paint the children etc. More...
 
bool Visible
 Store the visibility of the item (default is true). More...
 
bool Interactive
 Store whether the item should respond to interactions (default is true). More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Factory class for drawing 2D charts.

This defines the interface for a chart.

Examples:
vtkChart (Examples)
Tests:
vtkChart (Tests)

Definition at line 50 of file vtkChart.h.

Member Typedef Documentation

◆ Superclass

Definition at line 53 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 59 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

Enumerator
PAN 
ZOOM 
ZOOM_AXIS 
SELECT 
SELECT_RECTANGLE 
SELECT_POLYGON 
CLICK_AND_DRAG 
NOTIFY 

Definition at line 80 of file vtkChart.h.

◆ EventIds

Enum of event type that are triggered by the charts.

Enumerator
UpdateRange 

Definition at line 94 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 171 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 285 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 vtkChartXY, vtkChartBox, vtkChartParallelCoordinates, vtkChartPie, and vtkChartHistogram2D.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkChart::NewInstanceInternal ( ) const
protectedvirtual

◆ 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 vtkObjectBase.

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

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

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

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

◆ RemovePlot()

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.

◆ ClearPlots()

virtual void vtkChart::ClearPlots ( )
virtual

Remove all plots from the chart.

Reimplemented in vtkChartXY.

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

◆ GetNumberOfPlots()

virtual vtkIdType vtkChart::GetNumberOfPlots ( )
virtual

Get the number of plots the chart contains.

Reimplemented in vtkChartXY, vtkChartBox, vtkChartParallelCoordinates, and vtkChartPie.

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

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

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

◆ 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

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

◆ SetGeometry() [2/2]

void vtkChart::SetGeometry ( int  [2])

◆ GetGeometry() [1/3]

virtual int* vtkChart::GetGeometry ( )
virtual

◆ GetGeometry() [2/3]

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

◆ GetGeometry() [3/3]

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

◆ 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])

◆ GetPoint1() [1/3]

virtual int* vtkChart::GetPoint1 ( )
virtual

◆ GetPoint1() [2/3]

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

◆ GetPoint1() [3/3]

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

◆ 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])

◆ GetPoint2() [1/3]

virtual int* vtkChart::GetPoint2 ( )
virtual

◆ GetPoint2() [2/3]

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

◆ GetPoint2() [3/3]

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

◆ SetShowLegend()

virtual void vtkChart::SetShowLegend ( bool  visible)
virtual

Set/get whether the chart should draw a legend.

Reimplemented in vtkChartXY, and vtkChartPie.

◆ GetShowLegend()

virtual bool vtkChart::GetShowLegend ( )
virtual

◆ GetLegend()

virtual vtkChartLegend* vtkChart::GetLegend ( )
virtual

Get the legend for the chart, if available.

Can return null if there is no legend.

Reimplemented in vtkChartXY, and vtkChartPie.

◆ SetTitle()

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

Get/set the title text of the chart.

◆ GetTitle()

virtual vtkStdString vtkChart::GetTitle ( )
virtual

◆ GetTitleProperties()

virtual vtkTextProperty* vtkChart::GetTitleProperties ( )
virtual

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

◆ SetBottomBorder()

void vtkChart::SetBottomBorder ( int  border)

Set/get the borders of the chart (space in pixels around the chart).

◆ SetTopBorder()

void vtkChart::SetTopBorder ( int  border)

◆ SetLeftBorder()

void vtkChart::SetLeftBorder ( int  border)

◆ SetRightBorder()

void vtkChart::SetRightBorder ( int  border)

◆ SetBorders()

void vtkChart::SetBorders ( int  left,
int  bottom,
int  right,
int  top 
)

Set/get the borders of the chart (space in pixels around the chart).

◆ SetSize()

void vtkChart::SetSize ( const vtkRectf rect)

Set the size of the chart.

The rect argument specifies the bottom corner, width and height of the chart. The borders will be laid out within the specified rectangle.

◆ GetSize()

vtkRectf vtkChart::GetSize ( )

Get the current size of the chart.

◆ SetLayoutStrategy()

virtual void vtkChart::SetLayoutStrategy ( int  )
virtual

Set/get the layout strategy that should be used by the chart.

As we don't support enums this can take any value in the integer range, but the only valid enums are FILL_SCENE, FILL_RECT and AXES_TO_RECT.

◆ GetLayoutStrategy()

virtual int vtkChart::GetLayoutStrategy ( )
virtual

◆ SetAutoSize()

virtual void vtkChart::SetAutoSize ( bool  isAutoSized)
inlinevirtual

Set/get whether the chart should automatically resize to fill the current render window.

Default is true.

Definition at line 306 of file vtkChart.h.

◆ GetAutoSize()

virtual bool vtkChart::GetAutoSize ( )
inlinevirtual

Definition at line 311 of file vtkChart.h.

◆ SetRenderEmpty()

virtual void vtkChart::SetRenderEmpty ( bool  )
virtual

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

Default is false (do not render an empty plot).

Note that if you wish to render axes for an empty plot you should also set AutoSize to false, as that will hide all axes for an empty plot.

◆ GetRenderEmpty()

virtual bool vtkChart::GetRenderEmpty ( )
virtual

◆ SetActionToButton()

virtual void vtkChart::SetActionToButton ( int  action,
int  button 
)
virtual

Assign action types to mouse buttons.

Available action types are PAN, ZOOM and SELECT in the chart enum, the default assigns the LEFT_BUTTON to PAN, MIDDLE_BUTTON to ZOOM and RIGHT_BUTTON to SELECT. Valid mouse enums are in the vtkContextMouseEvent class.

Note that only one mouse button can be assigned to each action, an action will have -1 (invalid button) assigned if it had the same button as the one assigned to a different action.

◆ GetActionToButton()

virtual int vtkChart::GetActionToButton ( int  action)
virtual

Get the mouse button associated with the supplied action.

The mouse button enum is from vtkContextMouseEvent, and the action enum is from vtkChart.

◆ SetClickActionToButton()

virtual void vtkChart::SetClickActionToButton ( int  action,
int  button 
)
virtual

Assign action types to single mouse clicks.

Available action types are SELECT and NOTIFY in the chart enum. The default assigns the LEFT_BUTTON to NOTIFY, and the RIGHT_BUTTON to SELECT.

◆ GetClickActionToButton()

virtual int vtkChart::GetClickActionToButton ( int  action)
virtual

Get the mouse button associated with the supplied click action.

The mouse button enum is from vtkContextMouseEvent, and the action enum is from vtkChart.

◆ SetBackgroundBrush()

void vtkChart::SetBackgroundBrush ( vtkBrush brush)

Set/Get the brush to use for the background color.

◆ GetBackgroundBrush()

vtkBrush* vtkChart::GetBackgroundBrush ( )

◆ SetSelectionMode()

virtual void vtkChart::SetSelectionMode ( int  )
virtual

Set/get the Selection Mode that will be used by the chart while doing selection.

The only valid enums are vtkContextScene::SELECTION_NONE, SELECTION_DEFAULT, SELECTION_ADDITION, SELECTION_SUBTRACTION, SELECTION_TOGGLE

◆ GetSelectionMode()

virtual int vtkChart::GetSelectionMode ( )
virtual

◆ CalculatePlotTransform()

bool vtkChart::CalculatePlotTransform ( vtkAxis x,
vtkAxis y,
vtkTransform2D transform 
)
protected

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.

This assumes that the axes have the correct start and end positions, and that they are perpendicular.

◆ CalculateUnscaledPlotTransform()

bool vtkChart::CalculateUnscaledPlotTransform ( vtkAxis x,
vtkAxis y,
vtkTransform2D transform 
)
protected

Calculate the unshifted, and unscaled plot transform for the x and y axis.

◆ AttachAxisRangeListener()

void vtkChart::AttachAxisRangeListener ( vtkAxis )
protected

Attach axis range listener so we can forward those events at the chart level.

◆ AxisRangeForwarderCallback()

void vtkChart::AxisRangeForwarderCallback ( vtkObject ,
unsigned long  ,
void *   
)
protected

Member Data Documentation

◆ AnnotationLink

vtkAnnotationLink* vtkChart::AnnotationLink
protected

Our annotation link, used for sharing selections etc.

Definition at line 409 of file vtkChart.h.

◆ Geometry

int vtkChart::Geometry[2]
protected

The width and the height of the chart.

Definition at line 414 of file vtkChart.h.

◆ Point1

int vtkChart::Point1[2]
protected

The position of the lower left corner of the chart.

Definition at line 419 of file vtkChart.h.

◆ Point2

int vtkChart::Point2[2]
protected

The position of the upper right corner of the chart.

Definition at line 424 of file vtkChart.h.

◆ ShowLegend

bool vtkChart::ShowLegend
protected

Display the legend?

Definition at line 429 of file vtkChart.h.

◆ Title

vtkStdString vtkChart::Title
protected

The title of the chart.

Definition at line 434 of file vtkChart.h.

◆ TitleProperties

vtkTextProperty* vtkChart::TitleProperties
protected

The text properties associated with the chart.

Definition at line 439 of file vtkChart.h.

◆ Size

vtkRectf vtkChart::Size
protected

Definition at line 441 of file vtkChart.h.

◆ LayoutStrategy

int vtkChart::LayoutStrategy
protected

Definition at line 443 of file vtkChart.h.

◆ RenderEmpty

bool vtkChart::RenderEmpty
protected

Definition at line 444 of file vtkChart.h.

◆ BackgroundBrush

vtkSmartPointer<vtkBrush> vtkChart::BackgroundBrush
protected

Brush to use for drawing the background.

Definition at line 449 of file vtkChart.h.

◆ SelectionMode

int vtkChart::SelectionMode
protected

Definition at line 452 of file vtkChart.h.

◆ SelectionMethod

int vtkChart::SelectionMethod
protected

Definition at line 456 of file vtkChart.h.

◆ Actions

MouseActions vtkChart::Actions
protected

Definition at line 487 of file vtkChart.h.

◆ ActionsClick

MouseClickActions vtkChart::ActionsClick
protected

Definition at line 488 of file vtkChart.h.


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