VTK  9.0.20201128
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkChartXY Class Reference

Factory class for drawing XY charts. More...

#include <vtkChartXY.h>

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

Public Types

typedef vtkChart Superclass
 
- Public Types inherited from vtkChart
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...
 
vtkChartXYNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void Update () override
 Perform any updates to the item that may be necessary before rendering. More...
 
bool Paint (vtkContext2D *painter) override
 Paint event for the chart, called whenever the chart needs to be drawn. More...
 
vtkPlotAddPlot (int type) override
 Add a plot to the chart, defaults to using the name of the y column. More...
 
vtkIdType AddPlot (vtkPlot *plot) override
 Adds a plot to the chart. More...
 
bool RemovePlot (vtkIdType index) override
 Remove the plot at the specified index, returns true if successful, false if the index was invalid. More...
 
void ClearPlots () override
 Remove all plots from the chart. More...
 
vtkPlotGetPlot (vtkIdType index) override
 Get the plot at the specified index, returns null if the index is invalid. More...
 
virtual vtkIdType GetPlotIndex (vtkPlot *)
 Get the index of the specified plot, returns -1 if the plot does not belong to the chart. More...
 
vtkIdType RaisePlot (vtkPlot *plot)
 Raises the plot to the top of the plot's stack. More...
 
virtual vtkIdType StackPlotAbove (vtkPlot *plot, vtkPlot *under)
 Raises the plot above the under plot. More...
 
vtkIdType LowerPlot (vtkPlot *plot)
 Lowers the plot to the bottom of the plot's stack. More...
 
virtual vtkIdType StackPlotUnder (vtkPlot *plot, vtkPlot *above)
 Lowers the plot under the above plot. More...
 
vtkIdType GetNumberOfPlots () override
 Get the number of plots the chart contains. More...
 
int GetPlotCorner (vtkPlot *plot)
 Figure out which quadrant the plot is in. More...
 
void SetPlotCorner (vtkPlot *plot, int corner)
 Figure out which quadrant the plot is in. More...
 
vtkAxisGetAxis (int axisIndex) override
 Get the axis specified by axisIndex. More...
 
void SetAxis (int axisIndex, vtkAxis *) override
 Set the axis specified by axisIndex. More...
 
void SetShowLegend (bool visible) override
 Set whether the chart should draw a legend. More...
 
vtkChartLegendGetLegend () override
 Get the vtkChartLegend object that will be displayed by the chart. More...
 
virtual void SetTooltip (vtkTooltipItem *tooltip)
 Set the vtkTooltipItem object that will be displayed by the chart. More...
 
virtual vtkTooltipItemGetTooltip ()
 Get the vtkTooltipItem object that will be displayed by the chart. More...
 
vtkIdType GetNumberOfAxes () override
 Get the number of axes in the current chart. More...
 
void RecalculateBounds () override
 Request that the chart recalculates the range of its axes. More...
 
void SetSelectionMethod (int method) override
 Set the selection method, which controls how selections are handled by the chart. More...
 
void RemovePlotSelections ()
 Remove all the selection from Plots. More...
 
virtual void SetDrawAxesAtOrigin (bool)
 If true then the axes will be drawn at the origin (scientific style). More...
 
virtual bool GetDrawAxesAtOrigin ()
 
virtual void DrawAxesAtOriginOn ()
 
virtual void DrawAxesAtOriginOff ()
 
virtual void SetAutoAxes (bool)
 If true then the axes will be turned on and off depending upon whether any plots are in that corner. More...
 
virtual bool GetAutoAxes ()
 
virtual void AutoAxesOn ()
 
virtual void AutoAxesOff ()
 
virtual void SetHiddenAxisBorder (int)
 Border size of the axes that are hidden (vtkAxis::GetVisible()) More...
 
virtual int GetHiddenAxisBorder ()
 
virtual void SetForceAxesToBounds (bool)
 Force the axes to have their Minimum and Maximum properties inside the plot boundaries. More...
 
virtual bool GetForceAxesToBounds ()
 
virtual void ForceAxesToBoundsOn ()
 
virtual void ForceAxesToBoundsOff ()
 
virtual void SetBarWidthFraction (float)
 Set the width fraction for any bar charts drawn in this chart. More...
 
virtual float GetBarWidthFraction ()
 
virtual void SetZoomWithMouseWheel (bool)
 Set the behavior of the mouse wheel. More...
 
virtual bool GetZoomWithMouseWheel ()
 
virtual void ZoomWithMouseWheelOn ()
 
virtual void ZoomWithMouseWheelOff ()
 
virtual void SetAdjustLowerBoundForLogPlot (bool)
 Adjust the minimum of a logarithmic axis to be greater than 0, regardless of the minimum data value. More...
 
virtual bool GetAdjustLowerBoundForLogPlot ()
 
virtual void AdjustLowerBoundForLogPlotOn ()
 
virtual void AdjustLowerBoundForLogPlotOff ()
 
virtual void SetDragPointAlongX (bool)
 Set if the point can be dragged along X by the ClickAndDrag Action True by default. More...
 
virtual bool GetDragPointAlongX ()
 
virtual void DragPointAlongXOn ()
 
virtual void DragPointAlongXOff ()
 
virtual void SetDragPointAlongY (bool)
 Set if the point can be dragged along Y by the ClickAndDrag Action True by default. More...
 
virtual bool GetDragPointAlongY ()
 
virtual void DragPointAlongYOn ()
 
virtual void DragPointAlongYOff ()
 
virtual void SetTooltipInfo (const vtkContextMouseEvent &, const vtkVector2d &, vtkIdType, vtkPlot *, vtkIdType segmentIndex=-1)
 Set the information passed to the tooltip. More...
 
bool Hit (const vtkContextMouseEvent &mouse) override
 Return true if the supplied x, y coordinate is inside the item. More...
 
bool MouseEnterEvent (const vtkContextMouseEvent &mouse) override
 Mouse enter event. More...
 
bool MouseMoveEvent (const vtkContextMouseEvent &mouse) override
 Mouse move event. More...
 
bool MouseLeaveEvent (const vtkContextMouseEvent &mouse) override
 Mouse leave event. More...
 
bool MouseButtonPressEvent (const vtkContextMouseEvent &mouse) override
 Mouse button down event. More...
 
bool MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse) override
 Mouse button release event. More...
 
bool MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta) override
 Mouse wheel event, positive delta indicates forward movement of the wheel. More...
 
bool KeyPressEvent (const vtkContextKeyEvent &key) override
 Key press event. More...
 
- Public Member Functions inherited from vtkChart
vtkChartNewInstance () const
 
virtual bool RemovePlotInstance (vtkPlot *plot)
 Remove the given plot. 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 int * GetGeometry ()
 
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 int * GetPoint1 ()
 
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 int * GetPoint2 ()
 
virtual void GetPoint2 (int &, int &)
 
virtual void GetPoint2 (int[2])
 
virtual bool GetShowLegend ()
 
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 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 MouseDoubleClickEvent (const vtkContextMouseEvent &mouse)
 Mouse button double click 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 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 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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkChartXYSafeDownCast (vtkObjectBase *o)
 
static vtkChartXYNew ()
 Creates a 2D Chart object. More...
 
static void MakeSelection (vtkAnnotationLink *link, vtkIdTypeArray *selectionIds, vtkPlot *plot)
 Populate the annotation link with the supplied selectionIds array, and set the appropriate node properties for a standard row based chart selection. More...
 
static void MinusSelection (vtkIdTypeArray *selection, vtkIdTypeArray *oldSelection)
 Subtract the supplied selection from the oldSelection. More...
 
static void AddSelection (vtkIdTypeArray *selection, vtkIdTypeArray *oldSelection)
 Add the supplied selection from the oldSelection. More...
 
static void ToggleSelection (vtkIdTypeArray *selection, vtkIdTypeArray *oldSelection)
 Toggle the supplied selection from the oldSelection. More...
 
static void BuildSelection (vtkAnnotationLink *link, int selectionMode, vtkIdTypeArray *plotSelection, vtkIdTypeArray *oldSelection, vtkPlot *plot)
 Build a selection based on the supplied selectionMode using the new plotSelection and combining it with the oldSelection. More...
 
static int GetMouseSelectionMode (const vtkContextMouseEvent &mouse, int selectionMode)
 Combine the SelectionMode with any mouse modifiers to get an effective selection mode for this click event. More...
 
- Static Public Member Functions inherited from vtkChart
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 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
 
 vtkChartXY ()
 
 ~vtkChartXY () override
 
void RecalculatePlotTransforms ()
 Recalculate the necessary transforms. More...
 
void RecalculatePlotBounds ()
 Calculate the optimal zoom level such that all of the points to be plotted will fit into the plot area. More...
 
virtual bool UpdateLayout (vtkContext2D *painter)
 Update the layout of the chart, this may require the vtkContext2D in order to get font metrics etc. More...
 
virtual int GetLegendBorder (vtkContext2D *painter, int axisPosition)
 Layout for the legend if it is visible. More...
 
virtual void SetLegendPosition (const vtkRectf &rect)
 Called after the edges of the chart are decided, set the position of the legend, depends upon its alignment. More...
 
- Protected Member Functions inherited from vtkChart
 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 ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkSmartPointer< vtkChartLegendLegend
 The legend for the chart. More...
 
vtkSmartPointer< vtkTooltipItemTooltip
 The tooltip item for the chart - can be used to display extra information. More...
 
bool PlotTransformValid
 Does the plot area transform need to be recalculated? More...
 
vtkRectf MouseBox
 The box created as the mouse is dragged around the screen. More...
 
bool DrawBox
 Should the box be drawn (could be selection, zoom etc). More...
 
vtkContextPolygon SelectionPolygon
 The polygon created as the mouse is dragged around the screen when in polygonal selection mode. More...
 
bool DrawSelectionPolygon
 Should the selection polygon be drawn. More...
 
bool DrawNearestPoint
 Should we draw the location of the nearest point on the plot? More...
 
bool DrawAxesAtOrigin
 Keep the axes drawn at the origin? This will attempt to keep the axes drawn at the origin, i.e. More...
 
bool AutoAxes
 Should axes be turned on and off automatically - defaults to on. More...
 
int HiddenAxisBorder
 Size of the border when an axis is hidden. More...
 
float BarWidthFraction
 The fraction of the interval taken up along the x axis by any bars that are drawn on the chart. More...
 
bool ForceAxesToBounds
 Property to force the axes to have their Minimum and Maximum properties inside the plot boundaries. More...
 
bool ZoomWithMouseWheel
 Property to enable zooming the chart with the mouse wheel. More...
 
bool AdjustLowerBoundForLogPlot
 Property to adjust the minimum of a logarithmic axis to be greater than 0, regardless of the minimum data value. More...
 
bool DragPointAlongX
 Properties to enable the drag of a point for the ClickAndDrag Action. More...
 
bool DragPointAlongY
 
- Protected Attributes inherited from vtkChart
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
 

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 XY charts.

This class implements an XY chart.

See also
vtkBarChartActor

Definition at line 45 of file vtkChartXY.h.

Member Typedef Documentation

◆ Superclass

Definition at line 48 of file vtkChartXY.h.

Constructor & Destructor Documentation

◆ vtkChartXY()

vtkChartXY::vtkChartXY ( )
protected

◆ ~vtkChartXY()

vtkChartXY::~vtkChartXY ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkChartXY::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 vtkChart.

Reimplemented in vtkChartHistogram2D.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkChartXY::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkChart.

Reimplemented in vtkChartHistogram2D.

◆ NewInstance()

vtkChartXY* vtkChartXY::NewInstance ( ) const

◆ PrintSelf()

void vtkChartXY::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 vtkChart.

◆ New()

static vtkChartXY* vtkChartXY::New ( )
static

Creates a 2D Chart object.

◆ Update()

void vtkChartXY::Update ( )
overridevirtual

Perform any updates to the item that may be necessary before rendering.

The scene should take care of calling this on all items before their Paint function is invoked.

Reimplemented from vtkAbstractContextItem.

◆ Paint()

bool vtkChartXY::Paint ( vtkContext2D painter)
overridevirtual

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

Implements vtkChart.

◆ AddPlot() [1/2]

vtkPlot* vtkChartXY::AddPlot ( int  type)
overridevirtual

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

Reimplemented from vtkChart.

◆ AddPlot() [2/2]

vtkIdType vtkChartXY::AddPlot ( vtkPlot plot)
overridevirtual

Adds a plot to the chart.

Reimplemented from vtkChart.

◆ RemovePlot()

bool vtkChartXY::RemovePlot ( vtkIdType  index)
overridevirtual

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

Reimplemented from vtkChart.

◆ ClearPlots()

void vtkChartXY::ClearPlots ( )
overridevirtual

Remove all plots from the chart.

Reimplemented from vtkChart.

◆ GetPlot()

vtkPlot* vtkChartXY::GetPlot ( vtkIdType  index)
overridevirtual

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

Reimplemented from vtkChart.

◆ GetPlotIndex()

virtual vtkIdType vtkChartXY::GetPlotIndex ( vtkPlot )
virtual

Get the index of the specified plot, returns -1 if the plot does not belong to the chart.

◆ RaisePlot()

vtkIdType vtkChartXY::RaisePlot ( vtkPlot plot)

Raises the plot to the top of the plot's stack.

Returns
The new index of the plot
See also
StackPlotAbove(), LowerPlot(), StackPlotUnder()

◆ StackPlotAbove()

virtual vtkIdType vtkChartXY::StackPlotAbove ( vtkPlot plot,
vtkPlot under 
)
virtual

Raises the plot above the under plot.

If under is null, the plot is raised to the top of the plot's stack.

Returns
The new index of the plot
See also
RaisePlot(), LowerPlot(), StackPlotUnder()

◆ LowerPlot()

vtkIdType vtkChartXY::LowerPlot ( vtkPlot plot)

Lowers the plot to the bottom of the plot's stack.

Returns
The new index of the plot
See also
StackPlotUnder(), RaisePlot(), StackPlotAbove()

◆ StackPlotUnder()

virtual vtkIdType vtkChartXY::StackPlotUnder ( vtkPlot plot,
vtkPlot above 
)
virtual

Lowers the plot under the above plot.

If above is null, the plot is lowered to the bottom of the plot's stack

Returns
The new index of the plot
See also
StackPlotUnder(), RaisePlot(), StackPlotAbove()

◆ GetNumberOfPlots()

vtkIdType vtkChartXY::GetNumberOfPlots ( )
overridevirtual

Get the number of plots the chart contains.

Reimplemented from vtkChart.

◆ GetPlotCorner()

int vtkChartXY::GetPlotCorner ( vtkPlot plot)

Figure out which quadrant the plot is in.

◆ SetPlotCorner()

void vtkChartXY::SetPlotCorner ( vtkPlot plot,
int  corner 
)

Figure out which quadrant the plot is in.

◆ GetAxis()

vtkAxis* vtkChartXY::GetAxis ( int  axisIndex)
overridevirtual

Get the axis specified by axisIndex.

This is specified with the vtkAxis position enum, valid values are vtkAxis::LEFT, vtkAxis::BOTTOM, vtkAxis::RIGHT and vtkAxis::TOP.

Reimplemented from vtkChart.

◆ SetAxis()

void vtkChartXY::SetAxis ( int  axisIndex,
vtkAxis  
)
overridevirtual

Set the axis specified by axisIndex.

This is specified with the vtkAxis position enum, valid values are vtkAxis::LEFT, vtkAxis::BOTTOM, vtkAxis::RIGHT and vtkAxis::TOP.

Reimplemented from vtkChart.

◆ SetShowLegend()

void vtkChartXY::SetShowLegend ( bool  visible)
overridevirtual

Set whether the chart should draw a legend.

Reimplemented from vtkChart.

◆ GetLegend()

vtkChartLegend* vtkChartXY::GetLegend ( )
overridevirtual

Get the vtkChartLegend object that will be displayed by the chart.

Reimplemented from vtkChart.

◆ SetTooltip()

virtual void vtkChartXY::SetTooltip ( vtkTooltipItem tooltip)
virtual

Set the vtkTooltipItem object that will be displayed by the chart.

◆ GetTooltip()

virtual vtkTooltipItem* vtkChartXY::GetTooltip ( )
virtual

Get the vtkTooltipItem object that will be displayed by the chart.

◆ GetNumberOfAxes()

vtkIdType vtkChartXY::GetNumberOfAxes ( )
overridevirtual

Get the number of axes in the current chart.

Reimplemented from vtkChart.

◆ RecalculateBounds()

void vtkChartXY::RecalculateBounds ( )
overridevirtual

Request that the chart recalculates the range of its axes.

Especially useful in applications after the parameters of plots have been modified.

Reimplemented from vtkChart.

◆ SetSelectionMethod()

void vtkChartXY::SetSelectionMethod ( int  method)
overridevirtual

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.

Reimplemented from vtkChart.

◆ RemovePlotSelections()

void vtkChartXY::RemovePlotSelections ( )

Remove all the selection from Plots.

◆ SetDrawAxesAtOrigin()

virtual void vtkChartXY::SetDrawAxesAtOrigin ( bool  )
virtual

If true then the axes will be drawn at the origin (scientific style).

◆ GetDrawAxesAtOrigin()

virtual bool vtkChartXY::GetDrawAxesAtOrigin ( )
virtual

◆ DrawAxesAtOriginOn()

virtual void vtkChartXY::DrawAxesAtOriginOn ( )
virtual

◆ DrawAxesAtOriginOff()

virtual void vtkChartXY::DrawAxesAtOriginOff ( )
virtual

◆ SetAutoAxes()

virtual void vtkChartXY::SetAutoAxes ( bool  )
virtual

If true then the axes will be turned on and off depending upon whether any plots are in that corner.

Defaults to true.

◆ GetAutoAxes()

virtual bool vtkChartXY::GetAutoAxes ( )
virtual

◆ AutoAxesOn()

virtual void vtkChartXY::AutoAxesOn ( )
virtual

◆ AutoAxesOff()

virtual void vtkChartXY::AutoAxesOff ( )
virtual

◆ SetHiddenAxisBorder()

virtual void vtkChartXY::SetHiddenAxisBorder ( int  )
virtual

Border size of the axes that are hidden (vtkAxis::GetVisible())

◆ GetHiddenAxisBorder()

virtual int vtkChartXY::GetHiddenAxisBorder ( )
virtual

◆ SetForceAxesToBounds()

virtual void vtkChartXY::SetForceAxesToBounds ( bool  )
virtual

Force the axes to have their Minimum and Maximum properties inside the plot boundaries.

It constrains pan and zoom interaction. False by default.

◆ GetForceAxesToBounds()

virtual bool vtkChartXY::GetForceAxesToBounds ( )
virtual

◆ ForceAxesToBoundsOn()

virtual void vtkChartXY::ForceAxesToBoundsOn ( )
virtual

◆ ForceAxesToBoundsOff()

virtual void vtkChartXY::ForceAxesToBoundsOff ( )
virtual

◆ SetBarWidthFraction()

virtual void vtkChartXY::SetBarWidthFraction ( float  )
virtual

Set the width fraction for any bar charts drawn in this chart.

It is assumed that all bar plots will use the same array for the X axis, and that this array is regularly spaced. The delta between the first two x values is used to calculated the width of the bars, and subdivided between each bar. The default value is 0.8, 1.0 would lead to bars that touch.

◆ GetBarWidthFraction()

virtual float vtkChartXY::GetBarWidthFraction ( )
virtual

◆ SetZoomWithMouseWheel()

virtual void vtkChartXY::SetZoomWithMouseWheel ( bool  )
virtual

Set the behavior of the mouse wheel.

If true, the mouse wheel zooms in/out on the chart. Otherwise, unless MouseWheelEvent is overridden by a subclass the mouse wheel does nothing. The default value is true.

◆ GetZoomWithMouseWheel()

virtual bool vtkChartXY::GetZoomWithMouseWheel ( )
virtual

◆ ZoomWithMouseWheelOn()

virtual void vtkChartXY::ZoomWithMouseWheelOn ( )
virtual

◆ ZoomWithMouseWheelOff()

virtual void vtkChartXY::ZoomWithMouseWheelOff ( )
virtual

◆ SetAdjustLowerBoundForLogPlot()

virtual void vtkChartXY::SetAdjustLowerBoundForLogPlot ( bool  )
virtual

Adjust the minimum of a logarithmic axis to be greater than 0, regardless of the minimum data value.

False by default.

◆ GetAdjustLowerBoundForLogPlot()

virtual bool vtkChartXY::GetAdjustLowerBoundForLogPlot ( )
virtual

◆ AdjustLowerBoundForLogPlotOn()

virtual void vtkChartXY::AdjustLowerBoundForLogPlotOn ( )
virtual

◆ AdjustLowerBoundForLogPlotOff()

virtual void vtkChartXY::AdjustLowerBoundForLogPlotOff ( )
virtual

◆ SetDragPointAlongX()

virtual void vtkChartXY::SetDragPointAlongX ( bool  )
virtual

Set if the point can be dragged along X by the ClickAndDrag Action True by default.

◆ GetDragPointAlongX()

virtual bool vtkChartXY::GetDragPointAlongX ( )
virtual

◆ DragPointAlongXOn()

virtual void vtkChartXY::DragPointAlongXOn ( )
virtual

◆ DragPointAlongXOff()

virtual void vtkChartXY::DragPointAlongXOff ( )
virtual

◆ SetDragPointAlongY()

virtual void vtkChartXY::SetDragPointAlongY ( bool  )
virtual

Set if the point can be dragged along Y by the ClickAndDrag Action True by default.

◆ GetDragPointAlongY()

virtual bool vtkChartXY::GetDragPointAlongY ( )
virtual

◆ DragPointAlongYOn()

virtual void vtkChartXY::DragPointAlongYOn ( )
virtual

◆ DragPointAlongYOff()

virtual void vtkChartXY::DragPointAlongYOff ( )
virtual

◆ SetTooltipInfo()

virtual void vtkChartXY::SetTooltipInfo ( const vtkContextMouseEvent ,
const vtkVector2d ,
vtkIdType  ,
vtkPlot ,
vtkIdType  segmentIndex = -1 
)
virtual

Set the information passed to the tooltip.

◆ Hit()

bool vtkChartXY::Hit ( const vtkContextMouseEvent mouse)
overridevirtual

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

Reimplemented from vtkAbstractContextItem.

◆ MouseEnterEvent()

bool vtkChartXY::MouseEnterEvent ( const vtkContextMouseEvent mouse)
overridevirtual

Mouse enter event.

Reimplemented from vtkAbstractContextItem.

◆ MouseMoveEvent()

bool vtkChartXY::MouseMoveEvent ( const vtkContextMouseEvent mouse)
overridevirtual

Mouse move event.

Reimplemented from vtkAbstractContextItem.

◆ MouseLeaveEvent()

bool vtkChartXY::MouseLeaveEvent ( const vtkContextMouseEvent mouse)
overridevirtual

Mouse leave event.

Reimplemented from vtkAbstractContextItem.

◆ MouseButtonPressEvent()

bool vtkChartXY::MouseButtonPressEvent ( const vtkContextMouseEvent mouse)
overridevirtual

Mouse button down event.

Reimplemented from vtkAbstractContextItem.

◆ MouseButtonReleaseEvent()

bool vtkChartXY::MouseButtonReleaseEvent ( const vtkContextMouseEvent mouse)
overridevirtual

Mouse button release event.

Reimplemented from vtkAbstractContextItem.

◆ MouseWheelEvent()

bool vtkChartXY::MouseWheelEvent ( const vtkContextMouseEvent mouse,
int  delta 
)
overridevirtual

Mouse wheel event, positive delta indicates forward movement of the wheel.

Reimplemented from vtkAbstractContextItem.

◆ KeyPressEvent()

bool vtkChartXY::KeyPressEvent ( const vtkContextKeyEvent key)
overridevirtual

Key press event.

Reimplemented from vtkAbstractContextItem.

◆ MakeSelection()

static void vtkChartXY::MakeSelection ( vtkAnnotationLink link,
vtkIdTypeArray selectionIds,
vtkPlot plot 
)
static

Populate the annotation link with the supplied selectionIds array, and set the appropriate node properties for a standard row based chart selection.

◆ MinusSelection()

static void vtkChartXY::MinusSelection ( vtkIdTypeArray selection,
vtkIdTypeArray oldSelection 
)
static

Subtract the supplied selection from the oldSelection.

◆ AddSelection()

static void vtkChartXY::AddSelection ( vtkIdTypeArray selection,
vtkIdTypeArray oldSelection 
)
static

Add the supplied selection from the oldSelection.

◆ ToggleSelection()

static void vtkChartXY::ToggleSelection ( vtkIdTypeArray selection,
vtkIdTypeArray oldSelection 
)
static

Toggle the supplied selection from the oldSelection.

◆ BuildSelection()

static void vtkChartXY::BuildSelection ( vtkAnnotationLink link,
int  selectionMode,
vtkIdTypeArray plotSelection,
vtkIdTypeArray oldSelection,
vtkPlot plot 
)
static

Build a selection based on the supplied selectionMode using the new plotSelection and combining it with the oldSelection.

If link is not nullptr then the resulting selection will be set on the link.

◆ GetMouseSelectionMode()

static int vtkChartXY::GetMouseSelectionMode ( const vtkContextMouseEvent mouse,
int  selectionMode 
)
static

Combine the SelectionMode with any mouse modifiers to get an effective selection mode for this click event.

◆ RecalculatePlotTransforms()

void vtkChartXY::RecalculatePlotTransforms ( )
protected

Recalculate the necessary transforms.

◆ RecalculatePlotBounds()

void vtkChartXY::RecalculatePlotBounds ( )
protected

Calculate the optimal zoom level such that all of the points to be plotted will fit into the plot area.

◆ UpdateLayout()

virtual bool vtkChartXY::UpdateLayout ( vtkContext2D painter)
protectedvirtual

Update the layout of the chart, this may require the vtkContext2D in order to get font metrics etc.

Initially this was added to resize the charts according in response to the size of the axes.

Reimplemented in vtkChartHistogram2D.

◆ GetLegendBorder()

virtual int vtkChartXY::GetLegendBorder ( vtkContext2D painter,
int  axisPosition 
)
protectedvirtual

Layout for the legend if it is visible.

This is run after the axes layout and will adjust the borders to account for the legend position.

Returns
The required space in the specified border.

◆ SetLegendPosition()

virtual void vtkChartXY::SetLegendPosition ( const vtkRectf rect)
protectedvirtual

Called after the edges of the chart are decided, set the position of the legend, depends upon its alignment.

Member Data Documentation

◆ Legend

vtkSmartPointer<vtkChartLegend> vtkChartXY::Legend
protected

The legend for the chart.

Definition at line 418 of file vtkChartXY.h.

◆ Tooltip

vtkSmartPointer<vtkTooltipItem> vtkChartXY::Tooltip
protected

The tooltip item for the chart - can be used to display extra information.

Definition at line 423 of file vtkChartXY.h.

◆ PlotTransformValid

bool vtkChartXY::PlotTransformValid
protected

Does the plot area transform need to be recalculated?

Definition at line 428 of file vtkChartXY.h.

◆ MouseBox

vtkRectf vtkChartXY::MouseBox
protected

The box created as the mouse is dragged around the screen.

Definition at line 433 of file vtkChartXY.h.

◆ DrawBox

bool vtkChartXY::DrawBox
protected

Should the box be drawn (could be selection, zoom etc).

Definition at line 438 of file vtkChartXY.h.

◆ SelectionPolygon

vtkContextPolygon vtkChartXY::SelectionPolygon
protected

The polygon created as the mouse is dragged around the screen when in polygonal selection mode.

Definition at line 444 of file vtkChartXY.h.

◆ DrawSelectionPolygon

bool vtkChartXY::DrawSelectionPolygon
protected

Should the selection polygon be drawn.

Definition at line 449 of file vtkChartXY.h.

◆ DrawNearestPoint

bool vtkChartXY::DrawNearestPoint
protected

Should we draw the location of the nearest point on the plot?

Definition at line 454 of file vtkChartXY.h.

◆ DrawAxesAtOrigin

bool vtkChartXY::DrawAxesAtOrigin
protected

Keep the axes drawn at the origin? This will attempt to keep the axes drawn at the origin, i.e.

0.0, 0.0 for the chart. This is often the preferred way of drawing scientific/mathematical charts.

Definition at line 461 of file vtkChartXY.h.

◆ AutoAxes

bool vtkChartXY::AutoAxes
protected

Should axes be turned on and off automatically - defaults to on.

Definition at line 466 of file vtkChartXY.h.

◆ HiddenAxisBorder

int vtkChartXY::HiddenAxisBorder
protected

Size of the border when an axis is hidden.

Definition at line 471 of file vtkChartXY.h.

◆ BarWidthFraction

float vtkChartXY::BarWidthFraction
protected

The fraction of the interval taken up along the x axis by any bars that are drawn on the chart.

Definition at line 477 of file vtkChartXY.h.

◆ ForceAxesToBounds

bool vtkChartXY::ForceAxesToBounds
protected

Property to force the axes to have their Minimum and Maximum properties inside the plot boundaries.

It constrains pan and zoom interaction. False by default.

Definition at line 484 of file vtkChartXY.h.

◆ ZoomWithMouseWheel

bool vtkChartXY::ZoomWithMouseWheel
protected

Property to enable zooming the chart with the mouse wheel.

True by default.

Definition at line 490 of file vtkChartXY.h.

◆ AdjustLowerBoundForLogPlot

bool vtkChartXY::AdjustLowerBoundForLogPlot
protected

Property to adjust the minimum of a logarithmic axis to be greater than 0, regardless of the minimum data value.

Definition at line 496 of file vtkChartXY.h.

◆ DragPointAlongX

bool vtkChartXY::DragPointAlongX
protected

Properties to enable the drag of a point for the ClickAndDrag Action.

Definition at line 501 of file vtkChartXY.h.

◆ DragPointAlongY

bool vtkChartXY::DragPointAlongY
protected

Definition at line 502 of file vtkChartXY.h.


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