Factory class for drawing 2D charts. More...
#include <vtkChart.h>
Detailed Description
Factory class for drawing 2D charts.
This defines the interface for a chart.
- Examples:
- vtkChart (Examples)
- Tests:
- vtkChart (Tests)
Definition at line 49 of file vtkChart.h.
Member Typedef Documentation
| typedef vtkContextItem vtkChart::Superclass |
Reimplemented from vtkContextItem.
Reimplemented in vtkChartXY, vtkChartParallelCoordinates, vtkChartPie, and vtkChartHistogram2D.
Definition at line 52 of file vtkChart.h.
Member Enumeration Documentation
| anonymous enum |
Enum of the available chart types
Definition at line 58 of file vtkChart.h.
| anonymous enum |
Enum of valid chart action types
Definition at line 67 of file vtkChart.h.
| enum vtkChart::EventIds |
Enum of event type that are triggered by the charts
Definition at line 79 of file vtkChart.h.
| anonymous enum |
Enumeration of the possible selection methods in a chart. SELECTION_ROWS is the default and simply selects the row in a table in all plots showing that table. SELECTION_PLOTS will make a selection in each plot, and that selection remains specific to the plot object.
Definition at line 134 of file vtkChart.h.
| anonymous enum |
Enum of the available layout strategies for the charts.
Definition at line 219 of file vtkChart.h.
Constructor & Destructor Documentation
| vtkChart::vtkChart | ( | ) | [protected] |
| vtkChart::~vtkChart | ( | ) | [protected] |
Member Function Documentation
| static int vtkChart::IsTypeOf | ( | const char * | name | ) | [static] |
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkContextItem.
Reimplemented in vtkChartXY, vtkChartParallelCoordinates, vtkChartPie, and vtkChartHistogram2D.
| virtual int vtkChart::IsA | ( | const char * | name | ) | [virtual] |
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkContextItem.
Reimplemented in vtkChartXY, vtkChartParallelCoordinates, vtkChartPie, and vtkChartHistogram2D.
| static vtkChart* vtkChart::SafeDownCast | ( | vtkObjectBase * | o | ) | [static] |
Reimplemented from vtkContextItem.
Reimplemented in vtkChartXY, vtkChartParallelCoordinates, vtkChartPie, and vtkChartHistogram2D.
| virtual vtkObjectBase* vtkChart::NewInstanceInternal | ( | ) | const [protected, virtual] |
Reimplemented from vtkContextItem.
Reimplemented in vtkChartXY, vtkChartParallelCoordinates, vtkChartPie, and vtkChartHistogram2D.
| vtkChart* vtkChart::NewInstance | ( | ) | const |
Reimplemented from vtkContextItem.
Reimplemented in vtkChartXY, vtkChartParallelCoordinates, vtkChartPie, and vtkChartHistogram2D.
| virtual void vtkChart::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
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 vtkContextItem.
Reimplemented in vtkChartXY, vtkChartParallelCoordinates, vtkChartPie, and vtkChartHistogram2D.
| virtual bool vtkChart::Paint | ( | vtkContext2D * | painter | ) | [pure virtual] |
Paint event for the chart, called whenever the chart needs to be drawn
Reimplemented from vtkAbstractContextItem.
Implemented in vtkChartXY, vtkChartParallelCoordinates, and vtkChartPie.
| virtual vtkPlot* vtkChart::AddPlot | ( | int | type | ) | [virtual] |
Add a plot to the chart, defaults to using the name of the y column
Reimplemented in vtkChartXY, and vtkChartPie.
| virtual vtkIdType vtkChart::AddPlot | ( | vtkPlot * | plot | ) | [virtual] |
Add a plot to the chart. Return the index of the plot, -1 if it failed.
Reimplemented in vtkChartXY, and vtkChartPie.
| virtual bool vtkChart::RemovePlot | ( | vtkIdType | index | ) | [virtual] |
Remove the plot at the specified index, returns true if successful, false if the index was invalid.
Reimplemented in vtkChartXY.
| virtual bool vtkChart::RemovePlotInstance | ( | vtkPlot * | plot | ) | [virtual] |
Remove the given plot. Returns true if successful, false if the plot was not contained in this chart. Note, the base implementation of this method performs a linear search to locate the plot.
| virtual void vtkChart::ClearPlots | ( | ) | [virtual] |
Remove all plots from the chart.
Reimplemented in vtkChartXY.
| virtual vtkPlot* vtkChart::GetPlot | ( | vtkIdType | index | ) | [virtual] |
Get the plot at the specified index, returns null if the index is invalid.
Reimplemented in vtkChartXY, vtkChartParallelCoordinates, vtkChartPie, and vtkChartHistogram2D.
| virtual vtkIdType vtkChart::GetNumberOfPlots | ( | ) | [virtual] |
Get the number of plots the chart contains.
Reimplemented in vtkChartXY, vtkChartParallelCoordinates, and vtkChartPie.
| virtual vtkAxis* vtkChart::GetAxis | ( | int | axisIndex | ) | [virtual] |
Get the axis specified by axisIndex. 0 is x, 1 is y. This should probably be improved either using a string or enum to select the axis.
Reimplemented in vtkChartXY, and vtkChartParallelCoordinates.
| virtual vtkIdType vtkChart::GetNumberOfAxes | ( | ) | [virtual] |
Get the number of axes in the current chart.
Reimplemented in vtkChartXY, and vtkChartParallelCoordinates.
| virtual void vtkChart::RecalculateBounds | ( | ) | [virtual] |
Request that the chart recalculates the range of its axes. Especially useful in applications after the parameters of plots have been modified.
Reimplemented in vtkChartXY, and vtkChartParallelCoordinates.
| virtual void vtkChart::SetSelectionMethod | ( | int | method | ) | [virtual] |
Set the selection method, which controls how selections are handled by the chart. The default is SELECTION_ROWS which selects all points in all plots in a chart that have values in the rows selected. SELECTION_PLOTS allows for finer-grained selections specific to each plot, and so to each XY column pair.
Reimplemented in vtkChartXY.
| virtual int vtkChart::GetSelectionMethod | ( | ) | [virtual] |
Set the selection method, which controls how selections are handled by the chart. The default is SELECTION_ROWS which selects all points in all plots in a chart that have values in the rows selected. SELECTION_PLOTS allows for finer-grained selections specific to each plot, and so to each XY column pair.
| virtual void vtkChart::SetAnnotationLink | ( | vtkAnnotationLink * | link | ) | [virtual] |
Set the vtkAnnotationLink for the chart.
| virtual vtkAnnotationLink* vtkChart::GetAnnotationLink | ( | ) | [virtual] |
Get the vtkAnnotationLink for the chart.
| virtual void vtkChart::SetGeometry | ( | int | , |
| int | |||
| ) | [virtual] |
Set/get the width and the height of the chart.
| void vtkChart::SetGeometry | ( | int | [2] | ) |
Set/get the width and the height of the chart.
| virtual int* vtkChart::GetGeometry | ( | ) | [virtual] |
Set/get the width and the height of the chart.
| virtual void vtkChart::GetGeometry | ( | int & | , |
| int & | |||
| ) | [virtual] |
Set/get the width and the height of the chart.
| virtual void vtkChart::GetGeometry | ( | int | [2] | ) | [virtual] |
Set/get the width and the height of the chart.
| virtual void vtkChart::SetPoint1 | ( | int | , |
| int | |||
| ) | [virtual] |
Set/get the first point in the chart (the bottom left).
| void vtkChart::SetPoint1 | ( | int | [2] | ) |
Set/get the first point in the chart (the bottom left).
| virtual int* vtkChart::GetPoint1 | ( | ) | [virtual] |
Set/get the first point in the chart (the bottom left).
| virtual void vtkChart::GetPoint1 | ( | int & | , |
| int & | |||
| ) | [virtual] |
Set/get the first point in the chart (the bottom left).
| virtual void vtkChart::GetPoint1 | ( | int | [2] | ) | [virtual] |
Set/get the first point in the chart (the bottom left).
| virtual void vtkChart::SetPoint2 | ( | int | , |
| int | |||
| ) | [virtual] |
Set/get the second point in the chart (the top right).
| void vtkChart::SetPoint2 | ( | int | [2] | ) |
Set/get the second point in the chart (the top right).
| virtual int* vtkChart::GetPoint2 | ( | ) | [virtual] |
Set/get the second point in the chart (the top right).
| virtual void vtkChart::GetPoint2 | ( | int & | , |
| int & | |||
| ) | [virtual] |
Set/get the second point in the chart (the top right).
| virtual void vtkChart::GetPoint2 | ( | int | [2] | ) | [virtual] |
Set/get the second point in the chart (the top right).
| virtual void vtkChart::SetShowLegend | ( | bool | visible | ) | [virtual] |
Set/get whether the chart should draw a legend.
Reimplemented in vtkChartXY, and vtkChartPie.
| virtual bool vtkChart::GetShowLegend | ( | ) | [virtual] |
Set/get whether the chart should draw a legend.
| virtual vtkChartLegend* vtkChart::GetLegend | ( | ) | [virtual] |
Get the legend for the chart, if available. Can return NULL if there is no legend.
Reimplemented in vtkChartXY, and vtkChartPie.
| virtual void vtkChart::SetTitle | ( | const vtkStdString & | title | ) | [virtual] |
Get/set the title text of the chart.
| virtual vtkStdString vtkChart::GetTitle | ( | ) | [virtual] |
Get/set the title text of the chart.
| virtual vtkTextProperty* vtkChart::GetTitleProperties | ( | ) | [virtual] |
Get the vtkTextProperty that governs how the chart title is displayed.
| void vtkChart::SetBottomBorder | ( | int | border | ) |
Set/get the borders of the chart (space in pixels around the chart).
| void vtkChart::SetTopBorder | ( | int | border | ) |
Set/get the borders of the chart (space in pixels around the chart).
| void vtkChart::SetLeftBorder | ( | int | border | ) |
Set/get the borders of the chart (space in pixels around the chart).
| void vtkChart::SetRightBorder | ( | int | border | ) |
Set/get the borders of the chart (space in pixels around the chart).
| void vtkChart::SetBorders | ( | int | left, |
| int | bottom, | ||
| int | right, | ||
| int | top | ||
| ) |
Set/get the borders of the chart (space in pixels around the chart).
| void vtkChart::SetSize | ( | const vtkRectf & | rect | ) |
Set the size of the chart. The rect argument specifies the bottom corner, width and height of the chart. The borders will be laid out within the specified rectangle.
Get the current size of the chart.
| virtual void vtkChart::SetLayoutStrategy | ( | int | ) | [virtual] |
Set/get the layout strategy that should be used by the chart. As we don't support enums this can take any value in the integer range, but the only valid enums are FILL_SCENE, FILL_RECT and AXES_TO_RECT.
| virtual int vtkChart::GetLayoutStrategy | ( | ) | [virtual] |
Set/get the layout strategy that should be used by the chart. As we don't support enums this can take any value in the integer range, but the only valid enums are FILL_SCENE, FILL_RECT and AXES_TO_RECT.
| virtual void vtkChart::SetAutoSize | ( | bool | isAutoSized | ) | [inline, virtual] |
Set/get whether the chart should automatically resize to fill the current render window. Default is true.
Definition at line 237 of file vtkChart.h.
| virtual bool vtkChart::GetAutoSize | ( | ) | [inline, virtual] |
Set/get whether the chart should automatically resize to fill the current render window. Default is true.
Definition at line 242 of file vtkChart.h.
| virtual void vtkChart::SetRenderEmpty | ( | bool | ) | [virtual] |
Set/get whether the chart should still render its axes and decorations even if the chart has no visible plots. Default is false (do not render an empty plot). Note that if you wish to render axes for an empty plot you should also set AutoSize to false, as that will hide all axes for an empty plot.
| virtual bool vtkChart::GetRenderEmpty | ( | ) | [virtual] |
Set/get whether the chart should still render its axes and decorations even if the chart has no visible plots. Default is false (do not render an empty plot). Note that if you wish to render axes for an empty plot you should also set AutoSize to false, as that will hide all axes for an empty plot.
| virtual void vtkChart::SetActionToButton | ( | int | action, |
| int | button | ||
| ) | [virtual] |
Assign action types to mouse buttons. Available action types are PAN, ZOOM and SELECT in the chart enum, the default assigns the LEFT_BUTTON to PAN, MIDDLE_BUTTON to ZOOM and RIGHT_BUTTON to SELECT. Valid mouse enums are in the vtkContextMouseEvent class. Note that only one mouse button can be assigned to each action, an action will have -1 (invalid button) assigned if it had the same button as the one assigned to a different action.
| virtual int vtkChart::GetActionToButton | ( | int | action | ) | [virtual] |
Get the mouse button associated with the supplied action. The mouse button enum is from vtkContextMouseEvent, and the action enum is from vtkChart.
| virtual void vtkChart::SetClickActionToButton | ( | int | action, |
| int | button | ||
| ) | [virtual] |
Assign action types to single mouse clicks. Available action types are SELECT and NOTIFY in the chart enum. The default assigns the LEFT_BUTTON to NOTIFY, and the RIGHT_BUTTON to SELECT.
| virtual int vtkChart::GetClickActionToButton | ( | int | action | ) | [virtual] |
Get the mouse button associated with the supplied click action. The mouse button enum is from vtkContextMouseEvent, and the action enum is from vtkChart.
| void vtkChart::SetBackgroundBrush | ( | vtkBrush * | brush | ) |
Set/Get the brush to use for the background color.
Set/Get the brush to use for the background color.
| virtual void vtkChart::SetSelectionMode | ( | int | ) | [virtual] |
Set/get the Selection Mode that will be used by the chart while doing selection. The only valid enums are vtkContextScene::SELECTION_NONE, SELECTION_DEFAULT, SELECTION_ADDITION, SELECTION_SUBTRACTION, SELECTION_TOGGLE
| virtual int vtkChart::GetSelectionMode | ( | ) | [virtual] |
Set/get the Selection Mode that will be used by the chart while doing selection. The only valid enums are vtkContextScene::SELECTION_NONE, SELECTION_DEFAULT, SELECTION_ADDITION, SELECTION_SUBTRACTION, SELECTION_TOGGLE
| bool vtkChart::CalculatePlotTransform | ( | vtkAxis * | x, |
| vtkAxis * | y, | ||
| vtkTransform2D * | transform | ||
| ) | [protected] |
Given the x and y vtkAxis, and a transform, calculate the transform that the points in a chart would need to be drawn within the axes. This assumes that the axes have the correct start and end positions, and that they are perpendicular.
| void vtkChart::AttachAxisRangeListener | ( | vtkAxis * | ) | [protected] |
Attach axis range listener so we can forward those events at the chart level
| void vtkChart::AxisRangeForwarderCallback | ( | vtkObject * | , |
| unsigned | long, | ||
| void * | |||
| ) | [protected] |
Member Data Documentation
vtkAnnotationLink* vtkChart::AnnotationLink [protected] |
Our annotation link, used for sharing selections etc.
Definition at line 317 of file vtkChart.h.
int vtkChart::Geometry[2] [protected] |
The width and the height of the chart.
Definition at line 320 of file vtkChart.h.
int vtkChart::Point1[2] [protected] |
The position of the lower left corner of the chart.
Definition at line 323 of file vtkChart.h.
int vtkChart::Point2[2] [protected] |
The position of the upper right corner of the chart.
Definition at line 326 of file vtkChart.h.
bool vtkChart::ShowLegend [protected] |
Display the legend?
Definition at line 329 of file vtkChart.h.
vtkStdString vtkChart::Title [protected] |
The title of the chart
Definition at line 332 of file vtkChart.h.
vtkTextProperty* vtkChart::TitleProperties [protected] |
The text properties associated with the chart
Definition at line 335 of file vtkChart.h.
vtkRectf vtkChart::Size [protected] |
Definition at line 337 of file vtkChart.h.
int vtkChart::LayoutStrategy [protected] |
Definition at line 339 of file vtkChart.h.
bool vtkChart::RenderEmpty [protected] |
Definition at line 340 of file vtkChart.h.
vtkSmartPointer<vtkBrush> vtkChart::BackgroundBrush [protected] |
Brush to use for drawing the background.
Definition at line 343 of file vtkChart.h.
int vtkChart::SelectionMode [protected] |
Definition at line 346 of file vtkChart.h.
int vtkChart::SelectionMethod [protected] |
Definition at line 350 of file vtkChart.h.
MouseActions vtkChart::Actions [protected] |
Definition at line 377 of file vtkChart.h.
MouseClickActions vtkChart::ActionsClick [protected] |
Definition at line 378 of file vtkChart.h.
The documentation for this class was generated from the following file:
- dox/Charts/Core/vtkChart.h
