Factory class for drawing XY charts. More...

#include <vtkChartXY.h>

Inheritance diagram for vtkChartXY:

Collaboration diagram for vtkChartXY:

Public Types
typedef vtkChart	Superclass

typedef std::map< unsigned int, vtkSmartPointer< vtkIdTypeArray > >	MapIndexToIds

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 , ACTION_TYPES_COUNT }
	Enum of valid chart action types. More...

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

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

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

typedef vtkContextItem	Superclass

Public Types inherited from vtkContextItem
typedef vtkAbstractContextItem	Superclass

Public Types inherited from vtkAbstractContextItem
typedef vtkObject	Superclass

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

vtkChartXY *	NewInstance () const

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

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

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

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

virtual vtkPlot *	AddPlot (int type, unsigned int blockIndex)
	Adds a plot to the chart holding data specific to a block in a vtkMultiBlockDataSet.

vtkIdType	AddPlot (vtkPlot *plot) override
	Adds a plot to the chart.

virtual vtkIdType	AddPlot (vtkPlot *plot, unsigned int blockIndex)
	Adds a plot to the chart holding data specific to a block in a vtkMultiBlockDataSet.

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

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

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

virtual vtkIdType	GetPlotIndex (vtkPlot *)
	Get the index of the specified plot, returns -1 if the plot does not belong to the chart.

vtkIdType	RaisePlot (vtkPlot *plot)
	Raises the plot to the top of the plot's stack.

virtual vtkIdType	StackPlotAbove (vtkPlot plot, vtkPlot under)
	Raises the plot above the under plot.

vtkIdType	LowerPlot (vtkPlot *plot)
	Lowers the plot to the bottom of the plot's stack.

virtual vtkIdType	StackPlotUnder (vtkPlot plot, vtkPlot above)
	Lowers the plot under the above plot.

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

int	GetPlotCorner (vtkPlot *plot)
	Figure out which quadrant the plot is in.

void	SetPlotCorner (vtkPlot *plot, int corner)
	Figure out which quadrant the plot is in.

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

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

void	SetShowLegend (bool visible) override
	Set whether the chart should draw a legend.

vtkChartLegend *	GetLegend () override
	Get the vtkChartLegend object that will be displayed by the chart.

virtual void	SetTooltip (vtkTooltipItem *tooltip)
	Set the vtkTooltipItem object that will be displayed by the chart.

virtual vtkTooltipItem *	GetTooltip ()
	Get the vtkTooltipItem object that will be displayed by the chart.

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

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

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

void	RemovePlotSelections ()
	Remove all the selection from Plots.

virtual void	SetTooltipInfo (const vtkContextMouseEvent &, const vtkVector2d &, vtkIdType, vtkPlot *, vtkIdType segmentIndex=-1)
	Set the information passed to the tooltip.

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

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

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

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

bool	MouseButtonPressEvent (const vtkContextMouseEvent &mouse) override
	Mouse button down event.

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

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

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

const std::vector< vtkContextTransform * > &	GetTransforms () const
	Get the vector of vtkContextTransform.


virtual void	SetDrawAxesAtOrigin (bool)
	If true then the axes will be drawn at the origin (scientific style).

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

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

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


virtual void	SetAutoAxes (bool)
	If true then the axes will be turned on and off depending upon whether any plots are in that corner.

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

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

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


virtual void	SetHiddenAxisBorder (int)
	Border size of the axes that are hidden (vtkAxis::GetVisible())

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


virtual void	SetForceAxesToBounds (bool)
	Force the axes to have their Minimum and Maximum properties inside the plot boundaries.

virtual bool	GetForceAxesToBounds ()
	Force the axes to have their Minimum and Maximum properties inside the plot boundaries.

virtual void	ForceAxesToBoundsOn ()
	Force the axes to have their Minimum and Maximum properties inside the plot boundaries.

virtual void	ForceAxesToBoundsOff ()
	Force the axes to have their Minimum and Maximum properties inside the plot boundaries.


virtual void	SetIgnoreNanInBounds (bool)
	Ignore NaN in RecalculateBounds().

virtual bool	GetIgnoreNanInBounds ()
	Ignore NaN in RecalculateBounds().

virtual void	IgnoreNanInBoundsOn ()
	Ignore NaN in RecalculateBounds().

virtual void	IgnoreNanInBoundsOff ()
	Ignore NaN in RecalculateBounds().


virtual void	SetBarWidthFraction (float)
	Set the width fraction for any bar charts drawn in this chart.

virtual float	GetBarWidthFraction ()
	Set the width fraction for any bar charts drawn in this chart.


virtual void	SetZoomWithMouseWheel (bool)
	Set the behavior of the mouse wheel.

virtual bool	GetZoomWithMouseWheel ()
	Set the behavior of the mouse wheel.

virtual void	ZoomWithMouseWheelOn ()
	Set the behavior of the mouse wheel.

virtual void	ZoomWithMouseWheelOff ()
	Set the behavior of the mouse wheel.


void	SetAxisZoom (int index, bool v)
	Set the behavior of the mouse wheel for individual axes.

bool	GetAxisZoom (int index)
	Set the behavior of the mouse wheel for individual axes.


virtual void	SetAdjustLowerBoundForLogPlot (bool)
	Adjust the minimum of a logarithmic axis to be greater than 0, regardless of the minimum data value.

virtual bool	GetAdjustLowerBoundForLogPlot ()
	Adjust the minimum of a logarithmic axis to be greater than 0, regardless of the minimum data value.

virtual void	AdjustLowerBoundForLogPlotOn ()
	Adjust the minimum of a logarithmic axis to be greater than 0, regardless of the minimum data value.

virtual void	AdjustLowerBoundForLogPlotOff ()
	Adjust the minimum of a logarithmic axis to be greater than 0, regardless of the minimum data value.


virtual void	SetDragPointAlongX (bool)
	Set if the point can be dragged along X by the ClickAndDrag Action True by default.

virtual bool	GetDragPointAlongX ()
	Set if the point can be dragged along X by the ClickAndDrag Action True by default.

virtual void	DragPointAlongXOn ()
	Set if the point can be dragged along X by the ClickAndDrag Action True by default.

virtual void	DragPointAlongXOff ()
	Set if the point can be dragged along X by the ClickAndDrag Action True by default.


virtual void	SetDragPointAlongY (bool)
	Set if the point can be dragged along Y by the ClickAndDrag Action True by default.

virtual bool	GetDragPointAlongY ()
	Set if the point can be dragged along Y by the ClickAndDrag Action True by default.

virtual void	DragPointAlongYOn ()
	Set if the point can be dragged along Y by the ClickAndDrag Action True by default.

virtual void	DragPointAlongYOff ()
	Set if the point can be dragged along Y by the ClickAndDrag Action True by default.

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

vtkChart *	NewInstance () const

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

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

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

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

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

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

bool	RemovePlot (vtkPlot *plot)

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

void	RemoveAllPlots ()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

vtkContextItem *	NewInstance () const

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

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

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

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

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

vtkAbstractContextItem *	NewInstance () const

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

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

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

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

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

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

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

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

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

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

vtkIdType	GetNumberOfItems ()
	Get the number of child items.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

vtkAbstractContextItem *	GetParent ()
	Get the parent item.

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

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

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

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

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

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

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

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

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

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

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

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

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

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

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

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual void	Delete ()
	Delete a VTK object.

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

void	InitializeObjectBase ()

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

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

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

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

void	SetReferenceCount (int)
	Sets the reference count.

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

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

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

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

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

static vtkChartXY *	SafeDownCast (vtkObjectBase *o)

static vtkChartXY *	New ()
	Creates a 2D Chart object.

static void	MakeSelection (vtkAnnotationLink *link, const MapIndexToIds &selection)
	Populate the selection node in the annotation link coressponding to the give node with the supplied selectionIds array for a standard row based selections.

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 plot based chart selection.

static void	MinusSelection (vtkIdTypeArray selection, vtkIdTypeArray oldSelection)
	Subtract the supplied selection from the oldSelection.

static void	AddSelection (vtkIdTypeArray selection, vtkIdTypeArray oldSelection)
	Add the supplied selection from the oldSelection.

static void	ToggleSelection (vtkIdTypeArray selection, vtkIdTypeArray oldSelection)
	Toggle the supplied selection from the oldSelection.

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.

static void	BuildSelection (int selectionMode, MapIndexToIds &selection, const MapIndexToIds &oldSelection)
	Build a selection based on the supplied selectionMode using the new plotSelection and combining it with the oldSelection.

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.

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

static vtkChart *	SafeDownCast (vtkObjectBase *o)

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

static vtkContextItem *	SafeDownCast (vtkObjectBase *o)

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

static vtkAbstractContextItem *	SafeDownCast (vtkObjectBase *o)

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

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

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

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

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

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

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

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

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

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

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

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkChartXY ()

	~vtkChartXY () override

void	RecalculatePlotTransforms ()
	Recalculate the necessary transforms.

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

virtual bool	UpdateLayout (vtkContext2D *painter)
	Update the layout of the chart, this may require the vtkContext2D in order to get font metrics etc.

virtual int	GetLegendBorder (vtkContext2D *painter, int axisPosition)
	Layout for the legend if it is visible.

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.

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

	vtkChart ()

	~vtkChart () override

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

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

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

void	AxisRangeForwarderCallback (vtkObject , unsigned long, void )

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

	vtkContextItem ()=default

	~vtkContextItem () override

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

	vtkAbstractContextItem ()

	~vtkAbstractContextItem () override

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

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

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

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

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkSmartPointer< vtkChartLegend >	Legend
	The legend for the chart.

vtkSmartPointer< vtkTooltipItem >	Tooltip
	The tooltip item for the chart - can be used to display extra information.

bool	PlotTransformValid
	Does the plot area transform need to be recalculated?

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

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

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

bool	DrawSelectionPolygon
	Should the selection polygon be drawn.

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

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

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

int	HiddenAxisBorder
	Size of the border when an axis is hidden.

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

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

bool	IgnoreNanInBounds
	Property to ignore NaN in RecalculateBounds().

bool	ZoomWithMouseWheel
	Property to enable zooming the chart with the mouse wheel.

bool	AxisZoom [4]
	Property to enable zooming of individual axes with the mouse wheel.

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

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

bool	DragPointAlongY

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

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

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

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

int	Borders [4]
	The borders around the chart.

bool	ShowLegend
	Display the legend?

vtkStdString	Title
	The title of the chart.

vtkTextProperty *	TitleProperties
	The text properties associated with the chart.

vtkRectf	Size

int	LayoutStrategy

bool	RenderEmpty

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

int	SelectionMode

int	SelectionMethod

MouseActions	Actions

MouseClickActions	ActionsClick

Protected Attributes inherited from vtkContextItem
double	Opacity = 1.0

vtkContextTransform *	Transform = nullptr

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

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

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

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

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

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

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

vtkWeakPointerBase **	WeakPointers

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

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

Factory class for drawing XY charts.

This class implements an XY chart.

See also: vtkBarChartActor

Examples:: vtkChartXY (Examples)

Online Examples:

KDTreeTimingDemo

ModifiedBSPTreeTimingDemo

Tests:: vtkChartXY (Tests)

Definition at line 157 of file vtkChartXY.h.

Member Typedef Documentation

◆ Superclass

typedef vtkChart vtkChartXY::Superclass

Definition at line 160 of file vtkChartXY.h.

◆ MapIndexToIds

typedef std::map<unsigned int, vtkSmartPointer<vtkIdTypeArray> > vtkChartXY::MapIndexToIds

Definition at line 489 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/4]

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/4]

virtual vtkPlot * vtkChartXY::AddPlot	(	int	type,
		unsigned int	blockIndex
	)

virtual

Adds a plot to the chart holding data specific to a block in a vtkMultiBlockDataSet.

◆ AddPlot() [3/4]

vtkIdType vtkChartXY::AddPlot ( vtkPlot * plot )

overridevirtual

Adds a plot to the chart.

Reimplemented from vtkChart.

◆ AddPlot() [4/4]

virtual vtkIdType vtkChartXY::AddPlot	(	vtkPlot *	plot,
		unsigned int	blockIndex
	)

virtual

Adds a plot to the chart holding data specific to a block in a vtkMultiBlockDataSet.

◆ 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

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

◆ DrawAxesAtOriginOn()

virtual void vtkChartXY::DrawAxesAtOriginOn ( )

virtual

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

◆ DrawAxesAtOriginOff()

virtual void vtkChartXY::DrawAxesAtOriginOff ( )

virtual

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

◆ 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

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

Defaults to true.

◆ AutoAxesOn()

virtual void vtkChartXY::AutoAxesOn ( )

virtual

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

Defaults to true.

◆ AutoAxesOff()

virtual void vtkChartXY::AutoAxesOff ( )

virtual

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

Defaults to true.

◆ SetHiddenAxisBorder()

virtual void vtkChartXY::SetHiddenAxisBorder ( int )

virtual

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

◆ GetHiddenAxisBorder()

virtual int vtkChartXY::GetHiddenAxisBorder ( )

virtual

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

◆ 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

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

It constrains pan and zoom interaction. False by default.

◆ ForceAxesToBoundsOn()

virtual void vtkChartXY::ForceAxesToBoundsOn ( )

virtual

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

It constrains pan and zoom interaction. False by default.

◆ ForceAxesToBoundsOff()

virtual void vtkChartXY::ForceAxesToBoundsOff ( )

virtual

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

It constrains pan and zoom interaction. False by default.

◆ SetIgnoreNanInBounds()

virtual void vtkChartXY::SetIgnoreNanInBounds ( bool )

virtual

Ignore NaN in RecalculateBounds().

Prevents the final bounds to contain NaN if one of the plots contains NaN in its bounds. False by default.

◆ GetIgnoreNanInBounds()

virtual bool vtkChartXY::GetIgnoreNanInBounds ( )

virtual

Ignore NaN in RecalculateBounds().

Prevents the final bounds to contain NaN if one of the plots contains NaN in its bounds. False by default.

◆ IgnoreNanInBoundsOn()

virtual void vtkChartXY::IgnoreNanInBoundsOn ( )

virtual

Ignore NaN in RecalculateBounds().

Prevents the final bounds to contain NaN if one of the plots contains NaN in its bounds. False by default.

◆ IgnoreNanInBoundsOff()

virtual void vtkChartXY::IgnoreNanInBoundsOff ( )

virtual

Ignore NaN in RecalculateBounds().

Prevents the final bounds to contain NaN if one of the plots contains NaN in its bounds. False by default.

◆ 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

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.

◆ 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

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.

◆ ZoomWithMouseWheelOn()

virtual void vtkChartXY::ZoomWithMouseWheelOn ( )

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.

◆ ZoomWithMouseWheelOff()

virtual void vtkChartXY::ZoomWithMouseWheelOff ( )

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.

◆ SetAxisZoom()

void vtkChartXY::SetAxisZoom	(	int	index,
		bool	v
	)

Set the behavior of the mouse wheel for individual axes.

ZoomWithMouseWheel must be enabled to allow zooming; individual axes can be set to ignore zoom. The default value for all axes is true.

◆ GetAxisZoom()

bool vtkChartXY::GetAxisZoom ( int index )

Set the behavior of the mouse wheel for individual axes.

ZoomWithMouseWheel must be enabled to allow zooming; individual axes can be set to ignore zoom. The default value for all axes is true.

◆ 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

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

False by default.

◆ AdjustLowerBoundForLogPlotOn()

virtual void vtkChartXY::AdjustLowerBoundForLogPlotOn ( )

virtual

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

False by default.

◆ AdjustLowerBoundForLogPlotOff()

virtual void vtkChartXY::AdjustLowerBoundForLogPlotOff ( )

virtual

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

False by default.

◆ 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

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

◆ DragPointAlongXOn()

virtual void vtkChartXY::DragPointAlongXOn ( )

virtual

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

◆ DragPointAlongXOff()

virtual void vtkChartXY::DragPointAlongXOff ( )

virtual

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

◆ 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

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

◆ DragPointAlongYOn()

virtual void vtkChartXY::DragPointAlongYOn ( )

virtual

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

◆ DragPointAlongYOff()

virtual void vtkChartXY::DragPointAlongYOff ( )

virtual

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

◆ 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() [1/2]

static void vtkChartXY::MakeSelection	(	vtkAnnotationLink *	link,
		const MapIndexToIds &	selection
	)

static

Populate the selection node in the annotation link coressponding to the give node with the supplied selectionIds array for a standard row based selections.

◆ GetTransforms()

const std::vector< vtkContextTransform * > & vtkChartXY::GetTransforms ( ) const

Get the vector of vtkContextTransform.

◆ MakeSelection() [2/2]

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 plot 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() [1/2]

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. This is used in the plot or the column based selection.

◆ BuildSelection() [2/2]

static void vtkChartXY::BuildSelection	(	int	selectionMode,
		MapIndexToIds &	selection,
		const MapIndexToIds &	oldSelection
	)

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. This is used in the standard row based selection, and supports multi-block selection.

◆ 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 585 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 590 of file vtkChartXY.h.

◆ PlotTransformValid

bool vtkChartXY::PlotTransformValid

protected

Does the plot area transform need to be recalculated?

Definition at line 595 of file vtkChartXY.h.

◆ MouseBox

vtkRectf vtkChartXY::MouseBox

protected

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

Definition at line 600 of file vtkChartXY.h.

◆ DrawBox

bool vtkChartXY::DrawBox

protected

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

Definition at line 605 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 611 of file vtkChartXY.h.

◆ DrawSelectionPolygon

bool vtkChartXY::DrawSelectionPolygon

protected

Should the selection polygon be drawn.

Definition at line 616 of file vtkChartXY.h.

◆ DrawNearestPoint

bool vtkChartXY::DrawNearestPoint

protected

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

Definition at line 621 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 628 of file vtkChartXY.h.

◆ AutoAxes

bool vtkChartXY::AutoAxes

protected

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

Definition at line 633 of file vtkChartXY.h.

◆ HiddenAxisBorder

int vtkChartXY::HiddenAxisBorder

protected

Size of the border when an axis is hidden.

Definition at line 638 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 644 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 651 of file vtkChartXY.h.

◆ IgnoreNanInBounds

bool vtkChartXY::IgnoreNanInBounds

protected

Property to ignore NaN in RecalculateBounds().

Prevents the final bounds to contain NaN if one of the plots contains NaN in its bounds. False by default.

Definition at line 659 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 665 of file vtkChartXY.h.

◆ AxisZoom

bool vtkChartXY::AxisZoom[4]

protected

Property to enable zooming of individual axes with the mouse wheel.

True by default.

Definition at line 671 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 677 of file vtkChartXY.h.

◆ DragPointAlongX

bool vtkChartXY::DragPointAlongX

protected

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

Definition at line 682 of file vtkChartXY.h.

◆ DragPointAlongY

bool vtkChartXY::DragPointAlongY

protected

Definition at line 683 of file vtkChartXY.h.

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

Charts/Core/vtkChartXY.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

◆ MapIndexToIds

Constructor & Destructor Documentation

◆ vtkChartXY()

◆ ~vtkChartXY()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ New()

◆ Update()

◆ Paint()

◆ AddPlot() [1/4]

◆ AddPlot() [2/4]

◆ AddPlot() [3/4]

◆ AddPlot() [4/4]

◆ RemovePlot()

◆ ClearPlots()

◆ GetPlot()

◆ GetPlotIndex()

◆ RaisePlot()

◆ StackPlotAbove()

◆ LowerPlot()

◆ StackPlotUnder()

◆ GetNumberOfPlots()

◆ GetPlotCorner()

◆ SetPlotCorner()

◆ GetAxis()

◆ SetAxis()

◆ SetShowLegend()

◆ GetLegend()

◆ SetTooltip()

◆ GetTooltip()

◆ GetNumberOfAxes()

◆ RecalculateBounds()

◆ SetSelectionMethod()

◆ RemovePlotSelections()

◆ SetDrawAxesAtOrigin()

◆ GetDrawAxesAtOrigin()

◆ DrawAxesAtOriginOn()

◆ DrawAxesAtOriginOff()

◆ SetAutoAxes()

◆ GetAutoAxes()

◆ AutoAxesOn()

◆ AutoAxesOff()

◆ SetHiddenAxisBorder()

◆ GetHiddenAxisBorder()

◆ SetForceAxesToBounds()

◆ GetForceAxesToBounds()

◆ ForceAxesToBoundsOn()

◆ ForceAxesToBoundsOff()

◆ SetIgnoreNanInBounds()

◆ GetIgnoreNanInBounds()

◆ IgnoreNanInBoundsOn()

◆ IgnoreNanInBoundsOff()

◆ SetBarWidthFraction()

◆ GetBarWidthFraction()

◆ SetZoomWithMouseWheel()

◆ GetZoomWithMouseWheel()

◆ ZoomWithMouseWheelOn()

◆ ZoomWithMouseWheelOff()

◆ SetAxisZoom()

◆ GetAxisZoom()

◆ SetAdjustLowerBoundForLogPlot()

◆ GetAdjustLowerBoundForLogPlot()

◆ AdjustLowerBoundForLogPlotOn()

◆ AdjustLowerBoundForLogPlotOff()

◆ SetDragPointAlongX()

◆ GetDragPointAlongX()