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

Factory class for drawing box plot charts. More...

#include <vtkChartBox.h>

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

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkChartBoxSafeDownCast (vtkObjectBase *o)
 
static vtkChartBoxNew ()
 Creates a box chart. 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkChartBox ()
 
 ~vtkChartBox () override
 
void ResetSelection ()
 
void UpdateGeometry (vtkContext2D *)
 
void CalculatePlotTransform ()
 
void SwapAxes (int a1, int a2)
 
bool LocatePointInPlots (const vtkContextMouseEvent &mouse, int invokeEvent=-1)
 Try to locate a point within the plots to display in a tooltip. More...
 
int LocatePointInPlot (const vtkVector2f &position, const vtkVector2f &tolerance, vtkVector2f &plotPos, vtkPlot *plot, vtkIdType &segmentIndex)
 
- 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 CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

Private * Storage
 
bool GeometryValid
 
vtkIdTypeArraySelection
 Selected indices for the table the plot is rendering. More...
 
vtkStringArrayVisibleColumns
 A list of the visible columns in the chart. More...
 
int SelectedColumn
 Index of the selected column in the visible columns list. More...
 
float SelectedColumnDelta
 
vtkTimeStamp BuildTime
 The point cache is marked dirty until it has been initialized. More...
 
vtkSmartPointer< vtkTooltipItemTooltip
 The tooltip item for the chart - can be used to display extra information. More...
 
- 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
 

Detailed Description

Factory class for drawing box plot charts.

This defines the interface for a box plot chart.

Definition at line 36 of file vtkChartBox.h.

Member Typedef Documentation

◆ Superclass

Definition at line 39 of file vtkChartBox.h.

Constructor & Destructor Documentation

◆ vtkChartBox()

vtkChartBox::vtkChartBox ( )
protected

◆ ~vtkChartBox()

vtkChartBox::~vtkChartBox ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkChartBox::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkChart.

◆ NewInstance()

vtkChartBox* vtkChartBox::NewInstance ( ) const

◆ PrintSelf()

void vtkChartBox::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 vtkChartBox* vtkChartBox::New ( )
static

Creates a box chart.

◆ Update()

void vtkChartBox::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 vtkChartBox::Paint ( vtkContext2D painter)
overridevirtual

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

Implements vtkChart.

◆ SetColumnVisibility() [1/2]

void vtkChartBox::SetColumnVisibility ( const vtkStdString name,
bool  visible 
)

Set the visibility of the specified column.

◆ SetColumnVisibility() [2/2]

void vtkChartBox::SetColumnVisibility ( vtkIdType  column,
bool  visible 
)

◆ SetColumnVisibilityAll()

void vtkChartBox::SetColumnVisibilityAll ( bool  visible)

Set the visibility of all columns (true will make them all visible, false will remove all visible columns).

◆ GetColumnVisibility() [1/2]

bool vtkChartBox::GetColumnVisibility ( const vtkStdString name)

Get the visibility of the specified column.

◆ GetColumnVisibility() [2/2]

bool vtkChartBox::GetColumnVisibility ( vtkIdType  column)

◆ GetColumnId()

vtkIdType vtkChartBox::GetColumnId ( const vtkStdString name)

Get the input table column id of a column by its name.

◆ GetVisibleColumns()

virtual vtkStringArray* vtkChartBox::GetVisibleColumns ( )
virtual

Get a list of the columns, and the order in which they are displayed.

◆ GetSelectedColumn()

virtual int vtkChartBox::GetSelectedColumn ( )
virtual

◆ SetSelectedColumn()

virtual void vtkChartBox::SetSelectedColumn ( int  )
virtual

◆ GetPlot()

vtkPlot* vtkChartBox::GetPlot ( vtkIdType  index)
overridevirtual

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

Reimplemented from vtkChart.

◆ GetNumberOfPlots()

vtkIdType vtkChartBox::GetNumberOfPlots ( )
overridevirtual

Get the number of plots the chart contains.

Reimplemented from vtkChart.

◆ GetYAxis()

virtual vtkAxis* vtkChartBox::GetYAxis ( )
virtual

Get the chart Y axis.

◆ GetXPosition()

virtual float vtkChartBox::GetXPosition ( int  index)
virtual

Get the column X position by index in the visible set.

◆ GetNumberOfVisibleColumns()

virtual vtkIdType vtkChartBox::GetNumberOfVisibleColumns ( )
virtual

Get the number of visible box plots in the current chart.

◆ SetPlot()

virtual void vtkChartBox::SetPlot ( vtkPlotBox plot)
virtual

Set plot to use for the chart.

Since this type of chart can only contain one plot, this will replace the previous plot.

◆ Hit()

bool vtkChartBox::Hit ( const vtkContextMouseEvent mouse)
overridevirtual

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

Reimplemented from vtkAbstractContextItem.

◆ MouseMoveEvent()

bool vtkChartBox::MouseMoveEvent ( const vtkContextMouseEvent mouse)
overridevirtual

Mouse move event.

Reimplemented from vtkAbstractContextItem.

◆ MouseButtonPressEvent()

bool vtkChartBox::MouseButtonPressEvent ( const vtkContextMouseEvent mouse)
overridevirtual

Mouse button down event.

Reimplemented from vtkAbstractContextItem.

◆ MouseButtonReleaseEvent()

bool vtkChartBox::MouseButtonReleaseEvent ( const vtkContextMouseEvent mouse)
overridevirtual

Mouse button release event.

Reimplemented from vtkAbstractContextItem.

◆ SetTooltip()

virtual void vtkChartBox::SetTooltip ( vtkTooltipItem tooltip)
virtual

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

◆ GetTooltip()

virtual vtkTooltipItem* vtkChartBox::GetTooltip ( )
virtual

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

◆ SetTooltipInfo()

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

Set the information passed to the tooltip.

◆ ResetSelection()

void vtkChartBox::ResetSelection ( )
protected

◆ UpdateGeometry()

void vtkChartBox::UpdateGeometry ( vtkContext2D )
protected

◆ CalculatePlotTransform()

void vtkChartBox::CalculatePlotTransform ( )
protected

◆ SwapAxes()

void vtkChartBox::SwapAxes ( int  a1,
int  a2 
)
protected

◆ LocatePointInPlots()

bool vtkChartBox::LocatePointInPlots ( const vtkContextMouseEvent mouse,
int  invokeEvent = -1 
)
protected

Try to locate a point within the plots to display in a tooltip.

If invokeEvent is greater than 0, then an event will be invoked if a point is at that mouse position.

◆ LocatePointInPlot()

int vtkChartBox::LocatePointInPlot ( const vtkVector2f position,
const vtkVector2f tolerance,
vtkVector2f plotPos,
vtkPlot plot,
vtkIdType segmentIndex 
)
protected

Member Data Documentation

◆ Storage

Private* vtkChartBox::Storage
protected

Definition at line 172 of file vtkChartBox.h.

◆ GeometryValid

bool vtkChartBox::GeometryValid
protected

Definition at line 176 of file vtkChartBox.h.

◆ Selection

vtkIdTypeArray* vtkChartBox::Selection
protected

Selected indices for the table the plot is rendering.

Definition at line 181 of file vtkChartBox.h.

◆ VisibleColumns

vtkStringArray* vtkChartBox::VisibleColumns
protected

A list of the visible columns in the chart.

Definition at line 186 of file vtkChartBox.h.

◆ SelectedColumn

int vtkChartBox::SelectedColumn
protected

Index of the selected column in the visible columns list.

Definition at line 192 of file vtkChartBox.h.

◆ SelectedColumnDelta

float vtkChartBox::SelectedColumnDelta
protected

Definition at line 193 of file vtkChartBox.h.

◆ BuildTime

vtkTimeStamp vtkChartBox::BuildTime
protected

The point cache is marked dirty until it has been initialized.

Definition at line 199 of file vtkChartBox.h.

◆ Tooltip

vtkSmartPointer<vtkTooltipItem> vtkChartBox::Tooltip
protected

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

Definition at line 204 of file vtkChartBox.h.


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