vtkXYPlotActor Class Reference

generate an x-y plot from input dataset(s) or field data More...

#include <vtkXYPlotActor.h>

Inheritance diagram for vtkXYPlotActor:

Collaboration diagram for vtkXYPlotActor:

Public Types
enum	Alignment {   AlignLeft = 0x1 , AlignRight = 0x2 , AlignHCenter = 0x4 , AlignTop = 0x10 ,   AlignBottom = 0x20 , AlignVCenter = 0x40 , AlignAxisLeft = 0x100 , AlignAxisRight = 0x200 ,   AlignAxisHCenter = 0x400 , AlignAxisTop = 0x1000 , AlignAxisBottom = 0x2000 , AlignAxisVCenter = 0x4000 }
typedef vtkActor2D	Superclass
Public Types inherited from vtkActor2D
typedef vtkProp	Superclass
Public Types inherited from vtkProp
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.
vtkXYPlotActor *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	RemoveAllDataSetInputConnections ()
	This removes all of the data set inputs, but does not change the data object inputs.
void	SetPlotColor (int i, double r, double g, double b)
void	SetPlotColor (int i, const double color[3])
double *	GetPlotColor (int i)
void	SetPlotSymbol (int i, vtkPolyData *input)
vtkPolyData *	GetPlotSymbol (int i)
void	SetPlotLabel (int i, const char *label)
const char *	GetPlotLabel (int i)
virtual vtkTypeBool	GetPlotCurvePoints ()
virtual void	SetPlotCurvePoints (vtkTypeBool)
virtual void	PlotCurvePointsOn ()
virtual void	PlotCurvePointsOff ()
virtual vtkTypeBool	GetPlotCurveLines ()
virtual void	SetPlotCurveLines (vtkTypeBool)
virtual void	PlotCurveLinesOn ()
virtual void	PlotCurveLinesOff ()
void	SetPlotLines (int i, int)
int	GetPlotLines (int i)
void	SetPlotPoints (int i, int)
int	GetPlotPoints (int i)
void	ViewportToPlotCoordinate (vtkViewport *viewport, double &u, double &v)
	Given a position within the viewport used by the plot, return the the plot coordinates (XAxis value, YAxis value)
void	PlotToViewportCoordinate (vtkViewport *viewport, double &u, double &v)
	Given a plot coordinate, return the viewpoint position.
int	IsInPlot (vtkViewport *viewport, double u, double v)
	Is the specified viewport position within the plot area (as opposed to the region used by the plot plus the labels)?
vtkProperty2D *	GetChartBoxProperty ()
	Get the box vtkProperty2D.
vtkMTimeType	GetMTime () override
	Take into account the modified time of internal helper classes.
void	PrintAsCSV (ostream &os)
	Write the XY Ploat Actor as a CSV (comma separated value) representation.
vtkTypeBool	HasTranslucentPolygonalGeometry () override
	Does this prop have some translucent polygonal geometry?
void	ReleaseGraphicsResources (vtkWindow *) override
	Release any graphics resources that are being consumed by this actor.
void	AddDataSetInput (vtkDataSet *ds, const char *arrayName, int component)
	Add a dataset to the list of data to append.
void	AddDataSetInput (vtkDataSet *ds)
	Add a dataset to the list of data to append.
void	AddDataSetInputConnection (vtkAlgorithmOutput *in, const char *arrayName, int component)
	Add a dataset to the list of data to append.
void	AddDataSetInputConnection (vtkAlgorithmOutput *in)
	Add a dataset to the list of data to append.
void	RemoveDataSetInput (vtkDataSet *ds, const char *arrayName, int component)
	Remove a dataset from the list of data to append.
void	RemoveDataSetInput (vtkDataSet *ds)
	Remove a dataset from the list of data to append.
void	RemoveDataSetInputConnection (vtkAlgorithmOutput *in, const char *arrayName, int component)
	Remove a dataset from the list of data to append.
void	RemoveDataSetInputConnection (vtkAlgorithmOutput *in)
	Remove a dataset from the list of data to append.
void	SetPointComponent (int i, int comp)
	If plotting points by value, which component to use to determine the value.
int	GetPointComponent (int i)
	If plotting points by value, which component to use to determine the value.
virtual void	SetXValues (int)
	Specify how the independent (x) variable is computed from the points.
virtual int	GetXValues ()
	Specify how the independent (x) variable is computed from the points.
void	SetXValuesToIndex ()
	Specify how the independent (x) variable is computed from the points.
void	SetXValuesToArcLength ()
	Specify how the independent (x) variable is computed from the points.
void	SetXValuesToNormalizedArcLength ()
	Specify how the independent (x) variable is computed from the points.
void	SetXValuesToValue ()
	Specify how the independent (x) variable is computed from the points.
const char *	GetXValuesAsString ()
	Specify how the independent (x) variable is computed from the points.
void	AddDataObjectInput (vtkDataObject *in)
	Add a data object to the list of data to display.
void	AddDataObjectInputConnection (vtkAlgorithmOutput *alg)
	Add a data object to the list of data to display.
void	RemoveDataObjectInputConnection (vtkAlgorithmOutput *aout)
	Remove a dataset from the list of data to display.
void	RemoveDataObjectInput (vtkDataObject *in)
	Remove a dataset from the list of data to display.
virtual void	SetDataObjectPlotMode (int)
	Indicate whether to plot rows or columns.
virtual int	GetDataObjectPlotMode ()
	Indicate whether to plot rows or columns.
void	SetDataObjectPlotModeToRows ()
	Indicate whether to plot rows or columns.
void	SetDataObjectPlotModeToColumns ()
	Indicate whether to plot rows or columns.
const char *	GetDataObjectPlotModeAsString ()
	Indicate whether to plot rows or columns.
void	SetDataObjectXComponent (int i, int comp)
	Specify which component of the input data object to use as the independent variable for the ith input data object.
int	GetDataObjectXComponent (int i)
	Specify which component of the input data object to use as the independent variable for the ith input data object.
void	SetDataObjectYComponent (int i, int comp)
	Specify which component of the input data object to use as the dependent variable for the ith input data object.
int	GetDataObjectYComponent (int i)
	Specify which component of the input data object to use as the dependent variable for the ith input data object.
virtual void	SetExchangeAxes (vtkTypeBool)
	Enable/Disable exchange of the x-y axes (i.e., what was x becomes y, and vice-versa).
virtual vtkTypeBool	GetExchangeAxes ()
	Enable/Disable exchange of the x-y axes (i.e., what was x becomes y, and vice-versa).
virtual void	ExchangeAxesOn ()
	Enable/Disable exchange of the x-y axes (i.e., what was x becomes y, and vice-versa).
virtual void	ExchangeAxesOff ()
	Enable/Disable exchange of the x-y axes (i.e., what was x becomes y, and vice-versa).
virtual void	SetReverseXAxis (vtkTypeBool)
	Normally the x-axis is plotted from minimum to maximum.
virtual vtkTypeBool	GetReverseXAxis ()
	Normally the x-axis is plotted from minimum to maximum.
virtual void	ReverseXAxisOn ()
	Normally the x-axis is plotted from minimum to maximum.
virtual void	ReverseXAxisOff ()
	Normally the x-axis is plotted from minimum to maximum.
virtual void	SetReverseYAxis (vtkTypeBool)
	Normally the y-axis is plotted from minimum to maximum.
virtual vtkTypeBool	GetReverseYAxis ()
	Normally the y-axis is plotted from minimum to maximum.
virtual void	ReverseYAxisOn ()
	Normally the y-axis is plotted from minimum to maximum.
virtual void	ReverseYAxisOff ()
	Normally the y-axis is plotted from minimum to maximum.
virtual vtkLegendBoxActor *	GetLegendActor ()
	Retrieve handles to the legend box and glyph source.
virtual vtkGlyphSource2D *	GetGlyphSource ()
	Retrieve handles to the legend box and glyph source.
virtual void	SetTitle (const char *)
	Set/Get the title of the x-y plot.
virtual char *	GetTitle ()
	Set/Get the title of the x-y plot.
virtual void	SetXTitle (const char *)
	Set/Get the title of the x axis.
virtual char *	GetXTitle ()
	Set/Get the title of the x axis.
virtual void	SetYTitle (const char *)
	Set/Get the title of the y axis.
char *	GetYTitle ()
	Set/Get the title of the y axis.
vtkAxisActor2D *	GetXAxisActor2D ()
	Retrieve handles to the X and Y axis (so that you can set their text properties for example)
vtkAxisActor2D *	GetYAxisActor2D ()
	Retrieve handles to the X and Y axis (so that you can set their text properties for example)
virtual void	SetXRange (double, double)
	Set the plot range (range of independent and dependent variables) to plot.
void	SetXRange (double[2])
	Set the plot range (range of independent and dependent variables) to plot.
virtual double *	GetXRange ()
	Set the plot range (range of independent and dependent variables) to plot.
virtual void	GetXRange (double data[2])
	Set the plot range (range of independent and dependent variables) to plot.
virtual void	SetYRange (double, double)
	Set the plot range (range of independent and dependent variables) to plot.
void	SetYRange (double[2])
	Set the plot range (range of independent and dependent variables) to plot.
virtual double *	GetYRange ()
	Set the plot range (range of independent and dependent variables) to plot.
virtual void	GetYRange (double data[2])
	Set the plot range (range of independent and dependent variables) to plot.
void	SetPlotRange (double xmin, double ymin, double xmax, double ymax)
	Set the plot range (range of independent and dependent variables) to plot.
virtual void	SetNumberOfXLabels (int)
	Set/Get the number of annotation labels to show along the x and y axes.
virtual int	GetNumberOfXLabels ()
	Set/Get the number of annotation labels to show along the x and y axes.
virtual void	SetNumberOfYLabels (int)
	Set/Get the number of annotation labels to show along the x and y axes.
virtual int	GetNumberOfYLabels ()
	Set/Get the number of annotation labels to show along the x and y axes.
void	SetNumberOfLabels (int num)
	Set/Get the number of annotation labels to show along the x and y axes.
void	SetAdjustXLabels (int adjust)
	Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels.
virtual int	GetAdjustXLabels ()
	Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels.
void	SetAdjustYLabels (int adjust)
	Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels.
virtual int	GetAdjustYLabels ()
	Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels.
void	SetNumberOfXMinorTicks (int num)
	Set/Get the number of minor ticks in X or Y.
int	GetNumberOfXMinorTicks ()
	Set/Get the number of minor ticks in X or Y.
void	SetNumberOfYMinorTicks (int num)
	Set/Get the number of minor ticks in X or Y.
int	GetNumberOfYMinorTicks ()
	Set/Get the number of minor ticks in X or Y.
virtual void	SetLegend (vtkTypeBool)
	Enable/Disable the creation of a legend.
virtual vtkTypeBool	GetLegend ()
	Enable/Disable the creation of a legend.
virtual void	LegendOn ()
	Enable/Disable the creation of a legend.
virtual void	LegendOff ()
	Enable/Disable the creation of a legend.
virtual void	SetTitlePosition (double, double)
	Set/Get the position of the title.
void	SetTitlePosition (double[2])
	Set/Get the position of the title.
virtual double *	GetTitlePosition ()
	Set/Get the position of the title.
virtual void	GetTitlePosition (double &, double &)
	Set/Get the position of the title.
virtual void	GetTitlePosition (double[2])
	Set/Get the position of the title.
virtual void	SetAdjustTitlePosition (vtkTypeBool)
	If true, the xyplot actor will adjust the position of the title automatically to be upper-middle.
virtual vtkTypeBool	GetAdjustTitlePosition ()
	If true, the xyplot actor will adjust the position of the title automatically to be upper-middle.
virtual void	AdjustTitlePositionOn ()
	If true, the xyplot actor will adjust the position of the title automatically to be upper-middle.
virtual void	AdjustTitlePositionOff ()
	If true, the xyplot actor will adjust the position of the title automatically to be upper-middle.
virtual void	SetAdjustTitlePositionMode (int)
	If AdjustTitlePosition is true, the xyplot actor will adjust the position of the title automatically depending on the given mode, the mode is a combination of the Alignment flags.
virtual int	GetAdjustTitlePositionMode ()
	If AdjustTitlePosition is true, the xyplot actor will adjust the position of the title automatically depending on the given mode, the mode is a combination of the Alignment flags.
virtual void	SetLegendPosition (double, double)
	Use these methods to control the position of the legend.
void	SetLegendPosition (double[2])
	Use these methods to control the position of the legend.
virtual double *	GetLegendPosition ()
	Use these methods to control the position of the legend.
virtual void	GetLegendPosition (double &, double &)
	Use these methods to control the position of the legend.
virtual void	GetLegendPosition (double[2])
	Use these methods to control the position of the legend.
virtual void	SetLegendPosition2 (double, double)
	Use these methods to control the position of the legend.
void	SetLegendPosition2 (double[2])
	Use these methods to control the position of the legend.
virtual double *	GetLegendPosition2 ()
	Use these methods to control the position of the legend.
virtual void	GetLegendPosition2 (double &, double &)
	Use these methods to control the position of the legend.
virtual void	GetLegendPosition2 (double[2])
	Use these methods to control the position of the legend.
virtual void	SetTitleTextProperty (vtkTextProperty *p)
	Set/Get the title text property.
virtual vtkTextProperty *	GetTitleTextProperty ()
	Set/Get the title text property.
virtual void	SetAxisTitleTextProperty (vtkTextProperty *p)
	Set/Get the title text property of all axes.
virtual vtkTextProperty *	GetAxisTitleTextProperty ()
	Set/Get the title text property of all axes.
virtual void	SetAxisLabelTextProperty (vtkTextProperty *p)
	Set/Get the labels text property of all axes.
virtual vtkTextProperty *	GetAxisLabelTextProperty ()
	Set/Get the labels text property of all axes.
virtual void	SetLogx (vtkTypeBool)
	Enable/Disable plotting of Log of x-values.
virtual vtkTypeBool	GetLogx ()
	Enable/Disable plotting of Log of x-values.
virtual void	LogxOn ()
	Enable/Disable plotting of Log of x-values.
virtual void	LogxOff ()
	Enable/Disable plotting of Log of x-values.
virtual void	SetLabelFormat (const char *)
	Set/Get the format with which to print the labels .
const char *	GetLabelFormat ()
	Set/Get the format with which to print the labels .
virtual void	SetXLabelFormat (const char *)
	Set/Get the format with which to print the X label.
virtual char *	GetXLabelFormat ()
	Set/Get the format with which to print the X label.
virtual void	SetYLabelFormat (const char *)
	Set/Get the format with which to print the Y label.
virtual char *	GetYLabelFormat ()
	Set/Get the format with which to print the Y label.
virtual void	SetBorder (int)
	Set/Get the spacing between the plot window and the plot.
virtual int	GetBorder ()
	Set/Get the spacing between the plot window and the plot.
virtual vtkTypeBool	GetPlotPoints ()
	Set/Get whether the points are rendered.
virtual void	SetPlotPoints (vtkTypeBool)
	Set/Get whether the points are rendered.
virtual void	PlotPointsOn ()
	Set/Get whether the points are rendered.
virtual void	PlotPointsOff ()
	Set/Get whether the points are rendered.
virtual vtkTypeBool	GetPlotLines ()
	Set/Get whether the lines are rendered.
virtual void	SetPlotLines (vtkTypeBool)
	Set/Get whether the lines are rendered.
virtual void	PlotLinesOn ()
	Set/Get whether the lines are rendered.
virtual void	PlotLinesOff ()
	Set/Get whether the lines are rendered.
virtual void	SetGlyphSize (double)
	Set/Get the factor that controls how big glyphs are in the plot.
virtual double	GetGlyphSize ()
	Set/Get the factor that controls how big glyphs are in the plot.
void	ViewportToPlotCoordinate (vtkViewport *viewport)
	An alternate form of ViewportToPlotCoordinate() above.
virtual void	SetPlotCoordinate (double, double)
	An alternate form of ViewportToPlotCoordinate() above.
void	SetPlotCoordinate (double[2])
	An alternate form of ViewportToPlotCoordinate() above.
virtual double *	GetPlotCoordinate ()
	An alternate form of ViewportToPlotCoordinate() above.
virtual void	GetPlotCoordinate (double &, double &)
	An alternate form of ViewportToPlotCoordinate() above.
virtual void	GetPlotCoordinate (double[2])
	An alternate form of ViewportToPlotCoordinate() above.
void	PlotToViewportCoordinate (vtkViewport *viewport)
	An alternate form of PlotToViewportCoordinate() above.
virtual void	SetViewportCoordinate (double, double)
	An alternate form of PlotToViewportCoordinate() above.
void	SetViewportCoordinate (double[2])
	An alternate form of PlotToViewportCoordinate() above.
virtual double *	GetViewportCoordinate ()
	An alternate form of PlotToViewportCoordinate() above.
virtual void	GetViewportCoordinate (double &, double &)
	An alternate form of PlotToViewportCoordinate() above.
virtual void	GetViewportCoordinate (double[2])
	An alternate form of PlotToViewportCoordinate() above.
virtual void	SetChartBox (vtkTypeBool)
	Set/Get the flag that controls whether a box will be drawn/filled corresponding to the chart box.
virtual vtkTypeBool	GetChartBox ()
	Set/Get the flag that controls whether a box will be drawn/filled corresponding to the chart box.
virtual void	ChartBoxOn ()
	Set/Get the flag that controls whether a box will be drawn/filled corresponding to the chart box.
virtual void	ChartBoxOff ()
	Set/Get the flag that controls whether a box will be drawn/filled corresponding to the chart box.
virtual void	SetChartBorder (vtkTypeBool)
	Set/Get the flag that controls whether a box will be drawn/filled corresponding to the legend box.
virtual vtkTypeBool	GetChartBorder ()
	Set/Get the flag that controls whether a box will be drawn/filled corresponding to the legend box.
virtual void	ChartBorderOn ()
	Set/Get the flag that controls whether a box will be drawn/filled corresponding to the legend box.
virtual void	ChartBorderOff ()
	Set/Get the flag that controls whether a box will be drawn/filled corresponding to the legend box.
virtual void	SetShowReferenceXLine (vtkTypeBool)
	Set/Get if the X reference line is visible.
virtual vtkTypeBool	GetShowReferenceXLine ()
	Set/Get if the X reference line is visible.
virtual void	ShowReferenceXLineOn ()
	Set/Get if the X reference line is visible.
virtual void	ShowReferenceXLineOff ()
	Set/Get if the X reference line is visible.
virtual void	SetReferenceXValue (double)
	Set/Get the value for the X reference line.
virtual double	GetReferenceXValue ()
	Set/Get the value for the X reference line.
virtual void	SetShowReferenceYLine (vtkTypeBool)
	Set/Get if the Y reference line is visible.
virtual vtkTypeBool	GetShowReferenceYLine ()
	Set/Get if the Y reference line is visible.
virtual void	ShowReferenceYLineOn ()
	Set/Get if the Y reference line is visible.
virtual void	ShowReferenceYLineOff ()
	Set/Get if the Y reference line is visible.
virtual void	SetReferenceYValue (double)
	Set/Get the value for the Y reference line.
virtual double	GetReferenceYValue ()
	Set/Get the value for the Y reference line.
int	RenderOpaqueGeometry (vtkViewport *) override
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.
int	RenderOverlay (vtkViewport *) override
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.
int	RenderTranslucentPolygonalGeometry (vtkViewport *) override
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.
void	SetXTitlePosition (double position)
	Set/Get the position of the title of X axis.
double	GetXTitlePosition ()
	Set/Get the position of the title of X axis.
virtual void	SetYTitlePosition (int)
	Set/Get the position of the title of Y axis.
virtual int	GetYTitlePosition ()
	Set/Get the position of the title of Y axis.
void	SetYTitlePositionToTop ()
	Set/Get the position of the title of Y axis.
void	SetYTitlePositionToHCenter ()
	Set/Get the position of the title of Y axis.
void	SetYTitlePositionToVCenter ()
	Set/Get the position of the title of Y axis.
virtual void	SetPlotGlyphType (int, int)
	Set plot properties.
virtual void	SetLineWidth (double)
	Set plot properties.
virtual void	AddUserCurvesPoint (double, double, double)
	Set plot properties.
virtual void	RemoveAllActiveCurves ()
	Set plot properties.
virtual void	SetLegendBorder (int)
	Set legend properties.
virtual void	SetLegendBox (int)
	Set legend properties.
virtual void	SetLegendUseBackground (int)
	Set legend properties.
virtual void	SetLegendBackgroundColor (double, double, double)
	Set legend properties.
virtual void	SetTitleColor (double, double, double)
	Set title properties.
virtual void	SetTitleFontFamily (int)
	Set title properties.
virtual void	SetTitleBold (int)
	Set title properties.
virtual void	SetTitleItalic (int)
	Set title properties.
virtual void	SetTitleShadow (int)
	Set title properties.
virtual void	SetTitleFontSize (int)
	Set title properties.
virtual void	SetTitleJustification (int)
	Set title properties.
virtual void	SetTitleVerticalJustification (int)
	Set title properties.
virtual void	SetXAxisColor (double, double, double)
	Set axes properties.
virtual void	SetYAxisColor (double, double, double)
	Set axes properties.
virtual void	SetAxisTitleColor (double, double, double)
	Set axis title properties.
virtual void	SetAxisTitleFontFamily (int)
	Set axis title properties.
virtual void	SetAxisTitleBold (int)
	Set axis title properties.
virtual void	SetAxisTitleItalic (int)
	Set axis title properties.
virtual void	SetAxisTitleShadow (int)
	Set axis title properties.
virtual void	SetAxisTitleFontSize (int)
	Set axis title properties.
virtual void	SetAxisTitleJustification (int)
	Set axis title properties.
virtual void	SetAxisTitleVerticalJustification (int)
	Set axis title properties.
virtual void	SetAxisLabelColor (double, double, double)
	Set axis label properties.
virtual void	SetAxisLabelFontFamily (int)
	Set axis label properties.
virtual void	SetAxisLabelBold (int)
	Set axis label properties.
virtual void	SetAxisLabelItalic (int)
	Set axis label properties.
virtual void	SetAxisLabelShadow (int)
	Set axis label properties.
virtual void	SetAxisLabelFontSize (int)
	Set axis label properties.
virtual void	SetAxisLabelJustification (int)
	Set axis label properties.
virtual void	SetAxisLabelVerticalJustification (int)
	Set axis label properties.
Public Member Functions inherited from vtkActor2D
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkActor2D *	NewInstance () const
vtkTypeBool	HasTranslucentPolygonalGeometry () override
	Does this prop have some translucent polygonal geometry?
vtkProperty2D *	GetProperty ()
	Returns this actor's vtkProperty2D.
virtual void	SetProperty (vtkProperty2D *)
	Set this vtkProp's vtkProperty2D.
void	SetDisplayPosition (int, int)
	Set the Prop2D's position in display coordinates.
vtkMTimeType	GetMTime () override
	Return this objects MTime.
void	GetActors2D (vtkPropCollection *pc) override
	For some exporters and other other operations we must be able to collect all the actors or volumes.
void	ShallowCopy (vtkProp *prop) override
	Shallow copy of this vtkActor2D.
void	ReleaseGraphicsResources (vtkWindow *) override
	Release any graphics resources that are being consumed by this actor.
virtual vtkCoordinate *	GetActualPositionCoordinate (void)
	Return the actual vtkCoordinate reference that the mapper should use to position the actor.
virtual vtkCoordinate *	GetActualPosition2Coordinate (void)
	Return the actual vtkCoordinate reference that the mapper should use to position the actor.
int	RenderOverlay (vtkViewport *viewport) override
	Support the standard render methods.
int	RenderOpaqueGeometry (vtkViewport *viewport) override
	Support the standard render methods.
int	RenderTranslucentPolygonalGeometry (vtkViewport *viewport) override
	Support the standard render methods.
virtual void	SetMapper (vtkMapper2D *mapper)
	Set/Get the vtkMapper2D which defines the data to be drawn.
virtual vtkMapper2D *	GetMapper ()
	Set/Get the vtkMapper2D which defines the data to be drawn.
virtual void	SetLayerNumber (int)
	Set/Get the layer number in the overlay planes into which to render.
virtual int	GetLayerNumber ()
	Set/Get the layer number in the overlay planes into which to render.
virtual vtkCoordinate *	GetPositionCoordinate ()
	Get the PositionCoordinate instance of vtkCoordinate.
virtual void	SetPosition (float x[2])
	Get the PositionCoordinate instance of vtkCoordinate.
virtual void	SetPosition (float x, float y)
	Get the PositionCoordinate instance of vtkCoordinate.
virtual float *	GetPosition ()
	Get the PositionCoordinate instance of vtkCoordinate.
virtual vtkCoordinate *	GetPosition2Coordinate ()
	Access the Position2 instance variable.
virtual void	SetPosition2 (float x[2])
	Access the Position2 instance variable.
virtual void	SetPosition2 (float x, float y)
	Access the Position2 instance variable.
virtual float *	GetPosition2 ()
	Access the Position2 instance variable.
void	SetWidth (double w)
	Set/Get the height and width of the Actor2D.
double	GetWidth ()
	Set/Get the height and width of the Actor2D.
void	SetHeight (double h)
	Set/Get the height and width of the Actor2D.
double	GetHeight ()
	Set/Get the height and width of the Actor2D.
Public Member Functions inherited from vtkProp
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkProp *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual void	GetActors (vtkPropCollection *)
	For some exporters and other other operations we must be able to collect all the actors or volumes.
virtual void	GetActors2D (vtkPropCollection *)
virtual void	GetVolumes (vtkPropCollection *)
virtual void	Pick ()
	Method fires PickEvent if the prop is picked.
virtual vtkMTimeType	GetRedrawMTime ()
	Return the mtime of anything that would cause the rendered image to appear differently.
virtual double *	GetBounds ()
	Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).
virtual void	ShallowCopy (vtkProp *prop)
	Shallow copy of this vtkProp.
virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
	These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering.
virtual vtkMatrix4x4 *	GetMatrix ()
virtual bool	HasKeys (vtkInformation *requiredKeys)
	Tells if the prop has all the required keys.
virtual int	RenderOpaqueGeometry (vtkViewport *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS All concrete subclasses must be able to render themselves.
virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)
virtual int	RenderVolumetricGeometry (vtkViewport *)
virtual int	RenderOverlay (vtkViewport *)
virtual bool	RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys)
	Render the opaque geometry only if the prop has all the requiredKeys.
virtual bool	RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys)
	Render the translucent polygonal geometry only if the prop has all the requiredKeys.
virtual bool	RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys)
	Render the volumetric geometry only if the prop has all the requiredKeys.
virtual bool	RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys)
	Render in the overlay of the viewport only if the prop has all the requiredKeys.
virtual vtkTypeBool	HasTranslucentPolygonalGeometry ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some translucent polygonal geometry? This method is called during the rendering process to know if there is some translucent polygonal geometry.
virtual vtkTypeBool	HasOpaqueGeometry ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some opaque geometry? This method is called during the rendering process to know if there is some opaque geometry.
virtual void	ReleaseGraphicsResources (vtkWindow *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor.
virtual double	GetEstimatedRenderTime (vtkViewport *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS The EstimatedRenderTime may be used to select between different props, for example in LODProp it is used to select the level-of-detail.
virtual double	GetEstimatedRenderTime ()
virtual void	SetEstimatedRenderTime (double t)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS This method is used by, for example, the vtkLODProp3D in order to initialize the estimated render time at start-up to some user defined value.
virtual void	RestoreEstimatedRenderTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS When the EstimatedRenderTime is first set to 0.0 (in the SetAllocatedRenderTime method) the old value is saved.
virtual void	AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS This method is intended to allow the renderer to add to the EstimatedRenderTime in props that require information that the renderer has in order to do this.
void	SetRenderTimeMultiplier (double t)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Get/Set the multiplier for the render time.
virtual double	GetRenderTimeMultiplier ()
virtual void	BuildPaths (vtkAssemblyPaths *paths, vtkAssemblyPath *path)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used to construct assembly paths and perform part traversal.
virtual bool	GetSupportsSelection ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection.
virtual void	ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
	allows a prop to update a selections color buffers
virtual void	SetVisibility (vtkTypeBool)
	Set/Get visibility of this vtkProp.
virtual vtkTypeBool	GetVisibility ()
	Set/Get visibility of this vtkProp.
virtual void	VisibilityOn ()
	Set/Get visibility of this vtkProp.
virtual void	VisibilityOff ()
	Set/Get visibility of this vtkProp.
virtual void	SetPickable (vtkTypeBool)
	Set/Get the pickable instance variable.
virtual vtkTypeBool	GetPickable ()
	Set/Get the pickable instance variable.
virtual void	PickableOn ()
	Set/Get the pickable instance variable.
virtual void	PickableOff ()
	Set/Get the pickable instance variable.
virtual void	SetDragable (vtkTypeBool)
	Set/Get the value of the dragable instance variable.
virtual vtkTypeBool	GetDragable ()
	Set/Get the value of the dragable instance variable.
virtual void	DragableOn ()
	Set/Get the value of the dragable instance variable.
virtual void	DragableOff ()
	Set/Get the value of the dragable instance variable.
virtual void	SetUseBounds (bool)
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().
virtual bool	GetUseBounds ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().
virtual void	UseBoundsOn ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().
virtual void	UseBoundsOff ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().
virtual void	InitPathTraversal ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).
virtual vtkAssemblyPath *	GetNextPath ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).
virtual int	GetNumberOfPaths ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).
virtual vtkInformation *	GetPropertyKeys ()
	Set/Get property keys.
virtual void	SetPropertyKeys (vtkInformation *keys)
	Set/Get property keys.
virtual void	SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS The renderer may use the allocated rendering time to determine how to render this actor.
virtual double	GetAllocatedRenderTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.
virtual int	GetNumberOfConsumers ()
	Get the number of consumers.
void	AddConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.
void	RemoveConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.
vtkObject *	GetConsumer (int i)
	Add or remove or get or check a consumer,.
int	IsConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.
virtual void	SetShaderProperty (vtkShaderProperty *property)
	Set/Get the shader property.
virtual vtkShaderProperty *	GetShaderProperty ()
	Set/Get the shader property.
virtual bool	IsRenderingTranslucentPolygonalGeometry ()
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)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
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.
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
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.
virtual 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.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)
static vtkXYPlotActor *	SafeDownCast (vtkObjectBase *o)
static vtkXYPlotActor *	New ()
	Instantiate object with autorange computation; bold, italic, and shadows on; arial font family; the number of labels set to 5 for the x and y axes; a label format of "%-#6.3g"; and x coordinates computed from point ids.
Static Public Member Functions inherited from vtkActor2D
static vtkTypeBool	IsTypeOf (const char *type)
static vtkActor2D *	SafeDownCast (vtkObjectBase *o)
static vtkActor2D *	New ()
	Creates an actor2D with the following defaults: position (0,0) (coordinate system is viewport); at layer 0.
Static Public Member Functions inherited from vtkProp
static vtkTypeBool	IsTypeOf (const char *type)
static vtkProp *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey *	GeneralTextureUnit ()
	Optional Key Indicating the texture unit for general texture mapping Old OpenGL was a state machine where you would push or pop items.
static vtkInformationDoubleVectorKey *	GeneralTextureTransform ()
	Optional Key Indicating the texture transform for general texture mapping Old OpenGL was a state machine where you would push or pop items.
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 (int 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 int	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
	vtkXYPlotActor ()
	~vtkXYPlotActor () override
void	InitializeEntries ()
void	ComputeXRange (double range[2], double *lengths)
void	ComputeYRange (double range[2])
void	ComputeDORange (double xrange[2], double yrange[2], double *lengths)
virtual void	CreatePlotData (int *pos, int *pos2, double xRange[2], double yRange[2], double *norms, int numDS, int numDO)
void	PlaceAxes (vtkViewport *viewport, const int *size, int pos[2], int pos2[2])
void	GenerateClipPlanes (int *pos, int *pos2)
double	ComputeGlyphScale (int i, int *pos, int *pos2)
void	ClipPlotData (int *pos, int *pos2, vtkPolyData *pd)
double *	TransformPoint (int pos[2], int pos2[2], double x[3], double xNew[3])
Protected Member Functions inherited from vtkActor2D
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkActor2D ()
	~vtkActor2D () override
Protected Member Functions inherited from vtkProp
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkProp ()
	~vtkProp () 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.
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 *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkXYPlotActorConnections *	InputConnectionHolder
char **	SelectedInputScalars
vtkIntArray *	SelectedInputScalarsComponent
vtkXYPlotActorConnections *	DataObjectInputConnectionHolder
char *	Title
char *	XTitle
vtkTextActor *	YTitleActor
int	XValues
int	NumberOfXLabels
int	NumberOfYLabels
vtkTypeBool	Logx
char *	XLabelFormat
char *	YLabelFormat
double	XRange [2]
double	YRange [2]
double	XComputedRange [2]
double	YComputedRange [2]
int	Border
vtkTypeBool	PlotLines
vtkTypeBool	PlotPoints
vtkTypeBool	PlotCurveLines
vtkTypeBool	PlotCurvePoints
vtkTypeBool	ExchangeAxes
vtkTypeBool	ReverseXAxis
vtkTypeBool	ReverseYAxis
int	AdjustXLabels
int	AdjustYLabels
vtkTypeBool	AdjustTitlePosition
double	TitlePosition [2]
int	AdjustTitlePositionMode
vtkTextMapper *	TitleMapper
vtkActor2D *	TitleActor
vtkTextProperty *	TitleTextProperty
vtkAxisActor2D *	XAxis
vtkAxisActor2D *	YAxis
vtkTextProperty *	AxisTitleTextProperty
vtkTextProperty *	AxisLabelTextProperty
double	ViewportCoordinate [2]
double	PlotCoordinate [2]
int	DataObjectPlotMode
vtkIntArray *	XComponent
vtkIntArray *	YComponent
vtkIntArray *	LinesOn
vtkIntArray *	PointsOn
int	NumberOfInputs
vtkPolyData **	PlotData
vtkGlyph2D **	PlotGlyph
vtkAppendPolyData **	PlotAppend
vtkPolyDataMapper2D **	PlotMapper
vtkActor2D **	PlotActor
vtkTypeBool	Legend
double	LegendPosition [2]
double	LegendPosition2 [2]
vtkLegendBoxActor *	LegendActor
vtkGlyphSource2D *	GlyphSource
vtkPlanes *	ClipPlanes
double	GlyphSize
vtkTypeBool	ChartBox
vtkPolyData *	ChartBoxPolyData
vtkPolyDataMapper2D *	ChartBoxMapper
vtkActor2D *	ChartBoxActor
vtkTypeBool	ChartBorder
vtkPolyData *	ChartBorderPolyData
vtkPolyDataMapper2D *	ChartBorderMapper
vtkActor2D *	ChartBorderActor
vtkTypeBool	ShowReferenceXLine
vtkTypeBool	ShowReferenceYLine
double	ReferenceXValue
double	ReferenceYValue
vtkPolyData *	ReferenceLinesPolyData
vtkPolyDataMapper2D *	ReferenceLinesMapper
vtkActor2D *	ReferenceLinesActor
int	CachedSize [2]
vtkTimeStamp	BuildTime
vtkSmartPointer< vtkDoubleArray >	ActiveCurve
int	YAxisTitleSize
int	ActiveCurveIndex
int	PlotColorIndex
Protected Attributes inherited from vtkActor2D
vtkMapper2D *	Mapper
int	LayerNumber
vtkProperty2D *	Property
vtkCoordinate *	PositionCoordinate
vtkCoordinate *	Position2Coordinate
Protected Attributes inherited from vtkProp
vtkTypeBool	Visibility
vtkTypeBool	Pickable
vtkTypeBool	Dragable
bool	UseBounds
double	AllocatedRenderTime
double	EstimatedRenderTime
double	SavedEstimatedRenderTime
double	RenderTimeMultiplier
int	NumberOfConsumers
vtkObject **	Consumers
vtkAssemblyPaths *	Paths
vtkInformation *	PropertyKeys
vtkShaderProperty *	ShaderProperty
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

generate an x-y plot from input dataset(s) or field data

vtkXYPlotActor creates an x-y plot of data from one or more input data sets or field data. The class plots dataset scalar values (y-axis) against the points (x-axis). The x-axis values are generated by taking the point ids, computing a cumulative arc length, or a normalized arc length. More than one input data set can be specified to generate multiple plots. Alternatively, if field data is supplied as input, the class plots one component against another. (The user must specify which component to use as the x-axis and which for the y-axis.)

To use this class to plot dataset(s), you must specify one or more input datasets containing scalar and point data. You'll probably also want to invoke a method to control how the point coordinates are converted into x values (by default point ids are used).

To use this class to plot field data, you must specify one or more input data objects with its associated field data. You'll also want to specify which component to use as the x-axis and which to use as the y-axis. Note that when plotting field data, the x and y values are used directly (i.e., there are no options to normalize the components).

Once you've set up the plot, you'll want to position it. The PositionCoordinate defines the lower-left location of the x-y plot (specified in normalized viewport coordinates) and the Position2Coordinate define the upper-right corner. (Note: the Position2Coordinate is relative to PositionCoordinate, so you can move the vtkXYPlotActor around the viewport by setting just the PositionCoordinate.) The combination of the two position coordinates specifies a rectangle in which the plot will lie.

Optional features include the ability to specify axes labels, label format and plot title. You can also manually specify the x and y plot ranges (by default they are computed automatically). The Border instance variable is used to create space between the boundary of the plot window (specified by PositionCoordinate and Position2Coordinate) and the plot itself.

The font property of the plot title can be modified through the TitleTextProperty attribute. The font property of the axes titles and labels can be modified through the AxisTitleTextProperty and AxisLabelTextProperty attributes. You may also use the GetXAxisActor2D or GetYAxisActor2D methods to access each individual axis actor to modify their font properties. In the same way, the GetLegendBoxActor method can be used to access the legend box actor to modify its font properties.

There are several advanced features as well. You can assign per curve properties (such as color and a plot symbol). (Note that each input dataset and/or data object creates a single curve.) Another option is to add a plot legend that graphically indicates the correspondence between the curve, curve symbols, and the data source. You can also exchange the x and y axes if you prefer you plot orientation that way.

Warning

If you are interested in plotting something other than scalar data, you can use the vtk data shuffling filters (e.g., vtkAttributeDataToFieldDataFilter and vtkFieldDataToAttributeDataFilter) to convert the data into scalar data and/or points.

Thanks:

This class was written by: Will Schroeder, Jim Miller, Charles Law, Sebastien Barre, Amy Squillacote, Ken Martin, Mathieu Malaterre, Jeff Lee, Francois Finet, Julien Bertel, Claire Guilbaud, and Philippe Pebay

See also

vtkActor2D vtkTextMapper vtkScalarBarActor vtkAxisActor2D vtkCubeAxesActor2D vtkAttributeDataToFieldDataFilter vtkFieldDataToAttributeDataFilter vtkTextProperty

Online Examples:

XYPlot

Definition at line 146 of file vtkXYPlotActor.h.

Member Typedef Documentation

Superclass

typedef vtkActor2D vtkXYPlotActor::Superclass

Definition at line 149 of file vtkXYPlotActor.h.

Member Enumeration Documentation

Alignment

enum vtkXYPlotActor::Alignment

Enumerator
AlignLeft
AlignRight
AlignHCenter
AlignTop
AlignBottom
AlignVCenter
AlignAxisLeft
AlignAxisRight
AlignAxisHCenter
AlignAxisTop
AlignAxisBottom
AlignAxisVCenter

Definition at line 495 of file vtkXYPlotActor.h.

Constructor & Destructor Documentation

vtkXYPlotActor()

vtkXYPlotActor::vtkXYPlotActor ( )

protected

~vtkXYPlotActor()

vtkXYPlotActor::~vtkXYPlotActor ( )

overrideprotected

Member Function Documentation

IsTypeOf()

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

static

IsA()

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

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkXYPlotActor::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkActor2D.

NewInstance()

vtkXYPlotActor * vtkXYPlotActor::NewInstance

(

)

const

PrintSelf()

void vtkXYPlotActor::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 vtkObject.

New()

static vtkXYPlotActor * vtkXYPlotActor::New ( )

static

Instantiate object with autorange computation; bold, italic, and shadows on; arial font family; the number of labels set to 5 for the x and y axes; a label format of "%-#6.3g"; and x coordinates computed from point ids.

AddDataSetInput() [1/2]

void vtkXYPlotActor::AddDataSetInput	(	vtkDataSet *	ds,
		const char *	arrayName,
		int	component
	)

Add a dataset to the list of data to append.

The array name specifies which point array to plot. The array must be a vtkDataArray subclass, i.e. a numeric array. If the array name is NULL, then the default scalars are used. The array can have multiple components, but only the first component is ploted. Note that AddInputDataSet() does not setup a pipeline connection whereas AddInputConnection() does.

AddDataSetInput() [2/2]

void vtkXYPlotActor::AddDataSetInput ( vtkDataSet *  ds )

inline

Add a dataset to the list of data to append.

The array name specifies which point array to plot. The array must be a vtkDataArray subclass, i.e. a numeric array. If the array name is NULL, then the default scalars are used. The array can have multiple components, but only the first component is ploted. Note that AddInputDataSet() does not setup a pipeline connection whereas AddInputConnection() does.

Definition at line 175 of file vtkXYPlotActor.h.

AddDataSetInputConnection() [1/2]

void vtkXYPlotActor::AddDataSetInputConnection	(	vtkAlgorithmOutput *	in,
		const char *	arrayName,
		int	component
	)

Add a dataset to the list of data to append.

The array name specifies which point array to plot. The array must be a vtkDataArray subclass, i.e. a numeric array. If the array name is NULL, then the default scalars are used. The array can have multiple components, but only the first component is ploted. Note that AddInputDataSet() does not setup a pipeline connection whereas AddInputConnection() does.

AddDataSetInputConnection() [2/2]

void vtkXYPlotActor::AddDataSetInputConnection ( vtkAlgorithmOutput *  in )

inline

Add a dataset to the list of data to append.

The array name specifies which point array to plot. The array must be a vtkDataArray subclass, i.e. a numeric array. If the array name is NULL, then the default scalars are used. The array can have multiple components, but only the first component is ploted. Note that AddInputDataSet() does not setup a pipeline connection whereas AddInputConnection() does.

Definition at line 177 of file vtkXYPlotActor.h.

RemoveDataSetInput() [1/2]

void vtkXYPlotActor::RemoveDataSetInput	(	vtkDataSet *	ds,
		const char *	arrayName,
		int	component
	)

Remove a dataset from the list of data to append.

RemoveDataSetInput() [2/2]

void vtkXYPlotActor::RemoveDataSetInput ( vtkDataSet *  ds )

inline

Remove a dataset from the list of data to append.

Definition at line 188 of file vtkXYPlotActor.h.

RemoveDataSetInputConnection() [1/2]

void vtkXYPlotActor::RemoveDataSetInputConnection	(	vtkAlgorithmOutput *	in,
		const char *	arrayName,
		int	component
	)

Remove a dataset from the list of data to append.

RemoveDataSetInputConnection() [2/2]

void vtkXYPlotActor::RemoveDataSetInputConnection ( vtkAlgorithmOutput *  in )

inline

Remove a dataset from the list of data to append.

Definition at line 190 of file vtkXYPlotActor.h.

RemoveAllDataSetInputConnections()

void vtkXYPlotActor::RemoveAllDataSetInputConnections

(

)

This removes all of the data set inputs, but does not change the data object inputs.

SetPointComponent()

void vtkXYPlotActor::SetPointComponent	(	int	i,
		int	comp
	)

If plotting points by value, which component to use to determine the value.

This sets a value per each input dataset (i.e., the ith dataset).

GetPointComponent()

int vtkXYPlotActor::GetPointComponent

(

int

i

)

If plotting points by value, which component to use to determine the value.

This sets a value per each input dataset (i.e., the ith dataset).

SetXValues()

virtual void vtkXYPlotActor::SetXValues ( int  )

virtual

Specify how the independent (x) variable is computed from the points.

The independent variable can be the scalar/point index (i.e., point id), the accumulated arc length along the points, the normalized arc length, or by component value. If plotting datasets (e.g., points), the value that is used is specified by the PointComponent ivar. (Note: these methods also control how field data is plotted. Field data is usually plotted by value or index, if plotting length 1-dimensional length measures are used.)

GetXValues()

virtual int vtkXYPlotActor::GetXValues ( )

virtual

Specify how the independent (x) variable is computed from the points.

The independent variable can be the scalar/point index (i.e., point id), the accumulated arc length along the points, the normalized arc length, or by component value. If plotting datasets (e.g., points), the value that is used is specified by the PointComponent ivar. (Note: these methods also control how field data is plotted. Field data is usually plotted by value or index, if plotting length 1-dimensional length measures are used.)

SetXValuesToIndex()

void vtkXYPlotActor::SetXValuesToIndex ( )

inline

Specify how the independent (x) variable is computed from the points.

The independent variable can be the scalar/point index (i.e., point id), the accumulated arc length along the points, the normalized arc length, or by component value. If plotting datasets (e.g., points), the value that is used is specified by the PointComponent ivar. (Note: these methods also control how field data is plotted. Field data is usually plotted by value or index, if plotting length 1-dimensional length measures are used.)

Definition at line 225 of file vtkXYPlotActor.h.

SetXValuesToArcLength()

void vtkXYPlotActor::SetXValuesToArcLength ( )

inline

Specify how the independent (x) variable is computed from the points.

The independent variable can be the scalar/point index (i.e., point id), the accumulated arc length along the points, the normalized arc length, or by component value. If plotting datasets (e.g., points), the value that is used is specified by the PointComponent ivar. (Note: these methods also control how field data is plotted. Field data is usually plotted by value or index, if plotting length 1-dimensional length measures are used.)

Definition at line 226 of file vtkXYPlotActor.h.

SetXValuesToNormalizedArcLength()

void vtkXYPlotActor::SetXValuesToNormalizedArcLength ( )

inline

Specify how the independent (x) variable is computed from the points.

The independent variable can be the scalar/point index (i.e., point id), the accumulated arc length along the points, the normalized arc length, or by component value. If plotting datasets (e.g., points), the value that is used is specified by the PointComponent ivar. (Note: these methods also control how field data is plotted. Field data is usually plotted by value or index, if plotting length 1-dimensional length measures are used.)

Definition at line 227 of file vtkXYPlotActor.h.

SetXValuesToValue()

void vtkXYPlotActor::SetXValuesToValue ( )

inline

Specify how the independent (x) variable is computed from the points.

The independent variable can be the scalar/point index (i.e., point id), the accumulated arc length along the points, the normalized arc length, or by component value. If plotting datasets (e.g., points), the value that is used is specified by the PointComponent ivar. (Note: these methods also control how field data is plotted. Field data is usually plotted by value or index, if plotting length 1-dimensional length measures are used.)

Definition at line 228 of file vtkXYPlotActor.h.

GetXValuesAsString()

const char * vtkXYPlotActor::GetXValuesAsString

(

)

Specify how the independent (x) variable is computed from the points.

The independent variable can be the scalar/point index (i.e., point id), the accumulated arc length along the points, the normalized arc length, or by component value. If plotting datasets (e.g., points), the value that is used is specified by the PointComponent ivar. (Note: these methods also control how field data is plotted. Field data is usually plotted by value or index, if plotting length 1-dimensional length measures are used.)

AddDataObjectInput()

void vtkXYPlotActor::AddDataObjectInput

(

vtkDataObject *

in

)

Add a data object to the list of data to display.

AddDataObjectInputConnection()

void vtkXYPlotActor::AddDataObjectInputConnection

(

vtkAlgorithmOutput *

alg

)

Add a data object to the list of data to display.

RemoveDataObjectInputConnection()

void vtkXYPlotActor::RemoveDataObjectInputConnection

(

vtkAlgorithmOutput *

aout

)

Remove a dataset from the list of data to display.

RemoveDataObjectInput()

void vtkXYPlotActor::RemoveDataObjectInput

(

vtkDataObject *

in

)

Remove a dataset from the list of data to display.

SetDataObjectPlotMode()

virtual void vtkXYPlotActor::SetDataObjectPlotMode ( int  )

virtual

Indicate whether to plot rows or columns.

If plotting rows, then the dependent variables is taken from a specified row, versus rows (y).

GetDataObjectPlotMode()

virtual int vtkXYPlotActor::GetDataObjectPlotMode ( )

virtual

Indicate whether to plot rows or columns.

If plotting rows, then the dependent variables is taken from a specified row, versus rows (y).

SetDataObjectPlotModeToRows()

void vtkXYPlotActor::SetDataObjectPlotModeToRows ( )

inline

Indicate whether to plot rows or columns.

If plotting rows, then the dependent variables is taken from a specified row, versus rows (y).

Definition at line 261 of file vtkXYPlotActor.h.

SetDataObjectPlotModeToColumns()

void vtkXYPlotActor::SetDataObjectPlotModeToColumns ( )

inline

Indicate whether to plot rows or columns.

If plotting rows, then the dependent variables is taken from a specified row, versus rows (y).

Definition at line 262 of file vtkXYPlotActor.h.

GetDataObjectPlotModeAsString()

const char * vtkXYPlotActor::GetDataObjectPlotModeAsString

(

)

Indicate whether to plot rows or columns.

If plotting rows, then the dependent variables is taken from a specified row, versus rows (y).

SetDataObjectXComponent()

void vtkXYPlotActor::SetDataObjectXComponent	(	int	i,
		int	comp
	)

Specify which component of the input data object to use as the independent variable for the ith input data object.

(This ivar is ignored if plotting the index.) Note that the value is interpreted differently depending on DataObjectPlotMode. If the mode is Rows, then the value of DataObjectXComponent is the row number; otherwise it's the column number.

GetDataObjectXComponent()

int vtkXYPlotActor::GetDataObjectXComponent

(

int

i

)

Specify which component of the input data object to use as the independent variable for the ith input data object.

(This ivar is ignored if plotting the index.) Note that the value is interpreted differently depending on DataObjectPlotMode. If the mode is Rows, then the value of DataObjectXComponent is the row number; otherwise it's the column number.

SetDataObjectYComponent()

void vtkXYPlotActor::SetDataObjectYComponent	(	int	i,
		int	comp
	)

Specify which component of the input data object to use as the dependent variable for the ith input data object.

(This ivar is ignored if plotting the index.) Note that the value is interpreted differently depending on DataObjectPlotMode. If the mode is Rows, then the value of DataObjectYComponent is the row number; otherwise it's the column number.

GetDataObjectYComponent()

int vtkXYPlotActor::GetDataObjectYComponent

(

int

i

)

Specify which component of the input data object to use as the dependent variable for the ith input data object.

(This ivar is ignored if plotting the index.) Note that the value is interpreted differently depending on DataObjectPlotMode. If the mode is Rows, then the value of DataObjectYComponent is the row number; otherwise it's the column number.

SetPlotColor() [1/2]

void vtkXYPlotActor::SetPlotColor	(	int	i,
		double	r,
		double	g,
		double	b
	)

SetPlotColor() [2/2]

void vtkXYPlotActor::SetPlotColor ( int  i, const double  color[3]  )

inline

Definition at line 299 of file vtkXYPlotActor.h.

GetPlotColor()

double * vtkXYPlotActor::GetPlotColor

(

int

i

)

SetPlotSymbol()

void vtkXYPlotActor::SetPlotSymbol	(	int	i,
		vtkPolyData *	input
	)

GetPlotSymbol()

vtkPolyData * vtkXYPlotActor::GetPlotSymbol

(

int

i

)

SetPlotLabel()

void vtkXYPlotActor::SetPlotLabel	(	int	i,
		const char *	label
	)

GetPlotLabel()

const char * vtkXYPlotActor::GetPlotLabel

(

int

i

)

GetPlotCurvePoints()

virtual vtkTypeBool vtkXYPlotActor::GetPlotCurvePoints ( )

virtual

SetPlotCurvePoints()

virtual void vtkXYPlotActor::SetPlotCurvePoints ( vtkTypeBool  )

virtual

PlotCurvePointsOn()

virtual void vtkXYPlotActor::PlotCurvePointsOn ( )

virtual

PlotCurvePointsOff()

virtual void vtkXYPlotActor::PlotCurvePointsOff ( )

virtual

GetPlotCurveLines()

virtual vtkTypeBool vtkXYPlotActor::GetPlotCurveLines ( )

virtual

SetPlotCurveLines()

virtual void vtkXYPlotActor::SetPlotCurveLines ( vtkTypeBool  )

virtual

PlotCurveLinesOn()

virtual void vtkXYPlotActor::PlotCurveLinesOn ( )

virtual

PlotCurveLinesOff()

virtual void vtkXYPlotActor::PlotCurveLinesOff ( )

virtual

SetPlotLines() [1/2]

void vtkXYPlotActor::SetPlotLines	(	int	i,
		int
	)

GetPlotLines() [1/2]

int vtkXYPlotActor::GetPlotLines

(

int

i

)

SetPlotPoints() [1/2]

void vtkXYPlotActor::SetPlotPoints	(	int	i,
		int
	)

GetPlotPoints() [1/2]

int vtkXYPlotActor::GetPlotPoints

(

int

i

)

SetExchangeAxes()

virtual void vtkXYPlotActor::SetExchangeAxes ( vtkTypeBool  )

virtual

Enable/Disable exchange of the x-y axes (i.e., what was x becomes y, and vice-versa).

Exchanging axes affects the labeling as well.

GetExchangeAxes()

virtual vtkTypeBool vtkXYPlotActor::GetExchangeAxes ( )

virtual

Enable/Disable exchange of the x-y axes (i.e., what was x becomes y, and vice-versa).

Exchanging axes affects the labeling as well.

ExchangeAxesOn()

virtual void vtkXYPlotActor::ExchangeAxesOn ( )

virtual

Enable/Disable exchange of the x-y axes (i.e., what was x becomes y, and vice-versa).

Exchanging axes affects the labeling as well.

ExchangeAxesOff()

virtual void vtkXYPlotActor::ExchangeAxesOff ( )

virtual

Enable/Disable exchange of the x-y axes (i.e., what was x becomes y, and vice-versa).

Exchanging axes affects the labeling as well.

SetReverseXAxis()

virtual void vtkXYPlotActor::SetReverseXAxis ( vtkTypeBool  )

virtual

Normally the x-axis is plotted from minimum to maximum.

Setting this instance variable causes the x-axis to be plotted from maximum to minimum. Note that boolean always applies to the x-axis even if ExchangeAxes is set.

GetReverseXAxis()

virtual vtkTypeBool vtkXYPlotActor::GetReverseXAxis ( )

virtual

Normally the x-axis is plotted from minimum to maximum.

Setting this instance variable causes the x-axis to be plotted from maximum to minimum. Note that boolean always applies to the x-axis even if ExchangeAxes is set.

ReverseXAxisOn()

virtual void vtkXYPlotActor::ReverseXAxisOn ( )

virtual

Normally the x-axis is plotted from minimum to maximum.

Setting this instance variable causes the x-axis to be plotted from maximum to minimum. Note that boolean always applies to the x-axis even if ExchangeAxes is set.

ReverseXAxisOff()

virtual void vtkXYPlotActor::ReverseXAxisOff ( )

virtual

Normally the x-axis is plotted from minimum to maximum.

Setting this instance variable causes the x-axis to be plotted from maximum to minimum. Note that boolean always applies to the x-axis even if ExchangeAxes is set.

SetReverseYAxis()

virtual void vtkXYPlotActor::SetReverseYAxis ( vtkTypeBool  )

virtual

Normally the y-axis is plotted from minimum to maximum.

Setting this instance variable causes the y-axis to be plotted from maximum to minimum. Note that boolean always applies to the y-axis even if ExchangeAxes is set.

GetReverseYAxis()

virtual vtkTypeBool vtkXYPlotActor::GetReverseYAxis ( )

virtual

Normally the y-axis is plotted from minimum to maximum.

Setting this instance variable causes the y-axis to be plotted from maximum to minimum. Note that boolean always applies to the y-axis even if ExchangeAxes is set.

ReverseYAxisOn()

virtual void vtkXYPlotActor::ReverseYAxisOn ( )

virtual

Normally the y-axis is plotted from minimum to maximum.

Setting this instance variable causes the y-axis to be plotted from maximum to minimum. Note that boolean always applies to the y-axis even if ExchangeAxes is set.

ReverseYAxisOff()

virtual void vtkXYPlotActor::ReverseYAxisOff ( )

virtual

Normally the y-axis is plotted from minimum to maximum.

Setting this instance variable causes the y-axis to be plotted from maximum to minimum. Note that boolean always applies to the y-axis even if ExchangeAxes is set.

GetLegendActor()

virtual vtkLegendBoxActor * vtkXYPlotActor::GetLegendActor ( )

virtual

Retrieve handles to the legend box and glyph source.

This is useful if you would like to change the default behavior of the legend box or glyph source. For example, the default glyph can be changed from a line to a vertex plus line, etc.)

GetGlyphSource()

virtual vtkGlyphSource2D * vtkXYPlotActor::GetGlyphSource ( )

virtual

Retrieve handles to the legend box and glyph source.

This is useful if you would like to change the default behavior of the legend box or glyph source. For example, the default glyph can be changed from a line to a vertex plus line, etc.)

SetTitle()

virtual void vtkXYPlotActor::SetTitle ( const char *  )

virtual

Set/Get the title of the x-y plot.

GetTitle()

virtual char * vtkXYPlotActor::GetTitle ( )

virtual

Set/Get the title of the x-y plot.

SetXTitle()

virtual void vtkXYPlotActor::SetXTitle ( const char *  )

virtual

Set/Get the title of the x axis.

GetXTitle()

virtual char * vtkXYPlotActor::GetXTitle ( )

virtual

Set/Get the title of the x axis.

SetYTitle()

virtual void vtkXYPlotActor::SetYTitle ( const char *  )

virtual

Set/Get the title of the y axis.

GetYTitle()

char * vtkXYPlotActor::GetYTitle

(

)

Set/Get the title of the y axis.

GetXAxisActor2D()

vtkAxisActor2D * vtkXYPlotActor::GetXAxisActor2D ( )

inline

Retrieve handles to the X and Y axis (so that you can set their text properties for example)

Definition at line 399 of file vtkXYPlotActor.h.

GetYAxisActor2D()

vtkAxisActor2D * vtkXYPlotActor::GetYAxisActor2D ( )

inline

Retrieve handles to the X and Y axis (so that you can set their text properties for example)

Definition at line 400 of file vtkXYPlotActor.h.

SetXRange() [1/2]

virtual void vtkXYPlotActor::SetXRange ( double  , double    )

virtual

Set the plot range (range of independent and dependent variables) to plot.

Data outside of the range will be clipped. If the plot range of either the x or y variables is set to (v1,v2), where v1 == v2, then the range will be computed automatically. Note that the x-range values should be consistent with the way the independent variable is created (via INDEX, DISTANCE, or ARC_LENGTH).

SetXRange() [2/2]

void vtkXYPlotActor::SetXRange

(

double

[2]

)

Set the plot range (range of independent and dependent variables) to plot.

Data outside of the range will be clipped. If the plot range of either the x or y variables is set to (v1,v2), where v1 == v2, then the range will be computed automatically. Note that the x-range values should be consistent with the way the independent variable is created (via INDEX, DISTANCE, or ARC_LENGTH).

GetXRange() [1/2]

virtual double * vtkXYPlotActor::GetXRange ( )

virtual

Set the plot range (range of independent and dependent variables) to plot.

Data outside of the range will be clipped. If the plot range of either the x or y variables is set to (v1,v2), where v1 == v2, then the range will be computed automatically. Note that the x-range values should be consistent with the way the independent variable is created (via INDEX, DISTANCE, or ARC_LENGTH).

GetXRange() [2/2]

virtual void vtkXYPlotActor::GetXRange ( double  data[2] )

virtual

Set the plot range (range of independent and dependent variables) to plot.

Data outside of the range will be clipped. If the plot range of either the x or y variables is set to (v1,v2), where v1 == v2, then the range will be computed automatically. Note that the x-range values should be consistent with the way the independent variable is created (via INDEX, DISTANCE, or ARC_LENGTH).

SetYRange() [1/2]

virtual void vtkXYPlotActor::SetYRange ( double  , double    )

virtual

Set the plot range (range of independent and dependent variables) to plot.

Data outside of the range will be clipped. If the plot range of either the x or y variables is set to (v1,v2), where v1 == v2, then the range will be computed automatically. Note that the x-range values should be consistent with the way the independent variable is created (via INDEX, DISTANCE, or ARC_LENGTH).

SetYRange() [2/2]

void vtkXYPlotActor::SetYRange

(

double

[2]

)

Set the plot range (range of independent and dependent variables) to plot.

Data outside of the range will be clipped. If the plot range of either the x or y variables is set to (v1,v2), where v1 == v2, then the range will be computed automatically. Note that the x-range values should be consistent with the way the independent variable is created (via INDEX, DISTANCE, or ARC_LENGTH).

GetYRange() [1/2]

virtual double * vtkXYPlotActor::GetYRange ( )

virtual

Set the plot range (range of independent and dependent variables) to plot.

Data outside of the range will be clipped. If the plot range of either the x or y variables is set to (v1,v2), where v1 == v2, then the range will be computed automatically. Note that the x-range values should be consistent with the way the independent variable is created (via INDEX, DISTANCE, or ARC_LENGTH).

GetYRange() [2/2]

virtual void vtkXYPlotActor::GetYRange ( double  data[2] )

virtual

Set the plot range (range of independent and dependent variables) to plot.

Data outside of the range will be clipped. If the plot range of either the x or y variables is set to (v1,v2), where v1 == v2, then the range will be computed automatically. Note that the x-range values should be consistent with the way the independent variable is created (via INDEX, DISTANCE, or ARC_LENGTH).

SetPlotRange()

void vtkXYPlotActor::SetPlotRange ( double  xmin, double  ymin, double  xmax, double  ymax  )

inline

Set the plot range (range of independent and dependent variables) to plot.

Data outside of the range will be clipped. If the plot range of either the x or y variables is set to (v1,v2), where v1 == v2, then the range will be computed automatically. Note that the x-range values should be consistent with the way the independent variable is created (via INDEX, DISTANCE, or ARC_LENGTH).

Definition at line 416 of file vtkXYPlotActor.h.

SetNumberOfXLabels()

virtual void vtkXYPlotActor::SetNumberOfXLabels ( int  )

virtual

Set/Get the number of annotation labels to show along the x and y axes.

This values is a suggestion: the number of labels may vary depending on the particulars of the data. The convenience method SetNumberOfLabels() sets the number of x and y labels to the same value.

GetNumberOfXLabels()

virtual int vtkXYPlotActor::GetNumberOfXLabels ( )

virtual

Set/Get the number of annotation labels to show along the x and y axes.

This values is a suggestion: the number of labels may vary depending on the particulars of the data. The convenience method SetNumberOfLabels() sets the number of x and y labels to the same value.

SetNumberOfYLabels()

virtual void vtkXYPlotActor::SetNumberOfYLabels ( int  )

virtual

Set/Get the number of annotation labels to show along the x and y axes.

This values is a suggestion: the number of labels may vary depending on the particulars of the data. The convenience method SetNumberOfLabels() sets the number of x and y labels to the same value.

GetNumberOfYLabels()

virtual int vtkXYPlotActor::GetNumberOfYLabels ( )

virtual

Set/Get the number of annotation labels to show along the x and y axes.

This values is a suggestion: the number of labels may vary depending on the particulars of the data. The convenience method SetNumberOfLabels() sets the number of x and y labels to the same value.

SetNumberOfLabels()

void vtkXYPlotActor::SetNumberOfLabels ( int  num )

inline

Set/Get the number of annotation labels to show along the x and y axes.

This values is a suggestion: the number of labels may vary depending on the particulars of the data. The convenience method SetNumberOfLabels() sets the number of x and y labels to the same value.

Definition at line 434 of file vtkXYPlotActor.h.

SetAdjustXLabels()

void vtkXYPlotActor::SetAdjustXLabels

(

int

adjust

)

Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels.

The adjustment is based in the Range instance variable. Call GetAdjustedRange and GetAdjustedNumberOfLabels to get the adjusted range and number of labels.

GetAdjustXLabels()

virtual int vtkXYPlotActor::GetAdjustXLabels ( )

virtual

Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels.

The adjustment is based in the Range instance variable. Call GetAdjustedRange and GetAdjustedNumberOfLabels to get the adjusted range and number of labels.

SetAdjustYLabels()

void vtkXYPlotActor::SetAdjustYLabels

(

int

adjust

)

Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels.

The adjustment is based in the Range instance variable. Call GetAdjustedRange and GetAdjustedNumberOfLabels to get the adjusted range and number of labels.

GetAdjustYLabels()

virtual int vtkXYPlotActor::GetAdjustYLabels ( )

virtual

Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels.

The adjustment is based in the Range instance variable. Call GetAdjustedRange and GetAdjustedNumberOfLabels to get the adjusted range and number of labels.

SetNumberOfXMinorTicks()

void vtkXYPlotActor::SetNumberOfXMinorTicks

(

int

num

)

Set/Get the number of minor ticks in X or Y.

GetNumberOfXMinorTicks()

int vtkXYPlotActor::GetNumberOfXMinorTicks

(

)

Set/Get the number of minor ticks in X or Y.

SetNumberOfYMinorTicks()

void vtkXYPlotActor::SetNumberOfYMinorTicks

(

int

num

)

Set/Get the number of minor ticks in X or Y.

GetNumberOfYMinorTicks()

int vtkXYPlotActor::GetNumberOfYMinorTicks

(

)

Set/Get the number of minor ticks in X or Y.

SetLegend()

virtual void vtkXYPlotActor::SetLegend ( vtkTypeBool  )

virtual

Enable/Disable the creation of a legend.

If on, the legend labels will be created automatically unless the per plot legend symbol has been set.

GetLegend()

virtual vtkTypeBool vtkXYPlotActor::GetLegend ( )

virtual

Enable/Disable the creation of a legend.

If on, the legend labels will be created automatically unless the per plot legend symbol has been set.

LegendOn()

virtual void vtkXYPlotActor::LegendOn ( )

virtual

Enable/Disable the creation of a legend.

If on, the legend labels will be created automatically unless the per plot legend symbol has been set.

LegendOff()

virtual void vtkXYPlotActor::LegendOff ( )

virtual

Enable/Disable the creation of a legend.

If on, the legend labels will be created automatically unless the per plot legend symbol has been set.

SetTitlePosition() [1/2]

virtual void vtkXYPlotActor::SetTitlePosition ( double  , double    )

virtual

Set/Get the position of the title.

This has no effect if AdjustTitlePosition is true.

SetTitlePosition() [2/2]

void vtkXYPlotActor::SetTitlePosition

(

double

[2]

)

Set/Get the position of the title.

This has no effect if AdjustTitlePosition is true.

GetTitlePosition() [1/3]

virtual double * vtkXYPlotActor::GetTitlePosition ( )

virtual

Set/Get the position of the title.

This has no effect if AdjustTitlePosition is true.

GetTitlePosition() [2/3]

virtual void vtkXYPlotActor::GetTitlePosition ( double &  , double &    )

virtual

Set/Get the position of the title.

This has no effect if AdjustTitlePosition is true.

GetTitlePosition() [3/3]

virtual void vtkXYPlotActor::GetTitlePosition ( double  [2] )

virtual

Set/Get the position of the title.

This has no effect if AdjustTitlePosition is true.

SetAdjustTitlePosition()

virtual void vtkXYPlotActor::SetAdjustTitlePosition ( vtkTypeBool  )

virtual

If true, the xyplot actor will adjust the position of the title automatically to be upper-middle.

Default is true.

GetAdjustTitlePosition()

virtual vtkTypeBool vtkXYPlotActor::GetAdjustTitlePosition ( )

virtual

If true, the xyplot actor will adjust the position of the title automatically to be upper-middle.

Default is true.

AdjustTitlePositionOn()

virtual void vtkXYPlotActor::AdjustTitlePositionOn ( )

virtual

If true, the xyplot actor will adjust the position of the title automatically to be upper-middle.

Default is true.

AdjustTitlePositionOff()

virtual void vtkXYPlotActor::AdjustTitlePositionOff ( )

virtual

If true, the xyplot actor will adjust the position of the title automatically to be upper-middle.

Default is true.

SetAdjustTitlePositionMode()

virtual void vtkXYPlotActor::SetAdjustTitlePositionMode ( int  )

virtual

If AdjustTitlePosition is true, the xyplot actor will adjust the position of the title automatically depending on the given mode, the mode is a combination of the Alignment flags.

by default: vtkXYPlotActor::AlignHCenter | vtkXYPlotActor::Top | vtkXYPlotActor::AlignAxisVCenter

GetAdjustTitlePositionMode()

virtual int vtkXYPlotActor::GetAdjustTitlePositionMode ( )

virtual

If AdjustTitlePosition is true, the xyplot actor will adjust the position of the title automatically depending on the given mode, the mode is a combination of the Alignment flags.

by default: vtkXYPlotActor::AlignHCenter | vtkXYPlotActor::Top | vtkXYPlotActor::AlignAxisVCenter

SetLegendPosition() [1/2]

virtual void vtkXYPlotActor::SetLegendPosition ( double  , double    )

virtual

Use these methods to control the position of the legend.

The variables LegendPosition and LegendPosition2 define the lower-left and upper-right position of the legend. The coordinates are expressed as normalized values with respect to the rectangle defined by PositionCoordinate and Position2Coordinate. Note that LegendPosition2 is relative to LegendPosition.

SetLegendPosition() [2/2]

void vtkXYPlotActor::SetLegendPosition

(

double

[2]

)

Use these methods to control the position of the legend.

The variables LegendPosition and LegendPosition2 define the lower-left and upper-right position of the legend. The coordinates are expressed as normalized values with respect to the rectangle defined by PositionCoordinate and Position2Coordinate. Note that LegendPosition2 is relative to LegendPosition.

GetLegendPosition() [1/3]

virtual double * vtkXYPlotActor::GetLegendPosition ( )

virtual

Use these methods to control the position of the legend.

The variables LegendPosition and LegendPosition2 define the lower-left and upper-right position of the legend. The coordinates are expressed as normalized values with respect to the rectangle defined by PositionCoordinate and Position2Coordinate. Note that LegendPosition2 is relative to LegendPosition.

GetLegendPosition() [2/3]

virtual void vtkXYPlotActor::GetLegendPosition ( double &  , double &    )

virtual

Use these methods to control the position of the legend.

The variables LegendPosition and LegendPosition2 define the lower-left and upper-right position of the legend. The coordinates are expressed as normalized values with respect to the rectangle defined by PositionCoordinate and Position2Coordinate. Note that LegendPosition2 is relative to LegendPosition.

GetLegendPosition() [3/3]

virtual void vtkXYPlotActor::GetLegendPosition ( double  [2] )

virtual

Use these methods to control the position of the legend.

The variables LegendPosition and LegendPosition2 define the lower-left and upper-right position of the legend. The coordinates are expressed as normalized values with respect to the rectangle defined by PositionCoordinate and Position2Coordinate. Note that LegendPosition2 is relative to LegendPosition.

SetLegendPosition2() [1/2]

virtual void vtkXYPlotActor::SetLegendPosition2 ( double  , double    )

virtual

Use these methods to control the position of the legend.

The variables LegendPosition and LegendPosition2 define the lower-left and upper-right position of the legend. The coordinates are expressed as normalized values with respect to the rectangle defined by PositionCoordinate and Position2Coordinate. Note that LegendPosition2 is relative to LegendPosition.

SetLegendPosition2() [2/2]

void vtkXYPlotActor::SetLegendPosition2

(

double

[2]

)

Use these methods to control the position of the legend.

The variables LegendPosition and LegendPosition2 define the lower-left and upper-right position of the legend. The coordinates are expressed as normalized values with respect to the rectangle defined by PositionCoordinate and Position2Coordinate. Note that LegendPosition2 is relative to LegendPosition.

GetLegendPosition2() [1/3]

virtual double * vtkXYPlotActor::GetLegendPosition2 ( )

virtual

Use these methods to control the position of the legend.

The variables LegendPosition and LegendPosition2 define the lower-left and upper-right position of the legend. The coordinates are expressed as normalized values with respect to the rectangle defined by PositionCoordinate and Position2Coordinate. Note that LegendPosition2 is relative to LegendPosition.

GetLegendPosition2() [2/3]

virtual void vtkXYPlotActor::GetLegendPosition2 ( double &  , double &    )

virtual

Use these methods to control the position of the legend.

The variables LegendPosition and LegendPosition2 define the lower-left and upper-right position of the legend. The coordinates are expressed as normalized values with respect to the rectangle defined by PositionCoordinate and Position2Coordinate. Note that LegendPosition2 is relative to LegendPosition.

GetLegendPosition2() [3/3]

virtual void vtkXYPlotActor::GetLegendPosition2 ( double  [2] )

virtual

Use these methods to control the position of the legend.

The variables LegendPosition and LegendPosition2 define the lower-left and upper-right position of the legend. The coordinates are expressed as normalized values with respect to the rectangle defined by PositionCoordinate and Position2Coordinate. Note that LegendPosition2 is relative to LegendPosition.

SetTitleTextProperty()

virtual void vtkXYPlotActor::SetTitleTextProperty ( vtkTextProperty *  p )

virtual

Set/Get the title text property.

GetTitleTextProperty()

virtual vtkTextProperty * vtkXYPlotActor::GetTitleTextProperty ( )

virtual

Set/Get the title text property.

SetAxisTitleTextProperty()

virtual void vtkXYPlotActor::SetAxisTitleTextProperty ( vtkTextProperty *  p )

virtual

Set/Get the title text property of all axes.

Note that each axis can be controlled individually through the GetX/YAxisActor2D() methods.

GetAxisTitleTextProperty()

virtual vtkTextProperty * vtkXYPlotActor::GetAxisTitleTextProperty ( )

virtual

Set/Get the title text property of all axes.

Note that each axis can be controlled individually through the GetX/YAxisActor2D() methods.

SetAxisLabelTextProperty()

virtual void vtkXYPlotActor::SetAxisLabelTextProperty ( vtkTextProperty *  p )

virtual

Set/Get the labels text property of all axes.

Note that each axis can be controlled individually through the GetX/YAxisActor2D() methods.

GetAxisLabelTextProperty()

virtual vtkTextProperty * vtkXYPlotActor::GetAxisLabelTextProperty ( )

virtual

Set/Get the labels text property of all axes.

Note that each axis can be controlled individually through the GetX/YAxisActor2D() methods.

SetLogx()

virtual void vtkXYPlotActor::SetLogx ( vtkTypeBool  )

virtual

Enable/Disable plotting of Log of x-values.

GetLogx()

virtual vtkTypeBool vtkXYPlotActor::GetLogx ( )

virtual

Enable/Disable plotting of Log of x-values.

LogxOn()

virtual void vtkXYPlotActor::LogxOn ( )

virtual

Enable/Disable plotting of Log of x-values.

LogxOff()

virtual void vtkXYPlotActor::LogxOff ( )

virtual

Enable/Disable plotting of Log of x-values.

SetLabelFormat()

virtual void vtkXYPlotActor::SetLabelFormat ( const char *  )

virtual

Set/Get the format with which to print the labels .

This sets both X and Y label formats. GetLabelFormat() returns X label format.

GetLabelFormat()

const char * vtkXYPlotActor::GetLabelFormat ( )

inline

Set/Get the format with which to print the labels .

This sets both X and Y label formats. GetLabelFormat() returns X label format.

Definition at line 579 of file vtkXYPlotActor.h.

SetXLabelFormat()

virtual void vtkXYPlotActor::SetXLabelFormat ( const char *  )

virtual

Set/Get the format with which to print the X label.

GetXLabelFormat()

virtual char * vtkXYPlotActor::GetXLabelFormat ( )

virtual

Set/Get the format with which to print the X label.

SetYLabelFormat()

virtual void vtkXYPlotActor::SetYLabelFormat ( const char *  )

virtual

Set/Get the format with which to print the Y label.

GetYLabelFormat()

virtual char * vtkXYPlotActor::GetYLabelFormat ( )

virtual

Set/Get the format with which to print the Y label.

SetBorder()

virtual void vtkXYPlotActor::SetBorder ( int  )

virtual

Set/Get the spacing between the plot window and the plot.

The value is specified in pixels.

GetBorder()

virtual int vtkXYPlotActor::GetBorder ( )

virtual

Set/Get the spacing between the plot window and the plot.

The value is specified in pixels.

GetPlotPoints() [2/2]

virtual vtkTypeBool vtkXYPlotActor::GetPlotPoints ( )

virtual

Set/Get whether the points are rendered.

The point size can be set in the property object. This is a global flag which affects the plot only if per curve symbols are not defined.

SetPlotPoints() [2/2]

virtual void vtkXYPlotActor::SetPlotPoints ( vtkTypeBool  )

virtual

Set/Get whether the points are rendered.

The point size can be set in the property object. This is a global flag which affects the plot only if per curve symbols are not defined.

PlotPointsOn()

virtual void vtkXYPlotActor::PlotPointsOn ( )

virtual

Set/Get whether the points are rendered.

The point size can be set in the property object. This is a global flag which affects the plot only if per curve symbols are not defined.

PlotPointsOff()

virtual void vtkXYPlotActor::PlotPointsOff ( )

virtual

Set/Get whether the points are rendered.

The point size can be set in the property object. This is a global flag which affects the plot only if per curve symbols are not defined.

GetPlotLines() [2/2]

virtual vtkTypeBool vtkXYPlotActor::GetPlotLines ( )

virtual

Set/Get whether the lines are rendered.

The line width can be set in the property object.

SetPlotLines() [2/2]

virtual void vtkXYPlotActor::SetPlotLines ( vtkTypeBool  )

virtual

Set/Get whether the lines are rendered.

The line width can be set in the property object.

PlotLinesOn()

virtual void vtkXYPlotActor::PlotLinesOn ( )

virtual

Set/Get whether the lines are rendered.

The line width can be set in the property object.

PlotLinesOff()

virtual void vtkXYPlotActor::PlotLinesOff ( )

virtual

Set/Get whether the lines are rendered.

The line width can be set in the property object.

SetGlyphSize()

virtual void vtkXYPlotActor::SetGlyphSize ( double  )

virtual

Set/Get the factor that controls how big glyphs are in the plot.

The number is expressed as a fraction of the length of the diagonal of the plot bounding box.

GetGlyphSize()

virtual double vtkXYPlotActor::GetGlyphSize ( )

virtual

Set/Get the factor that controls how big glyphs are in the plot.

The number is expressed as a fraction of the length of the diagonal of the plot bounding box.

ViewportToPlotCoordinate() [1/2]

void vtkXYPlotActor::ViewportToPlotCoordinate	(	vtkViewport *	viewport,
		double &	u,
		double &	v
	)

Given a position within the viewport used by the plot, return the the plot coordinates (XAxis value, YAxis value)

ViewportToPlotCoordinate() [2/2]

void vtkXYPlotActor::ViewportToPlotCoordinate

(

vtkViewport *

viewport

)

An alternate form of ViewportToPlotCoordinate() above.

This method inputs the viewport coordinate pair (defined by the ivar ViewportCoordinate)and then stores them in the ivar PlotCoordinate.

SetPlotCoordinate() [1/2]

virtual void vtkXYPlotActor::SetPlotCoordinate ( double  , double    )

virtual

An alternate form of ViewportToPlotCoordinate() above.

This method inputs the viewport coordinate pair (defined by the ivar ViewportCoordinate)and then stores them in the ivar PlotCoordinate.

SetPlotCoordinate() [2/2]

void vtkXYPlotActor::SetPlotCoordinate

(

double

[2]

)

An alternate form of ViewportToPlotCoordinate() above.

This method inputs the viewport coordinate pair (defined by the ivar ViewportCoordinate)and then stores them in the ivar PlotCoordinate.

GetPlotCoordinate() [1/3]

virtual double * vtkXYPlotActor::GetPlotCoordinate ( )

virtual

An alternate form of ViewportToPlotCoordinate() above.

This method inputs the viewport coordinate pair (defined by the ivar ViewportCoordinate)and then stores them in the ivar PlotCoordinate.

GetPlotCoordinate() [2/3]

virtual void vtkXYPlotActor::GetPlotCoordinate ( double &  , double &    )

virtual

An alternate form of ViewportToPlotCoordinate() above.

This method inputs the viewport coordinate pair (defined by the ivar ViewportCoordinate)and then stores them in the ivar PlotCoordinate.

GetPlotCoordinate() [3/3]

virtual void vtkXYPlotActor::GetPlotCoordinate ( double  [2] )

virtual

An alternate form of ViewportToPlotCoordinate() above.

This method inputs the viewport coordinate pair (defined by the ivar ViewportCoordinate)and then stores them in the ivar PlotCoordinate.

PlotToViewportCoordinate() [1/2]

void vtkXYPlotActor::PlotToViewportCoordinate	(	vtkViewport *	viewport,
		double &	u,
		double &	v
	)

Given a plot coordinate, return the viewpoint position.

PlotToViewportCoordinate() [2/2]

void vtkXYPlotActor::PlotToViewportCoordinate

(

vtkViewport *

viewport

)

An alternate form of PlotToViewportCoordinate() above.

This method inputs the plot coordinate pair (defined in the ivar PlotCoordinate) and then stores them in the ivar ViewportCoordinate. (This method can be wrapped.)

SetViewportCoordinate() [1/2]

virtual void vtkXYPlotActor::SetViewportCoordinate ( double  , double    )

virtual

An alternate form of PlotToViewportCoordinate() above.

This method inputs the plot coordinate pair (defined in the ivar PlotCoordinate) and then stores them in the ivar ViewportCoordinate. (This method can be wrapped.)

SetViewportCoordinate() [2/2]

void vtkXYPlotActor::SetViewportCoordinate

(

double

[2]

)

An alternate form of PlotToViewportCoordinate() above.

This method inputs the plot coordinate pair (defined in the ivar PlotCoordinate) and then stores them in the ivar ViewportCoordinate. (This method can be wrapped.)

GetViewportCoordinate() [1/3]

virtual double * vtkXYPlotActor::GetViewportCoordinate ( )

virtual

An alternate form of PlotToViewportCoordinate() above.

This method inputs the plot coordinate pair (defined in the ivar PlotCoordinate) and then stores them in the ivar ViewportCoordinate. (This method can be wrapped.)

GetViewportCoordinate() [2/3]

virtual void vtkXYPlotActor::GetViewportCoordinate ( double &  , double &    )

virtual

An alternate form of PlotToViewportCoordinate() above.

This method inputs the plot coordinate pair (defined in the ivar PlotCoordinate) and then stores them in the ivar ViewportCoordinate. (This method can be wrapped.)

GetViewportCoordinate() [3/3]

virtual void vtkXYPlotActor::GetViewportCoordinate ( double  [2] )

virtual

An alternate form of PlotToViewportCoordinate() above.

This method inputs the plot coordinate pair (defined in the ivar PlotCoordinate) and then stores them in the ivar ViewportCoordinate. (This method can be wrapped.)

IsInPlot()

int vtkXYPlotActor::IsInPlot	(	vtkViewport *	viewport,
		double	u,
		double	v
	)

Is the specified viewport position within the plot area (as opposed to the region used by the plot plus the labels)?

SetChartBox()

virtual void vtkXYPlotActor::SetChartBox ( vtkTypeBool  )

virtual

Set/Get the flag that controls whether a box will be drawn/filled corresponding to the chart box.

GetChartBox()

virtual vtkTypeBool vtkXYPlotActor::GetChartBox ( )

virtual

Set/Get the flag that controls whether a box will be drawn/filled corresponding to the chart box.

ChartBoxOn()

virtual void vtkXYPlotActor::ChartBoxOn ( )

virtual

Set/Get the flag that controls whether a box will be drawn/filled corresponding to the chart box.

ChartBoxOff()

virtual void vtkXYPlotActor::ChartBoxOff ( )

virtual

Set/Get the flag that controls whether a box will be drawn/filled corresponding to the chart box.

SetChartBorder()

virtual void vtkXYPlotActor::SetChartBorder ( vtkTypeBool  )

virtual

Set/Get the flag that controls whether a box will be drawn/filled corresponding to the legend box.

GetChartBorder()

virtual vtkTypeBool vtkXYPlotActor::GetChartBorder ( )

virtual

Set/Get the flag that controls whether a box will be drawn/filled corresponding to the legend box.

ChartBorderOn()

virtual void vtkXYPlotActor::ChartBorderOn ( )

virtual

Set/Get the flag that controls whether a box will be drawn/filled corresponding to the legend box.

ChartBorderOff()

virtual void vtkXYPlotActor::ChartBorderOff ( )

virtual

Set/Get the flag that controls whether a box will be drawn/filled corresponding to the legend box.

GetChartBoxProperty()

vtkProperty2D * vtkXYPlotActor::GetChartBoxProperty ( )

inline

Get the box vtkProperty2D.

Definition at line 701 of file vtkXYPlotActor.h.

SetShowReferenceXLine()

virtual void vtkXYPlotActor::SetShowReferenceXLine ( vtkTypeBool  )

virtual

Set/Get if the X reference line is visible.

hidden by default

GetShowReferenceXLine()

virtual vtkTypeBool vtkXYPlotActor::GetShowReferenceXLine ( )

virtual

Set/Get if the X reference line is visible.

hidden by default

ShowReferenceXLineOn()

virtual void vtkXYPlotActor::ShowReferenceXLineOn ( )

virtual

Set/Get if the X reference line is visible.

hidden by default

ShowReferenceXLineOff()

virtual void vtkXYPlotActor::ShowReferenceXLineOff ( )

virtual

Set/Get if the X reference line is visible.

hidden by default

SetReferenceXValue()

virtual void vtkXYPlotActor::SetReferenceXValue ( double  )

virtual

Set/Get the value for the X reference line.

GetReferenceXValue()

virtual double vtkXYPlotActor::GetReferenceXValue ( )

virtual

Set/Get the value for the X reference line.

SetShowReferenceYLine()

virtual void vtkXYPlotActor::SetShowReferenceYLine ( vtkTypeBool  )

virtual

Set/Get if the Y reference line is visible.

hidden by default

GetShowReferenceYLine()

virtual vtkTypeBool vtkXYPlotActor::GetShowReferenceYLine ( )

virtual

Set/Get if the Y reference line is visible.

hidden by default

ShowReferenceYLineOn()

virtual void vtkXYPlotActor::ShowReferenceYLineOn ( )

virtual

Set/Get if the Y reference line is visible.

hidden by default

ShowReferenceYLineOff()

virtual void vtkXYPlotActor::ShowReferenceYLineOff ( )

virtual

Set/Get if the Y reference line is visible.

hidden by default

SetReferenceYValue()

virtual void vtkXYPlotActor::SetReferenceYValue ( double  )

virtual

Set/Get the value for the Y reference line.

GetReferenceYValue()

virtual double vtkXYPlotActor::GetReferenceYValue ( )

virtual

Set/Get the value for the Y reference line.

GetMTime()

vtkMTimeType vtkXYPlotActor::GetMTime ( )

overridevirtual

Take into account the modified time of internal helper classes.

Reimplemented from vtkObject.

PrintAsCSV()

void vtkXYPlotActor::PrintAsCSV

(

ostream &

os

)

Write the XY Ploat Actor as a CSV (comma separated value) representation.

RenderOpaqueGeometry()

int vtkXYPlotActor::RenderOpaqueGeometry ( vtkViewport *  )

overridevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.

Draw the x-y plot.

Reimplemented from vtkProp.

RenderOverlay()

int vtkXYPlotActor::RenderOverlay ( vtkViewport *  )

overridevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.

Draw the x-y plot.

Reimplemented from vtkProp.

RenderTranslucentPolygonalGeometry()

int vtkXYPlotActor::RenderTranslucentPolygonalGeometry ( vtkViewport *  )

inlineoverridevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.

Draw the x-y plot.

Reimplemented from vtkProp.

Definition at line 755 of file vtkXYPlotActor.h.

HasTranslucentPolygonalGeometry()

vtkTypeBool vtkXYPlotActor::HasTranslucentPolygonalGeometry ( )

overridevirtual

Does this prop have some translucent polygonal geometry?

Reimplemented from vtkProp.

ReleaseGraphicsResources()

void vtkXYPlotActor::ReleaseGraphicsResources ( vtkWindow *  )

overridevirtual

Release any graphics resources that are being consumed by this actor.

The parameter window could be used to determine which graphic resources to release.

Reimplemented from vtkProp.

SetXTitlePosition()

void vtkXYPlotActor::SetXTitlePosition

(

double

position

)

Set/Get the position of the title of X axis.

GetXTitlePosition()

double vtkXYPlotActor::GetXTitlePosition

(

)

Set/Get the position of the title of X axis.

SetYTitlePosition()

virtual void vtkXYPlotActor::SetYTitlePosition ( int  )

virtual

Set/Get the position of the title of Y axis.

GetYTitlePosition()

virtual int vtkXYPlotActor::GetYTitlePosition ( )

virtual

Set/Get the position of the title of Y axis.

SetYTitlePositionToTop()

void vtkXYPlotActor::SetYTitlePositionToTop ( )

inline

Set/Get the position of the title of Y axis.

Definition at line 784 of file vtkXYPlotActor.h.

SetYTitlePositionToHCenter()

void vtkXYPlotActor::SetYTitlePositionToHCenter ( )

inline

Set/Get the position of the title of Y axis.

Definition at line 785 of file vtkXYPlotActor.h.

SetYTitlePositionToVCenter()

void vtkXYPlotActor::SetYTitlePositionToVCenter ( )

inline

Set/Get the position of the title of Y axis.

Definition at line 786 of file vtkXYPlotActor.h.

SetPlotGlyphType()

virtual void vtkXYPlotActor::SetPlotGlyphType ( int  , int    )

virtual

Set plot properties.

SetLineWidth()

virtual void vtkXYPlotActor::SetLineWidth ( double  )

virtual

Set plot properties.

AddUserCurvesPoint()

virtual void vtkXYPlotActor::AddUserCurvesPoint ( double  , double  , double    )

virtual

Set plot properties.

RemoveAllActiveCurves()

virtual void vtkXYPlotActor::RemoveAllActiveCurves ( )

virtual

Set plot properties.

SetLegendBorder()

virtual void vtkXYPlotActor::SetLegendBorder ( int  )

virtual

Set legend properties.

SetLegendBox()

virtual void vtkXYPlotActor::SetLegendBox ( int  )

virtual

Set legend properties.

SetLegendUseBackground()

virtual void vtkXYPlotActor::SetLegendUseBackground ( int  )

virtual

Set legend properties.

SetLegendBackgroundColor()

virtual void vtkXYPlotActor::SetLegendBackgroundColor ( double  , double  , double    )

virtual

Set legend properties.

SetTitleColor()

virtual void vtkXYPlotActor::SetTitleColor ( double  , double  , double    )

virtual

Set title properties.

SetTitleFontFamily()

virtual void vtkXYPlotActor::SetTitleFontFamily ( int  )

virtual

Set title properties.

SetTitleBold()

virtual void vtkXYPlotActor::SetTitleBold ( int  )

virtual

Set title properties.

SetTitleItalic()

virtual void vtkXYPlotActor::SetTitleItalic ( int  )

virtual

Set title properties.

SetTitleShadow()

virtual void vtkXYPlotActor::SetTitleShadow ( int  )

virtual

Set title properties.

SetTitleFontSize()

virtual void vtkXYPlotActor::SetTitleFontSize ( int  )

virtual

Set title properties.

SetTitleJustification()

virtual void vtkXYPlotActor::SetTitleJustification ( int  )

virtual

Set title properties.

SetTitleVerticalJustification()

virtual void vtkXYPlotActor::SetTitleVerticalJustification ( int  )

virtual

Set title properties.

SetXAxisColor()

virtual void vtkXYPlotActor::SetXAxisColor ( double  , double  , double    )

virtual

Set axes properties.

SetYAxisColor()

virtual void vtkXYPlotActor::SetYAxisColor ( double  , double  , double    )

virtual

Set axes properties.

SetAxisTitleColor()

virtual void vtkXYPlotActor::SetAxisTitleColor ( double  , double  , double    )

virtual

Set axis title properties.

SetAxisTitleFontFamily()

virtual void vtkXYPlotActor::SetAxisTitleFontFamily ( int  )

virtual

Set axis title properties.

SetAxisTitleBold()

virtual void vtkXYPlotActor::SetAxisTitleBold ( int  )

virtual

Set axis title properties.

SetAxisTitleItalic()

virtual void vtkXYPlotActor::SetAxisTitleItalic ( int  )

virtual

Set axis title properties.

SetAxisTitleShadow()

virtual void vtkXYPlotActor::SetAxisTitleShadow ( int  )

virtual

Set axis title properties.

SetAxisTitleFontSize()

virtual void vtkXYPlotActor::SetAxisTitleFontSize ( int  )

virtual

Set axis title properties.

SetAxisTitleJustification()

virtual void vtkXYPlotActor::SetAxisTitleJustification ( int  )

virtual

Set axis title properties.

SetAxisTitleVerticalJustification()

virtual void vtkXYPlotActor::SetAxisTitleVerticalJustification ( int  )

virtual

Set axis title properties.

SetAxisLabelColor()

virtual void vtkXYPlotActor::SetAxisLabelColor ( double  , double  , double    )

virtual

Set axis label properties.

SetAxisLabelFontFamily()

virtual void vtkXYPlotActor::SetAxisLabelFontFamily ( int  )

virtual

Set axis label properties.

SetAxisLabelBold()

virtual void vtkXYPlotActor::SetAxisLabelBold ( int  )

virtual

Set axis label properties.

SetAxisLabelItalic()

virtual void vtkXYPlotActor::SetAxisLabelItalic ( int  )

virtual

Set axis label properties.

SetAxisLabelShadow()

virtual void vtkXYPlotActor::SetAxisLabelShadow ( int  )

virtual

Set axis label properties.

SetAxisLabelFontSize()

virtual void vtkXYPlotActor::SetAxisLabelFontSize ( int  )

virtual

Set axis label properties.

SetAxisLabelJustification()

virtual void vtkXYPlotActor::SetAxisLabelJustification ( int  )

virtual

Set axis label properties.

SetAxisLabelVerticalJustification()

virtual void vtkXYPlotActor::SetAxisLabelVerticalJustification ( int  )

virtual

Set axis label properties.

InitializeEntries()

void vtkXYPlotActor::InitializeEntries ( )

protected

ComputeXRange()

void vtkXYPlotActor::ComputeXRange ( double  range[2], double *  lengths  )

protected

ComputeYRange()

void vtkXYPlotActor::ComputeYRange ( double  range[2] )

protected

ComputeDORange()

void vtkXYPlotActor::ComputeDORange ( double  xrange[2], double  yrange[2], double *  lengths  )

protected

CreatePlotData()

virtual void vtkXYPlotActor::CreatePlotData ( int *  pos, int *  pos2, double  xRange[2], double  yRange[2], double *  norms, int  numDS, int  numDO  )

protectedvirtual

PlaceAxes()

void vtkXYPlotActor::PlaceAxes ( vtkViewport *  viewport, const int *  size, int  pos[2], int  pos2[2]  )

protected

GenerateClipPlanes()

void vtkXYPlotActor::GenerateClipPlanes ( int *  pos, int *  pos2  )

protected

ComputeGlyphScale()

double vtkXYPlotActor::ComputeGlyphScale ( int  i, int *  pos, int *  pos2  )

protected

ClipPlotData()

void vtkXYPlotActor::ClipPlotData ( int *  pos, int *  pos2, vtkPolyData *  pd  )

protected

TransformPoint()

double * vtkXYPlotActor::TransformPoint ( int  pos[2], int  pos2[2], double  x[3], double  xNew[3]  )

protected

Member Data Documentation

InputConnectionHolder

vtkXYPlotActorConnections* vtkXYPlotActor::InputConnectionHolder

protected

Definition at line 863 of file vtkXYPlotActor.h.

SelectedInputScalars

char** vtkXYPlotActor::SelectedInputScalars

protected

Definition at line 864 of file vtkXYPlotActor.h.

SelectedInputScalarsComponent

vtkIntArray* vtkXYPlotActor::SelectedInputScalarsComponent

protected

Definition at line 865 of file vtkXYPlotActor.h.

DataObjectInputConnectionHolder

vtkXYPlotActorConnections* vtkXYPlotActor::DataObjectInputConnectionHolder

protected

Definition at line 866 of file vtkXYPlotActor.h.

Title

char* vtkXYPlotActor::Title

protected

Definition at line 867 of file vtkXYPlotActor.h.

XTitle

char* vtkXYPlotActor::XTitle

protected

Definition at line 868 of file vtkXYPlotActor.h.

YTitleActor

vtkTextActor* vtkXYPlotActor::YTitleActor

protected

Definition at line 869 of file vtkXYPlotActor.h.

XValues

int vtkXYPlotActor::XValues

protected

Definition at line 870 of file vtkXYPlotActor.h.

NumberOfXLabels

int vtkXYPlotActor::NumberOfXLabels

protected

Definition at line 871 of file vtkXYPlotActor.h.

NumberOfYLabels

int vtkXYPlotActor::NumberOfYLabels

protected

Definition at line 872 of file vtkXYPlotActor.h.

Logx

vtkTypeBool vtkXYPlotActor::Logx

protected

Definition at line 873 of file vtkXYPlotActor.h.

XLabelFormat

char* vtkXYPlotActor::XLabelFormat

protected

Definition at line 874 of file vtkXYPlotActor.h.

YLabelFormat

char* vtkXYPlotActor::YLabelFormat

protected

Definition at line 875 of file vtkXYPlotActor.h.

XRange

double vtkXYPlotActor::XRange[2]

protected

Definition at line 876 of file vtkXYPlotActor.h.

YRange

double vtkXYPlotActor::YRange[2]

protected

Definition at line 877 of file vtkXYPlotActor.h.

XComputedRange

double vtkXYPlotActor::XComputedRange[2]

protected

Definition at line 878 of file vtkXYPlotActor.h.

YComputedRange

double vtkXYPlotActor::YComputedRange[2]

protected

Definition at line 879 of file vtkXYPlotActor.h.

Border

int vtkXYPlotActor::Border

protected

Definition at line 880 of file vtkXYPlotActor.h.

PlotLines

vtkTypeBool vtkXYPlotActor::PlotLines

protected

Definition at line 881 of file vtkXYPlotActor.h.

PlotPoints

vtkTypeBool vtkXYPlotActor::PlotPoints

protected

Definition at line 882 of file vtkXYPlotActor.h.

PlotCurveLines

vtkTypeBool vtkXYPlotActor::PlotCurveLines

protected

Definition at line 883 of file vtkXYPlotActor.h.

PlotCurvePoints

vtkTypeBool vtkXYPlotActor::PlotCurvePoints

protected

Definition at line 884 of file vtkXYPlotActor.h.

ExchangeAxes

vtkTypeBool vtkXYPlotActor::ExchangeAxes

protected

Definition at line 885 of file vtkXYPlotActor.h.

ReverseXAxis

vtkTypeBool vtkXYPlotActor::ReverseXAxis

protected

Definition at line 886 of file vtkXYPlotActor.h.

ReverseYAxis

vtkTypeBool vtkXYPlotActor::ReverseYAxis

protected

Definition at line 887 of file vtkXYPlotActor.h.

AdjustXLabels

int vtkXYPlotActor::AdjustXLabels

protected

Definition at line 888 of file vtkXYPlotActor.h.

AdjustYLabels

int vtkXYPlotActor::AdjustYLabels

protected

Definition at line 889 of file vtkXYPlotActor.h.

AdjustTitlePosition

vtkTypeBool vtkXYPlotActor::AdjustTitlePosition

protected

Definition at line 890 of file vtkXYPlotActor.h.

TitlePosition

double vtkXYPlotActor::TitlePosition[2]

protected

Definition at line 891 of file vtkXYPlotActor.h.

AdjustTitlePositionMode

int vtkXYPlotActor::AdjustTitlePositionMode

protected

Definition at line 892 of file vtkXYPlotActor.h.

TitleMapper

vtkTextMapper* vtkXYPlotActor::TitleMapper

protected

Definition at line 894 of file vtkXYPlotActor.h.

TitleActor

vtkActor2D* vtkXYPlotActor::TitleActor

protected

Definition at line 895 of file vtkXYPlotActor.h.

TitleTextProperty

vtkTextProperty* vtkXYPlotActor::TitleTextProperty

protected

Definition at line 896 of file vtkXYPlotActor.h.

XAxis

vtkAxisActor2D* vtkXYPlotActor::XAxis

protected

Definition at line 898 of file vtkXYPlotActor.h.

YAxis

vtkAxisActor2D* vtkXYPlotActor::YAxis

protected

Definition at line 899 of file vtkXYPlotActor.h.

AxisTitleTextProperty

vtkTextProperty* vtkXYPlotActor::AxisTitleTextProperty

protected

Definition at line 901 of file vtkXYPlotActor.h.

AxisLabelTextProperty

vtkTextProperty* vtkXYPlotActor::AxisLabelTextProperty

protected

Definition at line 902 of file vtkXYPlotActor.h.

ViewportCoordinate

double vtkXYPlotActor::ViewportCoordinate[2]

protected

Definition at line 904 of file vtkXYPlotActor.h.

PlotCoordinate

double vtkXYPlotActor::PlotCoordinate[2]

protected

Definition at line 905 of file vtkXYPlotActor.h.

DataObjectPlotMode

int vtkXYPlotActor::DataObjectPlotMode

protected

Definition at line 908 of file vtkXYPlotActor.h.

XComponent

vtkIntArray* vtkXYPlotActor::XComponent

protected

Definition at line 909 of file vtkXYPlotActor.h.

YComponent

vtkIntArray* vtkXYPlotActor::YComponent

protected

Definition at line 910 of file vtkXYPlotActor.h.

LinesOn

vtkIntArray* vtkXYPlotActor::LinesOn

protected

Definition at line 911 of file vtkXYPlotActor.h.

PointsOn

vtkIntArray* vtkXYPlotActor::PointsOn

protected

Definition at line 912 of file vtkXYPlotActor.h.

NumberOfInputs

int vtkXYPlotActor::NumberOfInputs

protected

Definition at line 917 of file vtkXYPlotActor.h.

PlotData

vtkPolyData** vtkXYPlotActor::PlotData

protected

Definition at line 918 of file vtkXYPlotActor.h.

PlotGlyph

vtkGlyph2D** vtkXYPlotActor::PlotGlyph

protected

Definition at line 919 of file vtkXYPlotActor.h.

PlotAppend

vtkAppendPolyData** vtkXYPlotActor::PlotAppend

protected

Definition at line 920 of file vtkXYPlotActor.h.

PlotMapper

vtkPolyDataMapper2D** vtkXYPlotActor::PlotMapper

protected

Definition at line 921 of file vtkXYPlotActor.h.

PlotActor

vtkActor2D** vtkXYPlotActor::PlotActor

protected

Definition at line 922 of file vtkXYPlotActor.h.

Legend

vtkTypeBool vtkXYPlotActor::Legend

protected

Definition at line 927 of file vtkXYPlotActor.h.

LegendPosition

double vtkXYPlotActor::LegendPosition[2]

protected

Definition at line 928 of file vtkXYPlotActor.h.

LegendPosition2

double vtkXYPlotActor::LegendPosition2[2]

protected

Definition at line 929 of file vtkXYPlotActor.h.

LegendActor

vtkLegendBoxActor* vtkXYPlotActor::LegendActor

protected

Definition at line 930 of file vtkXYPlotActor.h.

GlyphSource

vtkGlyphSource2D* vtkXYPlotActor::GlyphSource

protected

Definition at line 931 of file vtkXYPlotActor.h.

ClipPlanes

vtkPlanes* vtkXYPlotActor::ClipPlanes

protected

Definition at line 932 of file vtkXYPlotActor.h.

GlyphSize

double vtkXYPlotActor::GlyphSize

protected

Definition at line 933 of file vtkXYPlotActor.h.

ChartBox

vtkTypeBool vtkXYPlotActor::ChartBox

protected

Definition at line 936 of file vtkXYPlotActor.h.

ChartBoxPolyData

vtkPolyData* vtkXYPlotActor::ChartBoxPolyData

protected

Definition at line 937 of file vtkXYPlotActor.h.

ChartBoxMapper

vtkPolyDataMapper2D* vtkXYPlotActor::ChartBoxMapper

protected

Definition at line 938 of file vtkXYPlotActor.h.

ChartBoxActor

vtkActor2D* vtkXYPlotActor::ChartBoxActor

protected

Definition at line 939 of file vtkXYPlotActor.h.

ChartBorder

vtkTypeBool vtkXYPlotActor::ChartBorder

protected

Definition at line 940 of file vtkXYPlotActor.h.

ChartBorderPolyData

vtkPolyData* vtkXYPlotActor::ChartBorderPolyData

protected

Definition at line 941 of file vtkXYPlotActor.h.

ChartBorderMapper

vtkPolyDataMapper2D* vtkXYPlotActor::ChartBorderMapper

protected

Definition at line 942 of file vtkXYPlotActor.h.

ChartBorderActor

vtkActor2D* vtkXYPlotActor::ChartBorderActor

protected

Definition at line 943 of file vtkXYPlotActor.h.

ShowReferenceXLine

vtkTypeBool vtkXYPlotActor::ShowReferenceXLine

protected

Definition at line 946 of file vtkXYPlotActor.h.

ShowReferenceYLine

vtkTypeBool vtkXYPlotActor::ShowReferenceYLine

protected

Definition at line 947 of file vtkXYPlotActor.h.

ReferenceXValue

double vtkXYPlotActor::ReferenceXValue

protected

Definition at line 948 of file vtkXYPlotActor.h.

ReferenceYValue

double vtkXYPlotActor::ReferenceYValue

protected

Definition at line 949 of file vtkXYPlotActor.h.

ReferenceLinesPolyData

vtkPolyData* vtkXYPlotActor::ReferenceLinesPolyData

protected

Definition at line 951 of file vtkXYPlotActor.h.

ReferenceLinesMapper

vtkPolyDataMapper2D* vtkXYPlotActor::ReferenceLinesMapper

protected

Definition at line 952 of file vtkXYPlotActor.h.

ReferenceLinesActor

vtkActor2D* vtkXYPlotActor::ReferenceLinesActor

protected

Definition at line 953 of file vtkXYPlotActor.h.

CachedSize

int vtkXYPlotActor::CachedSize[2]

protected

Definition at line 956 of file vtkXYPlotActor.h.

BuildTime

vtkTimeStamp vtkXYPlotActor::BuildTime

protected

Definition at line 957 of file vtkXYPlotActor.h.

ActiveCurve

vtkSmartPointer<vtkDoubleArray> vtkXYPlotActor::ActiveCurve

protected

Definition at line 971 of file vtkXYPlotActor.h.

YAxisTitleSize

int vtkXYPlotActor::YAxisTitleSize

protected

Definition at line 973 of file vtkXYPlotActor.h.

ActiveCurveIndex

int vtkXYPlotActor::ActiveCurveIndex

protected

Definition at line 974 of file vtkXYPlotActor.h.

PlotColorIndex

int vtkXYPlotActor::PlotColorIndex

protected

Definition at line 975 of file vtkXYPlotActor.h.

---

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

• Rendering/Annotation/vtkXYPlotActor.h