vtkPlot Class Reference
#include <vtkPlot.h>
Detailed Description
Abstract class for 2D plots.The base class for all plot types used in vtkChart derived charts.
- See also:
- vtkPlotPoints vtkPlotLine vtkPlotBar vtkChart vtkChartXY
- Examples:
- vtkPlot (Examples)
- Tests:
- vtkPlot (Tests)
Definition at line 50 of file vtkPlot.h.
Public Types | |
| typedef vtkContextItem | Superclass |
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| virtual void | PrintSelf (ostream &os, vtkIndent indent) |
| virtual void | SetWidth (float width) |
| virtual float | GetWidth () |
| virtual void | SetLabel (const vtkStdString &label) |
| virtual vtkStdString | GetLabel () |
| virtual void | SetLabels (vtkStringArray *labels) |
| virtual vtkStringArray * | GetLabels () |
| virtual int | GetNumberOfLabels () |
| vtkStdString | GetLabel (vtkIdType index) |
| void | SetIndexedLabels (vtkStringArray *labels) |
| virtual vtkStringArray * | GetIndexedLabels () |
| virtual vtkTable * | GetInput () |
| virtual void | SetInputArray (int index, const vtkStdString &name) |
| virtual void | SetSelection (vtkIdTypeArray *id) |
| virtual vtkIdTypeArray * | GetSelection () |
| virtual bool | PaintLegend (vtkContext2D *painter, const vtkRectf &rect, int legendIndex) |
| virtual void | SetTooltipLabelFormat (const vtkStdString &label) |
| virtual vtkStdString | GetTooltipLabelFormat () |
| virtual vtkStdString | GetTooltipLabel (const vtkVector2f &plotPos, vtkIdType seriesIndex, vtkIdType segmentIndex) |
| virtual vtkIdType | GetNearestPoint (const vtkVector2f &point, const vtkVector2f &tolerance, vtkVector2f *location) |
| virtual bool | SelectPoints (const vtkVector2f &min, const vtkVector2f &max) |
| virtual void | SetColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a) |
| virtual void | SetColor (double r, double g, double b) |
| virtual void | GetColor (double rgb[3]) |
| void | GetColor (unsigned char rgb[3]) |
| virtual vtkPen * | GetPen () |
| virtual vtkBrush * | GetBrush () |
| virtual vtkContextMapper2D * | GetData () |
| virtual bool | GetUseIndexForXSeries () |
| virtual void | SetUseIndexForXSeries (bool) |
| virtual void | SetInput (vtkTable *table) |
| virtual void | SetInput (vtkTable *table, const vtkStdString &xColumn, const vtkStdString &yColumn) |
| void | SetInput (vtkTable *table, vtkIdType xColumn, vtkIdType yColumn) |
| virtual vtkAxis * | GetXAxis () |
| virtual void | SetXAxis (vtkAxis *axis) |
| virtual vtkAxis * | GetYAxis () |
| virtual void | SetYAxis (vtkAxis *axis) |
| virtual void | GetBounds (double bounds[4]) |
| virtual void | SetProperty (const vtkStdString &property, const vtkVariant &var) |
| virtual vtkVariant | GetProperty (const vtkStdString &property) |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkPlot * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| vtkPlot () | |
| ~vtkPlot () | |
| vtkStdString | GetNumber (double position, vtkAxis *axis) |
Protected Attributes | |
| vtkPen * | Pen |
| vtkBrush * | Brush |
| vtkSmartPointer< vtkStringArray > | Labels |
| vtkSmartPointer< vtkStringArray > | AutoLabels |
| vtkSmartPointer< vtkStringArray > | IndexedLabels |
| bool | UseIndexForXSeries |
| vtkContextMapper2D * | Data |
| vtkIdTypeArray * | Selection |
| vtkAxis * | XAxis |
| vtkAxis * | YAxis |
| vtkStdString | TooltipLabelFormat |
| vtkStdString | TooltipDefaultLabelFormat |
Member Typedef Documentation
| typedef vtkContextItem vtkPlot::Superclass |
Reimplemented from vtkContextItem.
Reimplemented in vtkColorTransferControlPointsItem, vtkColorTransferFunctionItem, vtkCompositeControlPointsItem, vtkCompositeTransferFunctionItem, vtkControlPointsItem, vtkLookupTableItem, vtkPiecewiseControlPointsItem, vtkPiecewiseFunctionItem, vtkPlotBar, vtkPlotHistogram2D, vtkPlotLine, vtkPlotParallelCoordinates, vtkPlotPie, vtkPlotPoints, vtkPlotStacked, and vtkScalarsToColorsItem.
Constructor & Destructor Documentation
| vtkPlot::vtkPlot | ( | ) | [protected] |
| vtkPlot::~vtkPlot | ( | ) | [protected] |
Member Function Documentation
| virtual const char* vtkPlot::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkContextItem.
Reimplemented in vtkColorTransferControlPointsItem, vtkColorTransferFunctionItem, vtkCompositeControlPointsItem, vtkCompositeTransferFunctionItem, vtkControlPointsItem, vtkLookupTableItem, vtkPiecewiseControlPointsItem, vtkPiecewiseFunctionItem, vtkPlotBar, vtkPlotHistogram2D, vtkPlotLine, vtkPlotParallelCoordinates, vtkPlotPie, vtkPlotPoints, vtkPlotStacked, and vtkScalarsToColorsItem.
| static int vtkPlot::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 vtkColorTransferControlPointsItem, vtkColorTransferFunctionItem, vtkCompositeControlPointsItem, vtkCompositeTransferFunctionItem, vtkControlPointsItem, vtkLookupTableItem, vtkPiecewiseControlPointsItem, vtkPiecewiseFunctionItem, vtkPlotBar, vtkPlotHistogram2D, vtkPlotLine, vtkPlotParallelCoordinates, vtkPlotPie, vtkPlotPoints, vtkPlotStacked, and vtkScalarsToColorsItem.
| virtual int vtkPlot::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 vtkColorTransferControlPointsItem, vtkColorTransferFunctionItem, vtkCompositeControlPointsItem, vtkCompositeTransferFunctionItem, vtkControlPointsItem, vtkLookupTableItem, vtkPiecewiseControlPointsItem, vtkPiecewiseFunctionItem, vtkPlotBar, vtkPlotHistogram2D, vtkPlotLine, vtkPlotParallelCoordinates, vtkPlotPie, vtkPlotPoints, vtkPlotStacked, and vtkScalarsToColorsItem.
Reimplemented from vtkContextItem.
Reimplemented in vtkColorTransferControlPointsItem, vtkColorTransferFunctionItem, vtkCompositeControlPointsItem, vtkCompositeTransferFunctionItem, vtkControlPointsItem, vtkLookupTableItem, vtkPiecewiseControlPointsItem, vtkPiecewiseFunctionItem, vtkPlotBar, vtkPlotHistogram2D, vtkPlotLine, vtkPlotParallelCoordinates, vtkPlotPie, vtkPlotPoints, vtkPlotStacked, and vtkScalarsToColorsItem.
| virtual void vtkPlot::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 vtkColorTransferControlPointsItem, vtkColorTransferFunctionItem, vtkCompositeControlPointsItem, vtkCompositeTransferFunctionItem, vtkControlPointsItem, vtkLookupTableItem, vtkPiecewiseControlPointsItem, vtkPiecewiseFunctionItem, vtkPlotBar, vtkPlotHistogram2D, vtkPlotLine, vtkPlotParallelCoordinates, vtkPlotPie, vtkPlotPoints, vtkPlotStacked, and vtkScalarsToColorsItem.
| virtual bool vtkPlot::PaintLegend | ( | vtkContext2D * | painter, | |
| const vtkRectf & | rect, | |||
| int | legendIndex | |||
| ) | [virtual] |
Paint legend event for the plot, called whenever the legend needs the plot items symbol/mark/line drawn. A rect is supplied with the lower left corner of the rect (elements 0 and 1) and with width x height (elements 2 and 3). The plot can choose how to fill the space supplied. The index is used by Plots that return more than one label.
Reimplemented in vtkPlotBar, vtkPlotLine, vtkPlotParallelCoordinates, vtkPlotPie, vtkPlotPoints, and vtkPlotStacked.
| virtual void vtkPlot::SetTooltipLabelFormat | ( | const vtkStdString & | label | ) | [virtual] |
Sets/gets a printf-style string to build custom tooltip labels from. An empty string generates the default tooltip labels. The following case-sensitive format tags (without quotes) are recognized: 'x' The X value of the plot element 'y' The Y value of the plot element 'i' The IndexedLabels entry for the plot element 'l' The value of the plot's GetLabel() function 's' (vtkPlotBar only) The Labels entry for the bar segment Any other characters or unrecognized format tags are printed in the tooltip label verbatim.
| virtual vtkStdString vtkPlot::GetTooltipLabelFormat | ( | ) | [virtual] |
Sets/gets a printf-style string to build custom tooltip labels from. An empty string generates the default tooltip labels. The following case-sensitive format tags (without quotes) are recognized: 'x' The X value of the plot element 'y' The Y value of the plot element 'i' The IndexedLabels entry for the plot element 'l' The value of the plot's GetLabel() function 's' (vtkPlotBar only) The Labels entry for the bar segment Any other characters or unrecognized format tags are printed in the tooltip label verbatim.
| virtual vtkStdString vtkPlot::GetTooltipLabel | ( | const vtkVector2f & | plotPos, | |
| vtkIdType | seriesIndex, | |||
| vtkIdType | segmentIndex | |||
| ) | [virtual] |
Generate and return the tooltip label string for this plot The segmentIndex parameter is ignored, except for vtkPlotBar
Reimplemented in vtkPlotBar.
| virtual vtkIdType vtkPlot::GetNearestPoint | ( | const vtkVector2f & | point, | |
| const vtkVector2f & | tolerance, | |||
| vtkVector2f * | location | |||
| ) | [virtual] |
Function to query a plot for the nearest point to the specified coordinate. Returns the index of the data series with which the point is associated, or -1 if no point was found.
Reimplemented in vtkPlotBar, vtkPlotPie, vtkPlotPoints, and vtkPlotStacked.
| virtual bool vtkPlot::SelectPoints | ( | const vtkVector2f & | min, | |
| const vtkVector2f & | max | |||
| ) | [virtual] |
Select all points in the specified rectangle.
Reimplemented in vtkControlPointsItem, vtkPlotBar, vtkPlotPoints, and vtkPlotStacked.
| virtual void vtkPlot::SetColor | ( | unsigned char | r, | |
| unsigned char | g, | |||
| unsigned char | b, | |||
| unsigned char | a | |||
| ) | [virtual] |
Set the plot color
Reimplemented in vtkPlotBar, and vtkPlotStacked.
| virtual void vtkPlot::SetColor | ( | double | r, | |
| double | g, | |||
| double | b | |||
| ) | [virtual] |
Set the plot color
Reimplemented in vtkPlotBar, and vtkPlotStacked.
| virtual void vtkPlot::GetColor | ( | double | rgb[3] | ) | [virtual] |
Set the plot color
Reimplemented in vtkPlotBar, and vtkPlotStacked.
| void vtkPlot::GetColor | ( | unsigned char | rgb[3] | ) |
Set the plot color
| virtual void vtkPlot::SetWidth | ( | float | width | ) | [virtual] |
Set the width of the line.
Reimplemented in vtkPlotBar.
| virtual float vtkPlot::GetWidth | ( | ) | [virtual] |
Get the width of the line.
Reimplemented in vtkPlotBar.
| virtual vtkPen* vtkPlot::GetPen | ( | ) | [virtual] |
Get a pointer to the vtkPen object that controls the was this plot draws lines.
| virtual vtkBrush* vtkPlot::GetBrush | ( | ) | [virtual] |
Get a pointer to the vtkBrush object that controls the was this plot fills shapes.
| virtual void vtkPlot::SetLabel | ( | const vtkStdString & | label | ) | [virtual] |
Set the label of this plot.
| virtual vtkStdString vtkPlot::GetLabel | ( | ) | [virtual] |
Get the label of this plot.
| virtual void vtkPlot::SetLabels | ( | vtkStringArray * | labels | ) | [virtual] |
Set the plot labels, these are used for stacked chart variants, with the index referring to the stacking index.
| virtual vtkStringArray* vtkPlot::GetLabels | ( | ) | [virtual] |
Get the plot labels. If this array has a length greater than 1 the index refers to the stacked objects in the plot. See vtkPlotBar for example.
Reimplemented in vtkPlotBar, and vtkPlotStacked.
| virtual int vtkPlot::GetNumberOfLabels | ( | ) | [virtual] |
Get the number of labels associated with this plot.
| vtkStdString vtkPlot::GetLabel | ( | vtkIdType | index | ) |
Get the label at the specified index.
| void vtkPlot::SetIndexedLabels | ( | vtkStringArray * | labels | ) |
Set indexed labels for the plot. If set, this array can be used to provide custom labels for each point in a plot. This array should be the same length as the points array. Default is null (no indexed labels).
| virtual vtkStringArray* vtkPlot::GetIndexedLabels | ( | ) | [virtual] |
Get the indexed labels array.
| virtual vtkContextMapper2D* vtkPlot::GetData | ( | ) | [virtual] |
Get the data object that the plot will draw.
| virtual bool vtkPlot::GetUseIndexForXSeries | ( | ) | [virtual] |
Use the Y array index for the X value. If true any X column setting will be ignored, and the X values will simply be the index of the Y column.
| virtual void vtkPlot::SetUseIndexForXSeries | ( | bool | ) | [virtual] |
Use the Y array index for the X value. If true any X column setting will be ignored, and the X values will simply be the index of the Y column.
| virtual void vtkPlot::SetInput | ( | vtkTable * | table | ) | [virtual] |
This is a convenience function to set the input table and the x, y column for the plot.
Reimplemented in vtkPlotHistogram2D, and vtkPlotParallelCoordinates.
| virtual void vtkPlot::SetInput | ( | vtkTable * | table, | |
| const vtkStdString & | xColumn, | |||
| const vtkStdString & | yColumn | |||
| ) | [virtual] |
This is a convenience function to set the input table and the x, y column for the plot.
Reimplemented in vtkPlotHistogram2D, and vtkPlotParallelCoordinates.
This is a convenience function to set the input table and the x, y column for the plot.
| virtual vtkTable* vtkPlot::GetInput | ( | ) | [virtual] |
Get the input table used by the plot.
| virtual void vtkPlot::SetInputArray | ( | int | index, | |
| const vtkStdString & | name | |||
| ) | [virtual] |
Convenience function to set the input arrays. For most plots index 0 is the x axis, and index 1 is the y axis. The name is the name of the column in the vtkTable.
Reimplemented in vtkPlotBar, and vtkPlotStacked.
| virtual void vtkPlot::SetSelection | ( | vtkIdTypeArray * | id | ) | [virtual] |
| virtual vtkIdTypeArray* vtkPlot::GetSelection | ( | ) | [virtual] |
| virtual vtkAxis* vtkPlot::GetXAxis | ( | ) | [virtual] |
Get/set the X axis associated with this plot.
| virtual void vtkPlot::SetXAxis | ( | vtkAxis * | axis | ) | [virtual] |
Get/set the X axis associated with this plot.
| virtual vtkAxis* vtkPlot::GetYAxis | ( | ) | [virtual] |
Get/set the Y axis associated with this plot.
| virtual void vtkPlot::SetYAxis | ( | vtkAxis * | axis | ) | [virtual] |
Get/set the Y axis associated with this plot.
| virtual void vtkPlot::GetBounds | ( | double | bounds[4] | ) | [inline, virtual] |
Get the bounds for this plot as (Xmin, Xmax, Ymin, Ymax).
Reimplemented in vtkColorTransferFunctionItem, vtkCompositeTransferFunctionItem, vtkControlPointsItem, vtkLookupTableItem, vtkPiecewiseFunctionItem, vtkPlotBar, vtkPlotHistogram2D, vtkPlotParallelCoordinates, vtkPlotPoints, vtkPlotStacked, and vtkScalarsToColorsItem.
| virtual void vtkPlot::SetProperty | ( | const vtkStdString & | property, | |
| const vtkVariant & | var | |||
| ) | [virtual] |
A General setter/getter that should be overridden. It can silently drop options, case is important
| virtual vtkVariant vtkPlot::GetProperty | ( | const vtkStdString & | property | ) | [virtual] |
A General setter/getter that should be overridden. It can silently drop options, case is important
| vtkStdString vtkPlot::GetNumber | ( | double | position, | |
| vtkAxis * | axis | |||
| ) | [protected] |
Get the properly formatted number for the supplied position and axis.
Member Data Documentation
vtkPen* vtkPlot::Pen [protected] |
vtkBrush* vtkPlot::Brush [protected] |
vtkSmartPointer<vtkStringArray> vtkPlot::Labels [protected] |
vtkSmartPointer<vtkStringArray> vtkPlot::AutoLabels [protected] |
vtkSmartPointer<vtkStringArray> vtkPlot::IndexedLabels [protected] |
bool vtkPlot::UseIndexForXSeries [protected] |
vtkContextMapper2D* vtkPlot::Data [protected] |
This data member contains the data that will be plotted, it inherits from vtkAlgorithm.
vtkIdTypeArray* vtkPlot::Selection [protected] |
vtkAxis* vtkPlot::XAxis [protected] |
vtkAxis* vtkPlot::YAxis [protected] |
vtkStdString vtkPlot::TooltipLabelFormat [protected] |
vtkStdString vtkPlot::TooltipDefaultLabelFormat [protected] |
The documentation for this class was generated from the following file:
- dox/Charts/vtkPlot.h
