VTK  9.0.20210920
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPlot Class Reference

Abstract class for 2D plots. More...

#include <vtkPlot.h>

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

Public Types

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...
 
vtkPlotNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual bool PaintLegend (vtkContext2D *painter, const vtkRectf &rect, int legendIndex)
 Paint legend event for the plot, called whenever the legend needs the plot items symbol/mark/line drawn. More...
 
virtual vtkStdString GetTooltipLabel (const vtkVector2d &plotPos, vtkIdType seriesIndex, vtkIdType segmentIndex)
 Generate and return the tooltip label string for this plot The segmentIndex parameter is ignored, except for vtkPlotBar. More...
 
virtual vtkIdType GetNearestPoint (const vtkVector2f &point, const vtkVector2f &tolerance, vtkVector2f *location, vtkIdType *segmentId)
 Function to query a plot for the nearest point to the specified coordinate. More...
 
virtual vtkIdType GetNearestPoint (const vtkVector2f &point, const vtkVector2f &tolerance, vtkVector2f *location)
 Function to query a plot for the nearest point to the specified coordinate. More...
 
virtual bool SelectPoints (const vtkVector2f &min, const vtkVector2f &max)
 Select all points in the specified rectangle. More...
 
virtual bool SelectPointsInPolygon (const vtkContextPolygon &polygon)
 Select all points in the specified polygon. More...
 
virtual void SetWidth (float width)
 Set the width of the line. More...
 
virtual float GetWidth ()
 Get the width of the line. More...
 
virtual void SetLabel (const vtkStdString &label)
 Set the label of this plot. More...
 
virtual vtkStdString GetLabel ()
 Get the label of this plot. More...
 
virtual void SetLabels (vtkStringArray *labels)
 Set the plot labels, these are used for stacked chart variants, with the index referring to the stacking index. More...
 
virtual vtkStringArrayGetLabels ()
 Get the plot labels. More...
 
virtual int GetNumberOfLabels ()
 Get the number of labels associated with this plot. More...
 
vtkStdString GetLabel (vtkIdType index)
 Get the label at the specified index. More...
 
void SetIndexedLabels (vtkStringArray *labels)
 Set indexed labels for the plot. More...
 
virtual vtkStringArrayGetIndexedLabels ()
 Get the indexed labels array. More...
 
vtkContextMapper2DGetData ()
 Get the data object that the plot will draw. More...
 
virtual vtkTableGetInput ()
 Get the input table used by the plot. More...
 
virtual void SetInputArray (int index, const vtkStdString &name)
 Convenience function to set the input arrays. More...
 
virtual void GetBounds (double bounds[4])
 Get the bounds for this plot as (Xmin, Xmax, Ymin, Ymax). More...
 
virtual void GetUnscaledInputBounds (double bounds[4])
 Provide un-log-scaled bounds for the plot inputs. More...
 
virtual void UpdateCache ()
 Subclasses that build data caches to speed up painting should override this method to update such caches. More...
 
bool Hit (const vtkContextMouseEvent &mouse) override
 Returns true if the supplied x, y coordinate is inside the item. More...
 
virtual void SetLegendVisibility (bool)
 Set whether the plot renders an entry in the legend. More...
 
virtual bool GetLegendVisibility ()
 Set whether the plot renders an entry in the legend. More...
 
virtual void LegendVisibilityOn ()
 Set whether the plot renders an entry in the legend. More...
 
virtual void LegendVisibilityOff ()
 Set whether the plot renders an entry in the legend. More...
 
virtual void SetTooltipLabelFormat (const vtkStdString &label)
 Sets/gets a printf-style string to build custom tooltip labels from. More...
 
virtual vtkStdString GetTooltipLabelFormat ()
 Sets/gets a printf-style string to build custom tooltip labels from. More...
 
virtual void SetTooltipNotation (int notation)
 Sets/gets the tooltip notation style. More...
 
virtual int GetTooltipNotation ()
 Sets/gets the tooltip notation style. More...
 
virtual void SetTooltipPrecision (int precision)
 Sets/gets the tooltip precision. More...
 
virtual int GetTooltipPrecision ()
 Sets/gets the tooltip precision. More...
 
virtual void SetColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
 Set the plot color. More...
 
virtual void SetColor (double r, double g, double b)
 Set the plot color. More...
 
virtual void GetColor (double rgb[3])
 Set the plot color. More...
 
void GetColor (unsigned char rgb[3])
 Set the plot color. More...
 
void SetPen (vtkPen *pen)
 Set/get the vtkPen object that controls how this plot draws (out)lines. More...
 
vtkPenGetPen ()
 Set/get the vtkPen object that controls how this plot draws (out)lines. More...
 
void SetBrush (vtkBrush *brush)
 Set/get the vtkBrush object that controls how this plot fills shapes. More...
 
vtkBrushGetBrush ()
 Set/get the vtkBrush object that controls how this plot fills shapes. More...
 
void SetSelectionPen (vtkPen *pen)
 Set/get the vtkBrush object that controls how this plot fills selected shapes. More...
 
vtkPenGetSelectionPen ()
 Set/get the vtkBrush object that controls how this plot fills selected shapes. More...
 
void SetSelectionBrush (vtkBrush *brush)
 Set/get the vtkBrush object that controls how this plot fills selected shapes. More...
 
vtkBrushGetSelectionBrush ()
 Set/get the vtkBrush object that controls how this plot fills selected shapes. More...
 
virtual bool GetUseIndexForXSeries ()
 Use the Y array index for the X value. More...
 
virtual void SetUseIndexForXSeries (bool)
 Use the Y array index for the X value. More...
 
virtual void SetInputData (vtkTable *table)
 This is a convenience function to set the input table and the x, y column for the plot. More...
 
virtual void SetInputData (vtkTable *table, const vtkStdString &xColumn, const vtkStdString &yColumn)
 This is a convenience function to set the input table and the x, y column for the plot. More...
 
void SetInputData (vtkTable *table, vtkIdType xColumn, vtkIdType yColumn)
 This is a convenience function to set the input table and the x, y column for the plot. More...
 
virtual void SetSelectable (bool)
 Set whether the plot can be selected. More...
 
virtual bool GetSelectable ()
 Set whether the plot can be selected. More...
 
virtual void SelectableOn ()
 Set whether the plot can be selected. More...
 
virtual void SelectableOff ()
 Set whether the plot can be selected. More...
 
virtual void SetSelection (vtkIdTypeArray *id)
 Sets the list of points that must be selected. More...
 
virtual vtkIdTypeArrayGetSelection ()
 Sets the list of points that must be selected. More...
 
virtual vtkAxisGetXAxis ()
 Get/set the X axis associated with this plot. More...
 
virtual void SetXAxis (vtkAxis *axis)
 Get/set the X axis associated with this plot. More...
 
virtual vtkAxisGetYAxis ()
 Get/set the Y axis associated with this plot. More...
 
virtual void SetYAxis (vtkAxis *axis)
 Get/set the Y axis associated with this plot. More...
 
void SetShiftScale (const vtkRectd &shiftScale)
 Get/set the origin shift and scaling factor used by the plot, this is normally 0.0 offset and 1.0 scaling, but can be used to render data outside of the single precision range. More...
 
vtkRectd GetShiftScale ()
 Get/set the origin shift and scaling factor used by the plot, this is normally 0.0 offset and 1.0 scaling, but can be used to render data outside of the single precision range. More...
 
virtual void SetProperty (const vtkStdString &property, const vtkVariant &var)
 A General setter/getter that should be overridden. More...
 
virtual vtkVariant GetProperty (const vtkStdString &property)
 A General setter/getter that should be overridden. More...
 
- 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 void SetTransform (vtkContextTransform *)
 Set the transform of the item. 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 Paint (vtkContext2D *painter)
 Paint event for the item, called whenever the item needs to be drawn. 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 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...
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 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, 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)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
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). 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 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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPlotSafeDownCast (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 ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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 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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkPlot ()
 
 ~vtkPlot () override
 
vtkStdString GetNumber (double position, vtkAxis *axis)
 Get the properly formatted number for the supplied position and axis. More...
 
virtual void TransformScreenToData (const vtkVector2f &in, vtkVector2f &out)
 Transform the mouse event in the control-points space. More...
 
virtual void TransformDataToScreen (const vtkVector2f &in, vtkVector2f &out)
 Transform the mouse event in the control-points space. More...
 
virtual void TransformScreenToData (const double inX, const double inY, double &outX, double &outY)
 Transform the mouse event in the control-points space. More...
 
virtual void TransformDataToScreen (const double inX, const double inY, double &outX, double &outY)
 Transform the mouse event in the control-points space. More...
 
- Protected Member Functions inherited from vtkContextItem
 vtkContextItem ()=default
 
 ~vtkContextItem () override=default
 
- 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 ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkSmartPointer< vtkPenPen
 This object stores the vtkPen that controls how the plot is drawn. More...
 
vtkSmartPointer< vtkBrushBrush
 This object stores the vtkBrush that controls how the plot is drawn. More...
 
vtkSmartPointer< vtkPenSelectionPen
 This object stores the vtkPen that controls how the selected elements of the plot are drawn. More...
 
vtkSmartPointer< vtkBrushSelectionBrush
 This object stores the vtkBrush that controls how the selected elements of the plot are drawn. More...
 
vtkSmartPointer< vtkStringArrayLabels
 Plot labels, used by legend. More...
 
vtkSmartPointer< vtkStringArrayAutoLabels
 Holds Labels when they're auto-created. More...
 
vtkSmartPointer< vtkStringArrayIndexedLabels
 Holds Labels when they're auto-created. More...
 
bool UseIndexForXSeries
 Use the Y array index for the X value. More...
 
vtkSmartPointer< vtkContextMapper2DData
 This data member contains the data that will be plotted, it inherits from vtkAlgorithm. More...
 
bool Selectable
 Whether plot points can be selected or not. More...
 
vtkIdTypeArraySelection
 Selected indices for the table the plot is rendering. More...
 
vtkAxisXAxis
 The X axis associated with this plot. More...
 
vtkAxisYAxis
 The X axis associated with this plot. More...
 
vtkStdString TooltipLabelFormat
 A printf-style string to build custom tooltip labels from. More...
 
vtkStdString TooltipDefaultLabelFormat
 The default printf-style string to build custom tooltip labels from. More...
 
int TooltipNotation
 
int TooltipPrecision
 
vtkRectd ShiftScale
 The current shift in origin and scaling factor applied to the plot. More...
 
bool LegendVisibility
 
bool LegacyRecursionFlag = false
 Flag used by GetNearestPoint legacy implementation to avoid infinite call. More...
 
- Protected Attributes inherited from vtkContextItem
double Opacity = 1.0
 
vtkContextTransformTransform = nullptr
 
- 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
 
static bool ClampPos (double pos[2], double bounds[4])
 Clamp the given 2D pos into the provided bounds Return true if the pos has been clamped, false otherwise. More...
 
virtual bool ClampPos (double pos[2])
 Clamp the given 2D pos into the provided bounds Return true if the pos has been clamped, false otherwise. More...
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

Abstract class for 2D plots.

The base class for all plot types used in vtkChart derived charts.

See also
vtkPlotPoints vtkPlotLine vtkPlotBar vtkChart vtkChartXY
Online Examples:

Definition at line 156 of file vtkPlot.h.

Member Typedef Documentation

◆ Superclass

Definition at line 159 of file vtkPlot.h.

Constructor & Destructor Documentation

◆ vtkPlot()

vtkPlot::vtkPlot ( )
protected

◆ ~vtkPlot()

vtkPlot::~vtkPlot ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkPlot::IsA ( const char *  name)
virtual

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkPlot::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkPlot* vtkPlot::NewInstance ( ) const

◆ PrintSelf()

void vtkPlot::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 vtkScalarsToColorsItem, vtkRangeHandlesItem, vtkPlotStacked, vtkPlotRangeHandlesItem, vtkPlotPoints, vtkPlotPie, vtkPlotParallelCoordinates, vtkPlotLine, vtkPlotHistogram2D, vtkPlotFunctionalBag, vtkPlotBox, vtkPlotBarRangeHandlesItem, vtkPlotBar, vtkPlotBag, and vtkPlotArea.

◆ SetLegendVisibility()

virtual void vtkPlot::SetLegendVisibility ( bool  )
virtual

Set whether the plot renders an entry in the legend.

Default is true. vtkPlot::PaintLegend will get called to render the legend marker on when this is true.

◆ GetLegendVisibility()

virtual bool vtkPlot::GetLegendVisibility ( )
virtual

Set whether the plot renders an entry in the legend.

Default is true. vtkPlot::PaintLegend will get called to render the legend marker on when this is true.

◆ LegendVisibilityOn()

virtual void vtkPlot::LegendVisibilityOn ( )
virtual

Set whether the plot renders an entry in the legend.

Default is true. vtkPlot::PaintLegend will get called to render the legend marker on when this is true.

◆ LegendVisibilityOff()

virtual void vtkPlot::LegendVisibilityOff ( )
virtual

Set whether the plot renders an entry in the legend.

Default is true. vtkPlot::PaintLegend will get called to render the legend marker on when this is true.

◆ PaintLegend()

virtual bool vtkPlot::PaintLegend ( vtkContext2D painter,
const vtkRectf rect,
int  legendIndex 
)
virtual

Paint legend event for the plot, called whenever the legend needs the plot items symbol/mark/line drawn.

A rect is supplied with the lower left corner of the rect (elements 0 and 1) and with width x height (elements 2 and 3). The plot can choose how to fill the space supplied. The index is used by Plots that return more than one label.

Reimplemented in vtkPlotStacked, vtkPlotPoints, vtkPlotPie, vtkPlotParallelCoordinates, vtkPlotLine, vtkPlotFunctionalBag, vtkPlotBox, vtkPlotBar, vtkPlotBag, and vtkPlotArea.

◆ SetTooltipLabelFormat()

virtual void vtkPlot::SetTooltipLabelFormat ( const vtkStdString label)
virtual

Sets/gets a printf-style string to build custom tooltip labels from.

An empty string generates the default tooltip labels. The following case-sensitive format tags (without quotes) are recognized: 'x' The X value of the plot element 'y' The Y value of the plot element 'i' The IndexedLabels entry for the plot element 'l' The value of the plot's GetLabel() function 's' (vtkPlotBar only) The Labels entry for the bar segment Any other characters or unrecognized format tags are printed in the tooltip label verbatim.

◆ GetTooltipLabelFormat()

virtual vtkStdString vtkPlot::GetTooltipLabelFormat ( )
virtual

Sets/gets a printf-style string to build custom tooltip labels from.

An empty string generates the default tooltip labels. The following case-sensitive format tags (without quotes) are recognized: 'x' The X value of the plot element 'y' The Y value of the plot element 'i' The IndexedLabels entry for the plot element 'l' The value of the plot's GetLabel() function 's' (vtkPlotBar only) The Labels entry for the bar segment Any other characters or unrecognized format tags are printed in the tooltip label verbatim.

◆ SetTooltipNotation()

virtual void vtkPlot::SetTooltipNotation ( int  notation)
virtual

Sets/gets the tooltip notation style.

◆ GetTooltipNotation()

virtual int vtkPlot::GetTooltipNotation ( )
virtual

Sets/gets the tooltip notation style.

◆ SetTooltipPrecision()

virtual void vtkPlot::SetTooltipPrecision ( int  precision)
virtual

Sets/gets the tooltip precision.

◆ GetTooltipPrecision()

virtual int vtkPlot::GetTooltipPrecision ( )
virtual

Sets/gets the tooltip precision.

◆ GetTooltipLabel()

virtual vtkStdString vtkPlot::GetTooltipLabel ( const vtkVector2d plotPos,
vtkIdType  seriesIndex,
vtkIdType  segmentIndex 
)
virtual

Generate and return the tooltip label string for this plot The segmentIndex parameter is ignored, except for vtkPlotBar.

Reimplemented in vtkScalarsToColorsItem, vtkPlotHistogram2D, vtkPlotBar, vtkPlotBag, and vtkPlotArea.

◆ GetNearestPoint() [1/2]

virtual vtkIdType vtkPlot::GetNearestPoint ( const vtkVector2f point,
const vtkVector2f tolerance,
vtkVector2f location,
vtkIdType segmentId 
)
virtual

Function to query a plot for the nearest point to the specified coordinate.

Returns the index of the data series with which the point is associated, or -1 if no point was found.

Reimplemented in vtkPlotStacked, vtkPlotPoints, vtkPlotPie, vtkPlotHistogram2D, vtkPlotFunctionalBag, vtkPlotBox, vtkPlotArea, vtkScalarsToColorsItem, and vtkPlotBar.

◆ GetNearestPoint() [2/2]

virtual vtkIdType vtkPlot::GetNearestPoint ( const vtkVector2f point,
const vtkVector2f tolerance,
vtkVector2f location 
)
virtual

Function to query a plot for the nearest point to the specified coordinate.

Returns the index of the data series with which the point is associated, or -1 if no point was found. Deprecated method, uses GetNearestPoint(const vtkVector2f& point, const vtkVector2f& tolerance, vtkVector2f* location, vtkIdType* segmentId); instead.

◆ SelectPoints()

virtual bool vtkPlot::SelectPoints ( const vtkVector2f min,
const vtkVector2f max 
)
virtual

Select all points in the specified rectangle.

Reimplemented in vtkPlotStacked, vtkPlotPoints, vtkPlotFunctionalBag, vtkPlotBar, and vtkControlPointsItem.

◆ SelectPointsInPolygon()

virtual bool vtkPlot::SelectPointsInPolygon ( const vtkContextPolygon polygon)
virtual

Select all points in the specified polygon.

Reimplemented in vtkPlotPoints, and vtkPlotFunctionalBag.

◆ SetColor() [1/2]

virtual void vtkPlot::SetColor ( unsigned char  r,
unsigned char  g,
unsigned char  b,
unsigned char  a 
)
virtual

Set the plot color.

Reimplemented in vtkPlotStacked, vtkPlotBar, and vtkPlotArea.

◆ SetColor() [2/2]

virtual void vtkPlot::SetColor ( double  r,
double  g,
double  b 
)
virtual

Set the plot color.

Reimplemented in vtkPlotStacked, vtkPlotBar, and vtkPlotArea.

◆ GetColor() [1/2]

virtual void vtkPlot::GetColor ( double  rgb[3])
virtual

Set the plot color.

Reimplemented in vtkPlotStacked, and vtkPlotBar.

◆ GetColor() [2/2]

void vtkPlot::GetColor ( unsigned char  rgb[3])

Set the plot color.

◆ SetWidth()

virtual void vtkPlot::SetWidth ( float  width)
virtual

Set the width of the line.

Reimplemented in vtkPlotBar.

◆ GetWidth()

virtual float vtkPlot::GetWidth ( )
virtual

Get the width of the line.

Reimplemented in vtkPlotBar.

◆ SetPen()

void vtkPlot::SetPen ( vtkPen pen)

Set/get the vtkPen object that controls how this plot draws (out)lines.

◆ GetPen()

vtkPen* vtkPlot::GetPen ( )

Set/get the vtkPen object that controls how this plot draws (out)lines.

◆ SetBrush()

void vtkPlot::SetBrush ( vtkBrush brush)

Set/get the vtkBrush object that controls how this plot fills shapes.

◆ GetBrush()

vtkBrush* vtkPlot::GetBrush ( )

Set/get the vtkBrush object that controls how this plot fills shapes.

◆ SetSelectionPen()

void vtkPlot::SetSelectionPen ( vtkPen pen)

Set/get the vtkBrush object that controls how this plot fills selected shapes.

◆ GetSelectionPen()

vtkPen* vtkPlot::GetSelectionPen ( )

Set/get the vtkBrush object that controls how this plot fills selected shapes.

◆ SetSelectionBrush()

void vtkPlot::SetSelectionBrush ( vtkBrush brush)

Set/get the vtkBrush object that controls how this plot fills selected shapes.

◆ GetSelectionBrush()

vtkBrush* vtkPlot::GetSelectionBrush ( )

Set/get the vtkBrush object that controls how this plot fills selected shapes.

◆ SetLabel()

virtual void vtkPlot::SetLabel ( const vtkStdString label)
virtual

Set the label of this plot.

◆ GetLabel() [1/2]

virtual vtkStdString vtkPlot::GetLabel ( )
virtual

Get the label of this plot.

◆ SetLabels()

virtual void vtkPlot::SetLabels ( vtkStringArray labels)
virtual

Set the plot labels, these are used for stacked chart variants, with the index referring to the stacking index.

◆ GetLabels()

virtual vtkStringArray* vtkPlot::GetLabels ( )
virtual

Get the plot labels.

If this array has a length greater than 1 the index refers to the stacked objects in the plot. See vtkPlotBar for example.

Reimplemented in vtkPlotStacked, vtkPlotBox, vtkPlotBar, and vtkPlotBag.

◆ GetNumberOfLabels()

virtual int vtkPlot::GetNumberOfLabels ( )
virtual

Get the number of labels associated with this plot.

◆ GetLabel() [2/2]

vtkStdString vtkPlot::GetLabel ( vtkIdType  index)

Get the label at the specified index.

◆ SetIndexedLabels()

void vtkPlot::SetIndexedLabels ( vtkStringArray labels)

Set indexed labels for the plot.

If set, this array can be used to provide custom labels for each point in a plot. This array should be the same length as the points array. Default is null (no indexed labels).

◆ GetIndexedLabels()

virtual vtkStringArray* vtkPlot::GetIndexedLabels ( )
virtual

Get the indexed labels array.

◆ GetData()

vtkContextMapper2D* vtkPlot::GetData ( )

Get the data object that the plot will draw.

◆ GetUseIndexForXSeries()

virtual bool vtkPlot::GetUseIndexForXSeries ( )
virtual

Use the Y array index for the X value.

If true any X column setting will be ignored, and the X values will simply be the index of the Y column.

◆ SetUseIndexForXSeries()

virtual void vtkPlot::SetUseIndexForXSeries ( bool  )
virtual

Use the Y array index for the X value.

If true any X column setting will be ignored, and the X values will simply be the index of the Y column.

◆ SetInputData() [1/3]

virtual void vtkPlot::SetInputData ( vtkTable table)
virtual

This is a convenience function to set the input table and the x, y column for the plot.

Reimplemented in vtkPlotParallelCoordinates, vtkPlotBox, vtkPlotBag, and vtkPlotHistogram2D.

◆ SetInputData() [2/3]

virtual void vtkPlot::SetInputData ( vtkTable table,
const vtkStdString xColumn,
const vtkStdString yColumn 
)
virtual

This is a convenience function to set the input table and the x, y column for the plot.

Reimplemented in vtkPlotBag, vtkPlotParallelCoordinates, vtkPlotBox, and vtkPlotHistogram2D.

◆ SetInputData() [3/3]

void vtkPlot::SetInputData ( vtkTable table,
vtkIdType  xColumn,
vtkIdType  yColumn 
)

This is a convenience function to set the input table and the x, y column for the plot.

◆ GetInput()

virtual vtkTable* vtkPlot::GetInput ( )
virtual

Get the input table used by the plot.

◆ SetInputArray()

virtual void vtkPlot::SetInputArray ( int  index,
const vtkStdString name 
)
virtual

Convenience function to set the input arrays.

For most plots index 0 is the x axis, and index 1 is the y axis. The name is the name of the column in the vtkTable.

Reimplemented in vtkPlotStacked, and vtkPlotBar.

◆ SetSelectable()

virtual void vtkPlot::SetSelectable ( bool  )
virtual

Set whether the plot can be selected.

True by default. If not, then SetSelection(), SelectPoints() or SelectPointsInPolygon() won't have any effect.

See also
SetSelection(), SelectPoints(), SelectPointsInPolygon()

◆ GetSelectable()

virtual bool vtkPlot::GetSelectable ( )
virtual

Set whether the plot can be selected.

True by default. If not, then SetSelection(), SelectPoints() or SelectPointsInPolygon() won't have any effect.

See also
SetSelection(), SelectPoints(), SelectPointsInPolygon()

◆ SelectableOn()

virtual void vtkPlot::SelectableOn ( )
virtual

Set whether the plot can be selected.

True by default. If not, then SetSelection(), SelectPoints() or SelectPointsInPolygon() won't have any effect.

See also
SetSelection(), SelectPoints(), SelectPointsInPolygon()

◆ SelectableOff()

virtual void vtkPlot::SelectableOff ( )
virtual

Set whether the plot can be selected.

True by default. If not, then SetSelection(), SelectPoints() or SelectPointsInPolygon() won't have any effect.

See also
SetSelection(), SelectPoints(), SelectPointsInPolygon()

◆ SetSelection()

virtual void vtkPlot::SetSelection ( vtkIdTypeArray id)
virtual

Sets the list of points that must be selected.

If Selectable is false, then this method does nothing.

See also
SetSelectable()

◆ GetSelection()

virtual vtkIdTypeArray* vtkPlot::GetSelection ( )
virtual

Sets the list of points that must be selected.

If Selectable is false, then this method does nothing.

See also
SetSelectable()

◆ GetXAxis()

virtual vtkAxis* vtkPlot::GetXAxis ( )
virtual

Get/set the X axis associated with this plot.

◆ SetXAxis()

virtual void vtkPlot::SetXAxis ( vtkAxis axis)
virtual

Get/set the X axis associated with this plot.

◆ GetYAxis()

virtual vtkAxis* vtkPlot::GetYAxis ( )
virtual

Get/set the Y axis associated with this plot.

◆ SetYAxis()

virtual void vtkPlot::SetYAxis ( vtkAxis axis)
virtual

Get/set the Y axis associated with this plot.

◆ SetShiftScale()

void vtkPlot::SetShiftScale ( const vtkRectd shiftScale)

Get/set the origin shift and scaling factor used by the plot, this is normally 0.0 offset and 1.0 scaling, but can be used to render data outside of the single precision range.

The chart that owns the plot should set this and ensure the appropriate matrix is used when rendering the plot.

◆ GetShiftScale()

vtkRectd vtkPlot::GetShiftScale ( )

Get/set the origin shift and scaling factor used by the plot, this is normally 0.0 offset and 1.0 scaling, but can be used to render data outside of the single precision range.

The chart that owns the plot should set this and ensure the appropriate matrix is used when rendering the plot.

◆ GetBounds()

virtual void vtkPlot::GetBounds ( double  bounds[4])
inlinevirtual

Get the bounds for this plot as (Xmin, Xmax, Ymin, Ymax).

See GetUnscaledInputBounds for more information.

Reimplemented in vtkScalarsToColorsItem, vtkRangeHandlesItem, vtkPlotStacked, vtkPlotRangeHandlesItem, vtkPlotPoints, vtkPlotParallelCoordinates, vtkPlotHistogram2D, vtkPlotFunctionalBag, vtkPlotBarRangeHandlesItem, vtkPlotBar, vtkPlotArea, and vtkControlPointsItem.

Definition at line 447 of file vtkPlot.h.

◆ GetUnscaledInputBounds()

virtual void vtkPlot::GetUnscaledInputBounds ( double  bounds[4])
inlinevirtual

Provide un-log-scaled bounds for the plot inputs.

This function is analogous to GetBounds() with 2 exceptions:

  1. It will never return log-scaled bounds even when the x- and/or y-axes are log-scaled.
  2. It will always return the bounds along the input axes rather than the output chart coordinates. Thus GetXAxis() returns the axis associated with the first 2 bounds entries and GetYAxis() returns the axis associated with the next 2 bounds entries.

For example, vtkPlotBar's GetBounds() method will swap axis bounds when its orientation is vertical while its GetUnscaledInputBounds() will not swap axis bounds.

This method is provided so user interfaces can determine whether or not to allow log-scaling of a particular vtkAxis.

Subclasses of vtkPlot are responsible for implementing this function to transform input plot data.

The returned bounds are stored as (Xmin, Xmax, Ymin, Ymax).

Reimplemented in vtkPlotStacked, vtkPlotPoints, vtkPlotFunctionalBag, and vtkPlotBar.

Definition at line 473 of file vtkPlot.h.

◆ UpdateCache()

virtual void vtkPlot::UpdateCache ( )
inlinevirtual

Subclasses that build data caches to speed up painting should override this method to update such caches.

This is called on each Paint, hence subclasses must add checks to avoid rebuilding of cache, unless necessary. Default implementation is empty.

Reimplemented in vtkPlotArea.

Definition at line 486 of file vtkPlot.h.

◆ SetProperty()

virtual void vtkPlot::SetProperty ( const vtkStdString property,
const vtkVariant var 
)
virtual

A General setter/getter that should be overridden.

It can silently drop options, case is important

◆ GetProperty()

virtual vtkVariant vtkPlot::GetProperty ( const vtkStdString property)
virtual

A General setter/getter that should be overridden.

It can silently drop options, case is important

◆ ClampPos() [1/2]

static bool vtkPlot::ClampPos ( double  pos[2],
double  bounds[4] 
)
static

Clamp the given 2D pos into the provided bounds Return true if the pos has been clamped, false otherwise.

◆ ClampPos() [2/2]

virtual bool vtkPlot::ClampPos ( double  pos[2])
virtual

Clamp the given 2D pos into the provided bounds Return true if the pos has been clamped, false otherwise.

◆ Hit()

bool vtkPlot::Hit ( const vtkContextMouseEvent mouse)
overridevirtual

Returns true if the supplied x, y coordinate is inside the item.

Reimplemented from vtkAbstractContextItem.

Reimplemented in vtkPlotRangeHandlesItem.

◆ GetNumber()

vtkStdString vtkPlot::GetNumber ( double  position,
vtkAxis axis 
)
protected

Get the properly formatted number for the supplied position and axis.

◆ TransformScreenToData() [1/2]

virtual void vtkPlot::TransformScreenToData ( const vtkVector2f in,
vtkVector2f out 
)
protectedvirtual

Transform the mouse event in the control-points space.

This is needed when using logScale or shiftscale.

◆ TransformDataToScreen() [1/2]

virtual void vtkPlot::TransformDataToScreen ( const vtkVector2f in,
vtkVector2f out 
)
protectedvirtual

Transform the mouse event in the control-points space.

This is needed when using logScale or shiftscale.

◆ TransformScreenToData() [2/2]

virtual void vtkPlot::TransformScreenToData ( const double  inX,
const double  inY,
double &  outX,
double &  outY 
)
protectedvirtual

Transform the mouse event in the control-points space.

This is needed when using logScale or shiftscale.

Reimplemented in vtkPlotRangeHandlesItem.

◆ TransformDataToScreen() [2/2]

virtual void vtkPlot::TransformDataToScreen ( const double  inX,
const double  inY,
double &  outX,
double &  outY 
)
protectedvirtual

Transform the mouse event in the control-points space.

This is needed when using logScale or shiftscale.

Reimplemented in vtkPlotRangeHandlesItem.

Member Data Documentation

◆ Pen

vtkSmartPointer<vtkPen> vtkPlot::Pen
protected

This object stores the vtkPen that controls how the plot is drawn.

Definition at line 536 of file vtkPlot.h.

◆ Brush

vtkSmartPointer<vtkBrush> vtkPlot::Brush
protected

This object stores the vtkBrush that controls how the plot is drawn.

Definition at line 541 of file vtkPlot.h.

◆ SelectionPen

vtkSmartPointer<vtkPen> vtkPlot::SelectionPen
protected

This object stores the vtkPen that controls how the selected elements of the plot are drawn.

Definition at line 547 of file vtkPlot.h.

◆ SelectionBrush

vtkSmartPointer<vtkBrush> vtkPlot::SelectionBrush
protected

This object stores the vtkBrush that controls how the selected elements of the plot are drawn.

Definition at line 553 of file vtkPlot.h.

◆ Labels

vtkSmartPointer<vtkStringArray> vtkPlot::Labels
protected

Plot labels, used by legend.

Definition at line 558 of file vtkPlot.h.

◆ AutoLabels

vtkSmartPointer<vtkStringArray> vtkPlot::AutoLabels
protected

Holds Labels when they're auto-created.

Definition at line 563 of file vtkPlot.h.

◆ IndexedLabels

vtkSmartPointer<vtkStringArray> vtkPlot::IndexedLabels
protected

Holds Labels when they're auto-created.

Definition at line 568 of file vtkPlot.h.

◆ UseIndexForXSeries

bool vtkPlot::UseIndexForXSeries
protected

Use the Y array index for the X value.

If true any X column setting will be ignored, and the X values will simply be the index of the Y column.

Definition at line 574 of file vtkPlot.h.

◆ Data

vtkSmartPointer<vtkContextMapper2D> vtkPlot::Data
protected

This data member contains the data that will be plotted, it inherits from vtkAlgorithm.

Definition at line 580 of file vtkPlot.h.

◆ Selectable

bool vtkPlot::Selectable
protected

Whether plot points can be selected or not.

Definition at line 585 of file vtkPlot.h.

◆ Selection

vtkIdTypeArray* vtkPlot::Selection
protected

Selected indices for the table the plot is rendering.

Definition at line 590 of file vtkPlot.h.

◆ XAxis

vtkAxis* vtkPlot::XAxis
protected

The X axis associated with this plot.

Definition at line 595 of file vtkPlot.h.

◆ YAxis

vtkAxis* vtkPlot::YAxis
protected

The X axis associated with this plot.

Definition at line 600 of file vtkPlot.h.

◆ TooltipLabelFormat

vtkStdString vtkPlot::TooltipLabelFormat
protected

A printf-style string to build custom tooltip labels from.

See the accessor/mutator functions for full documentation.

Definition at line 606 of file vtkPlot.h.

◆ TooltipDefaultLabelFormat

vtkStdString vtkPlot::TooltipDefaultLabelFormat
protected

The default printf-style string to build custom tooltip labels from.

See the accessor/mutator functions for full documentation.

Definition at line 612 of file vtkPlot.h.

◆ TooltipNotation

int vtkPlot::TooltipNotation
protected

Definition at line 614 of file vtkPlot.h.

◆ TooltipPrecision

int vtkPlot::TooltipPrecision
protected

Definition at line 615 of file vtkPlot.h.

◆ ShiftScale

vtkRectd vtkPlot::ShiftScale
protected

The current shift in origin and scaling factor applied to the plot.

Definition at line 620 of file vtkPlot.h.

◆ LegendVisibility

bool vtkPlot::LegendVisibility
protected

Definition at line 622 of file vtkPlot.h.

◆ LegacyRecursionFlag

bool vtkPlot::LegacyRecursionFlag = false
protected

Flag used by GetNearestPoint legacy implementation to avoid infinite call.

Definition at line 629 of file vtkPlot.h.


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