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 Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkXYPlotActor *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

void	RemoveAllDataSetInputConnections ()

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 int	GetPlotCurvePoints ()

virtual void	SetPlotCurvePoints (int)

virtual void	PlotCurvePointsOn ()

virtual void	PlotCurvePointsOff ()

virtual int	GetPlotCurveLines ()

virtual void	SetPlotCurveLines (int)

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)

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

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

vtkProperty2D *	GetChartBoxProperty ()

unsigned long	GetMTime ()

void	PrintAsCSV (ostream &os)

virtual int	HasTranslucentPolygonalGeometry ()


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

void	AddDataSetInput (vtkDataSet *ds)

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

void	AddDataSetInputConnection (vtkAlgorithmOutput *in)


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

void	RemoveDataSetInput (vtkDataSet *ds)

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

void	RemoveDataSetInputConnection (vtkAlgorithmOutput *in)


void	SetPointComponent (int i, int comp)

int	GetPointComponent (int i)


virtual void	SetXValues (int)

virtual int	GetXValues ()

void	SetXValuesToIndex ()

void	SetXValuesToArcLength ()

void	SetXValuesToNormalizedArcLength ()

void	SetXValuesToValue ()

const char *	GetXValuesAsString ()


void	AddDataObjectInput (vtkDataObject *in)

void	AddDataObjectInputConnection (vtkAlgorithmOutput *alg)


void	RemoveDataObjectInputConnection (vtkAlgorithmOutput *aout)

void	RemoveDataObjectInput (vtkDataObject *in)


virtual void	SetDataObjectPlotMode (int)

virtual int	GetDataObjectPlotMode ()

void	SetDataObjectPlotModeToRows ()

void	SetDataObjectPlotModeToColumns ()

const char *	GetDataObjectPlotModeAsString ()


void	SetDataObjectXComponent (int i, int comp)

int	GetDataObjectXComponent (int i)


void	SetDataObjectYComponent (int i, int comp)

int	GetDataObjectYComponent (int i)


virtual void	SetExchangeAxes (int)

virtual int	GetExchangeAxes ()

virtual void	ExchangeAxesOn ()

virtual void	ExchangeAxesOff ()


virtual void	SetReverseXAxis (int)

virtual int	GetReverseXAxis ()

virtual void	ReverseXAxisOn ()

virtual void	ReverseXAxisOff ()


virtual void	SetReverseYAxis (int)

virtual int	GetReverseYAxis ()

virtual void	ReverseYAxisOn ()

virtual void	ReverseYAxisOff ()


virtual vtkLegendBoxActor *	GetLegendActor ()

virtual vtkGlyphSource2D *	GetGlyphSource ()


virtual void	SetTitle (const char *)

virtual char *	GetTitle ()


virtual void	SetXTitle (const char *)

virtual char *	GetXTitle ()


virtual void	SetYTitle (const char *)

char *	GetYTitle ()


vtkAxisActor2D *	GetXAxisActor2D ()

vtkAxisActor2D *	GetYAxisActor2D ()


virtual void	SetXRange (double, double)

void	SetXRange (double[2])

virtual double *	GetXRange ()

virtual void	GetXRange (double data[2])

virtual void	SetYRange (double, double)

void	SetYRange (double[2])

virtual double *	GetYRange ()

virtual void	GetYRange (double data[2])

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


virtual void	SetNumberOfXLabels (int)

virtual int	GetNumberOfXLabels ()

virtual void	SetNumberOfYLabels (int)

virtual int	GetNumberOfYLabels ()

void	SetNumberOfLabels (int num)


void	SetAdjustXLabels (int adjust)

virtual int	GetAdjustXLabels ()

void	SetAdjustYLabels (int adjust)

virtual int	GetAdjustYLabels ()


void	SetNumberOfXMinorTicks (int num)

int	GetNumberOfXMinorTicks ()

void	SetNumberOfYMinorTicks (int num)

int	GetNumberOfYMinorTicks ()


virtual void	SetLegend (int)

virtual int	GetLegend ()

virtual void	LegendOn ()

virtual void	LegendOff ()


virtual void	SetTitlePosition (double, double)

void	SetTitlePosition (double[2])

virtual double *	GetTitlePosition ()

virtual void	GetTitlePosition (double &, double &)

virtual void	GetTitlePosition (double[2])


virtual void	SetAdjustTitlePosition (int)

virtual int	GetAdjustTitlePosition ()

virtual void	AdjustTitlePositionOn ()

virtual void	AdjustTitlePositionOff ()


virtual void	SetAdjustTitlePositionMode (int)

virtual int	GetAdjustTitlePositionMode ()


virtual void	SetLegendPosition (double, double)

void	SetLegendPosition (double[2])

virtual double *	GetLegendPosition ()

virtual void	GetLegendPosition (double &, double &)

virtual void	GetLegendPosition (double[2])

virtual void	SetLegendPosition2 (double, double)

void	SetLegendPosition2 (double[2])

virtual double *	GetLegendPosition2 ()

virtual void	GetLegendPosition2 (double &, double &)

virtual void	GetLegendPosition2 (double[2])


virtual void	SetTitleTextProperty (vtkTextProperty *p)

virtual vtkTextProperty *	GetTitleTextProperty ()


virtual void	SetAxisTitleTextProperty (vtkTextProperty *p)

virtual vtkTextProperty *	GetAxisTitleTextProperty ()


virtual void	SetAxisLabelTextProperty (vtkTextProperty *p)

virtual vtkTextProperty *	GetAxisLabelTextProperty ()


virtual void	SetLogx (int)

virtual int	GetLogx ()

virtual void	LogxOn ()

virtual void	LogxOff ()


virtual void	SetLabelFormat (const char *)

const char *	GetLabelFormat ()


virtual void	SetXLabelFormat (const char *)

virtual char *	GetXLabelFormat ()


virtual void	SetYLabelFormat (const char *)

virtual char *	GetYLabelFormat ()


virtual void	SetBorder (int)

virtual int	GetBorder ()


virtual int	GetPlotPoints ()

virtual void	SetPlotPoints (int)

virtual void	PlotPointsOn ()

virtual void	PlotPointsOff ()


virtual int	GetPlotLines ()

virtual void	SetPlotLines (int)

virtual void	PlotLinesOn ()

virtual void	PlotLinesOff ()


virtual void	SetGlyphSize (double)

virtual double	GetGlyphSize ()


void	ViewportToPlotCoordinate (vtkViewport *viewport)

virtual void	SetPlotCoordinate (double, double)

void	SetPlotCoordinate (double[2])

virtual double *	GetPlotCoordinate ()

virtual void	GetPlotCoordinate (double &, double &)

virtual void	GetPlotCoordinate (double[2])


void	PlotToViewportCoordinate (vtkViewport *viewport)

virtual void	SetViewportCoordinate (double, double)

void	SetViewportCoordinate (double[2])

virtual double *	GetViewportCoordinate ()

virtual void	GetViewportCoordinate (double &, double &)

virtual void	GetViewportCoordinate (double[2])


virtual void	SetChartBox (int)

virtual int	GetChartBox ()

virtual void	ChartBoxOn ()

virtual void	ChartBoxOff ()


virtual void	SetChartBorder (int)

virtual int	GetChartBorder ()

virtual void	ChartBorderOn ()

virtual void	ChartBorderOff ()


virtual void	SetShowReferenceXLine (int)

virtual int	GetShowReferenceXLine ()

virtual void	ShowReferenceXLineOn ()

virtual void	ShowReferenceXLineOff ()


virtual void	SetReferenceXValue (double)

virtual double	GetReferenceXValue ()


virtual void	SetShowReferenceYLine (int)

virtual int	GetShowReferenceYLine ()

virtual void	ShowReferenceYLineOn ()

virtual void	ShowReferenceYLineOff ()


virtual void	SetReferenceYValue (double)

virtual double	GetReferenceYValue ()


int	RenderOpaqueGeometry (vtkViewport *)

int	RenderOverlay (vtkViewport *)

virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)


void	ReleaseGraphicsResources (vtkWindow *)


void	SetXTitlePosition (double position)

double	GetXTitlePosition ()


virtual void	SetYTitlePosition (int)

virtual int	GetYTitlePosition ()

void	SetYTitlePositionToTop ()

void	SetYTitlePositionToHCenter ()

void	SetYTitlePositionToVCenter ()


virtual void	SetPlotGlyphType (int, int)

virtual void	SetLineWidth (double)

virtual void	AddUserCurvesPoint (double, double, double)

virtual void	RemoveAllActiveCurves ()


virtual void	SetLegendBorder (int)

virtual void	SetLegendBox (int)

virtual void	SetLegendUseBackground (int)

virtual void	SetLegendBackgroundColor (double, double, double)


virtual void	SetTitleColor (double, double, double)

virtual void	SetTitleFontFamily (int)

virtual void	SetTitleBold (int)

virtual void	SetTitleItalic (int)

virtual void	SetTitleShadow (int)

virtual void	SetTitleFontSize (int)

virtual void	SetTitleJustification (int)

virtual void	SetTitleVerticalJustification (int)


virtual void	SetXAxisColor (double, double, double)

virtual void	SetYAxisColor (double, double, double)


virtual void	SetAxisTitleColor (double, double, double)

virtual void	SetAxisTitleFontFamily (int)

virtual void	SetAxisTitleBold (int)

virtual void	SetAxisTitleItalic (int)

virtual void	SetAxisTitleShadow (int)

virtual void	SetAxisTitleFontSize (int)

virtual void	SetAxisTitleJustification (int)

virtual void	SetAxisTitleVerticalJustification (int)


virtual void	SetAxisLabelColor (double, double, double)

virtual void	SetAxisLabelFontFamily (int)

virtual void	SetAxisLabelBold (int)

virtual void	SetAxisLabelItalic (int)

virtual void	SetAxisLabelShadow (int)

virtual void	SetAxisLabelFontSize (int)

virtual void	SetAxisLabelJustification (int)

virtual void	SetAxisLabelVerticalJustification (int)

Public Member Functions inherited from vtkActor2D
void	PrintSelf (ostream &os, vtkIndent indent)

vtkActor2D *	NewInstance () const

vtkProperty2D *	GetProperty ()

virtual void	SetProperty (vtkProperty2D *)

void	SetDisplayPosition (int, int)

virtual void	GetActors2D (vtkPropCollection *pc)

virtual void	ShallowCopy (vtkProp *prop)

virtual void	SetMapper (vtkMapper2D *mapper)

virtual vtkMapper2D *	GetMapper ()

virtual void	SetLayerNumber (int)

virtual int	GetLayerNumber ()

virtual vtkCoordinate *	GetPositionCoordinate ()

virtual void	SetPosition (float x[2])

virtual void	SetPosition (float x, float y)

virtual float *	GetPosition ()

virtual vtkCoordinate *	GetPosition2Coordinate ()

virtual void	SetPosition2 (float x[2])

virtual void	SetPosition2 (float x, float y)

virtual float *	GetPosition2 ()

void	SetWidth (double w)

double	GetWidth ()

void	SetHeight (double h)

double	GetHeight ()

virtual vtkCoordinate *	GetActualPositionCoordinate (void)

virtual vtkCoordinate *	GetActualPosition2Coordinate (void)

Public Member Functions inherited from vtkProp
vtkProp *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	Pick ()

virtual bool	HasKeys (vtkInformation *requiredKeys)

virtual void	BuildPaths (vtkAssemblyPaths paths, vtkAssemblyPath path)

virtual void	GetActors (vtkPropCollection *)

virtual void	GetVolumes (vtkPropCollection *)

virtual void	SetVisibility (int)

virtual int	GetVisibility ()

virtual void	VisibilityOn ()

virtual void	VisibilityOff ()

virtual void	SetPickable (int)

virtual int	GetPickable ()

virtual void	PickableOn ()

virtual void	PickableOff ()

virtual void	SetDragable (int)

virtual int	GetDragable ()

virtual void	DragableOn ()

virtual void	DragableOff ()

virtual unsigned long	GetRedrawMTime ()

virtual void	SetUseBounds (bool)

virtual bool	GetUseBounds ()

virtual void	UseBoundsOn ()

virtual void	UseBoundsOff ()

virtual double *	GetBounds ()

virtual void	InitPathTraversal ()

virtual vtkAssemblyPath *	GetNextPath ()

virtual int	GetNumberOfPaths ()

virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))

virtual vtkMatrix4x4 *	GetMatrix ()

virtual vtkInformation *	GetPropertyKeys ()

virtual void	SetPropertyKeys (vtkInformation *keys)

virtual int	RenderVolumetricGeometry (vtkViewport *)

virtual bool	RenderFilteredOpaqueGeometry (vtkViewport v, vtkInformation requiredKeys)

virtual bool	RenderFilteredTranslucentPolygonalGeometry (vtkViewport v, vtkInformation requiredKeys)

virtual bool	RenderFilteredVolumetricGeometry (vtkViewport v, vtkInformation requiredKeys)

virtual bool	RenderFilteredOverlay (vtkViewport v, vtkInformation requiredKeys)

virtual double	GetEstimatedRenderTime (vtkViewport *)

virtual double	GetEstimatedRenderTime ()

virtual void	SetEstimatedRenderTime (double t)

virtual void	RestoreEstimatedRenderTime ()

virtual void	AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))

virtual void	SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))

virtual double	GetAllocatedRenderTime ()

void	SetRenderTimeMultiplier (double t)

virtual double	GetRenderTimeMultiplier ()

virtual bool	GetSupportsSelection ()

virtual int	GetNumberOfConsumers ()

void	AddConsumer (vtkObject *c)

void	RemoveConsumer (vtkObject *c)

vtkObject *	GetConsumer (int i)

int	IsConsumer (vtkObject *c)

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

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

static vtkXYPlotActor *	SafeDownCast (vtkObjectBase *o)

static vtkXYPlotActor *	New ()

Static Public Member Functions inherited from vtkActor2D
static int	IsTypeOf (const char *type)

static vtkActor2D *	SafeDownCast (vtkObjectBase *o)

static vtkActor2D *	New ()

Static Public Member Functions inherited from vtkProp
static int	IsTypeOf (const char *type)

static vtkProp *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	GeneralTextureUnit ()

static vtkInformationDoubleVectorKey *	GeneralTextureTransform ()

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkXYPlotActor ()

	~vtkXYPlotActor ()

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, 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
	vtkActor2D ()

	~vtkActor2D ()

Protected Member Functions inherited from vtkProp
	vtkProp ()

	~vtkProp ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkXYPlotActorConnections *	InputConnectionHolder

char **	SelectedInputScalars

vtkIntArray *	SelectedInputScalarsComponent

vtkXYPlotActorConnections *	DataObjectInputConnectionHolder

char *	Title

char *	XTitle

vtkTextActor *	YTitleActor

int	XValues

int	NumberOfXLabels

int	NumberOfYLabels

int	Logx

char *	XLabelFormat

char *	YLabelFormat

double	XRange [2]

double	YRange [2]

double	XComputedRange [2]

double	YComputedRange [2]

int	Border

int	PlotLines

int	PlotPoints

int	PlotCurveLines

int	PlotCurvePoints

int	ExchangeAxes

int	ReverseXAxis

int	ReverseYAxis

int	AdjustXLabels

int	AdjustYLabels

int	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

int	Legend

double	LegendPosition [2]

double	LegendPosition2 [2]

vtkLegendBoxActor *	LegendActor

vtkGlyphSource2D *	GlyphSource

vtkPlanes *	ClipPlanes

double	GlyphSize

int	ChartBox

vtkPolyData *	ChartBoxPolyData

vtkPolyDataMapper2D *	ChartBoxMapper

vtkActor2D *	ChartBoxActor

int	ChartBorder

vtkPolyData *	ChartBorderPolyData

vtkPolyDataMapper2D *	ChartBorderMapper

vtkActor2D *	ChartBorderActor

int	ShowReferenceXLine

int	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
int	Visibility

int	Pickable

int	Dragable

bool	UseBounds

double	AllocatedRenderTime

double	EstimatedRenderTime

double	SavedEstimatedRenderTime

double	RenderTimeMultiplier

int	NumberOfConsumers

vtkObject **	Consumers

vtkAssemblyPaths *	Paths

vtkInformation *	PropertyKeys

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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 correspondance 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

Examples:: vtkXYPlotActor (Examples)

Tests:: vtkXYPlotActor (Tests)

Definition at line 132 of file vtkXYPlotActor.h.

Member Typedef Documentation

typedef vtkActor2D vtkXYPlotActor::Superclass

Definition at line 135 of file vtkXYPlotActor.h.

Member Enumeration Documentation

enum vtkXYPlotActor::Alignment

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

Definition at line 431 of file vtkXYPlotActor.h.

Constructor & Destructor Documentation

vtkXYPlotActor::vtkXYPlotActor ( )

protected

vtkXYPlotActor::~vtkXYPlotActor ( )

protected

Member Function Documentation

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

static

virtual int 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.

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

static

virtual vtkObjectBase* vtkXYPlotActor::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkActor2D.

vtkXYPlotActor* vtkXYPlotActor::NewInstance ( ) const

void vtkXYPlotActor::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

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.

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.

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 157 of file vtkXYPlotActor.h.

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.

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 159 of file vtkXYPlotActor.h.

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

Remove a dataset from the list of data to append.

void vtkXYPlotActor::RemoveDataSetInput ( vtkDataSet * ds )

inline

Remove a dataset from the list of data to append.

Definition at line 165 of file vtkXYPlotActor.h.

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

Remove a dataset from the list of data to append.

void vtkXYPlotActor::RemoveDataSetInputConnection ( vtkAlgorithmOutput * in )

inline

Remove a dataset from the list of data to append.

Definition at line 167 of file vtkXYPlotActor.h.

void vtkXYPlotActor::RemoveAllDataSetInputConnections ( )

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

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).

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).

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.)

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.)

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 197 of file vtkXYPlotActor.h.

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 198 of file vtkXYPlotActor.h.

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 199 of file vtkXYPlotActor.h.

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 201 of file vtkXYPlotActor.h.

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.)

void vtkXYPlotActor::AddDataObjectInput ( vtkDataObject * in )

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

void vtkXYPlotActor::AddDataObjectInputConnection ( vtkAlgorithmOutput * alg )

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

void vtkXYPlotActor::RemoveDataObjectInputConnection ( vtkAlgorithmOutput * aout )

Remove a dataset from the list of data to display.

void vtkXYPlotActor::RemoveDataObjectInput ( vtkDataObject * in )

Remove a dataset from the list of data to display.

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).

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).

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 227 of file vtkXYPlotActor.h.

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 229 of file vtkXYPlotActor.h.

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).

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.

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.

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.

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.

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

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

inline

Definition at line 263 of file vtkXYPlotActor.h.

double* vtkXYPlotActor::GetPlotColor ( int i )

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

vtkPolyData* vtkXYPlotActor::GetPlotSymbol ( int i )

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

const char* vtkXYPlotActor::GetPlotLabel ( int i )

virtual int vtkXYPlotActor::GetPlotCurvePoints ( )

virtual

virtual void vtkXYPlotActor::SetPlotCurvePoints ( int )

virtual

virtual void vtkXYPlotActor::PlotCurvePointsOn ( )

virtual

virtual void vtkXYPlotActor::PlotCurvePointsOff ( )

virtual

virtual int vtkXYPlotActor::GetPlotCurveLines ( )

virtual

virtual void vtkXYPlotActor::SetPlotCurveLines ( int )

virtual

virtual void vtkXYPlotActor::PlotCurveLinesOn ( )

virtual

virtual void vtkXYPlotActor::PlotCurveLinesOff ( )

virtual

void vtkXYPlotActor::SetPlotLines	(	int	i,
		int
	)

int vtkXYPlotActor::GetPlotLines ( int i )

void vtkXYPlotActor::SetPlotPoints	(	int	i,
		int
	)

int vtkXYPlotActor::GetPlotPoints ( int i )

virtual void vtkXYPlotActor::SetExchangeAxes ( int )

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.

virtual int 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.

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.

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.

virtual void vtkXYPlotActor::SetReverseXAxis ( int )

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.

virtual int 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.

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.

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.

virtual void vtkXYPlotActor::SetReverseYAxis ( int )

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.

virtual int 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.

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.

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.

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.)

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.)

virtual void vtkXYPlotActor::SetTitle ( const char * )

virtual

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

virtual char* vtkXYPlotActor::GetTitle ( )

virtual

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

virtual void vtkXYPlotActor::SetXTitle ( const char * )

virtual

Set/Get the title of the x axis

virtual char* vtkXYPlotActor::GetXTitle ( )

virtual

Set/Get the title of the x axis

virtual void vtkXYPlotActor::SetYTitle ( const char * )

virtual

Set/Get the title of the y axis

char* vtkXYPlotActor::GetYTitle ( )

Set/Get the title of the y axis

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 347 of file vtkXYPlotActor.h.

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 351 of file vtkXYPlotActor.h.

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).

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).

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).

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).

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).

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).

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).

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).

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 368 of file vtkXYPlotActor.h.

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.

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.

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.

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.

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 382 of file vtkXYPlotActor.h.

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.

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.

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.

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.

void vtkXYPlotActor::SetNumberOfXMinorTicks ( int num )

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

int vtkXYPlotActor::GetNumberOfXMinorTicks ( )

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

void vtkXYPlotActor::SetNumberOfYMinorTicks ( int num )

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

int vtkXYPlotActor::GetNumberOfYMinorTicks ( )

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

virtual void vtkXYPlotActor::SetLegend ( int )

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.

virtual int 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.

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.

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.

virtual void vtkXYPlotActor::SetTitlePosition	(	double	,
		double
	)

virtual

Set/Get the position of the title. This has no effect if AdjustTitlePosition is true.

void vtkXYPlotActor::SetTitlePosition ( double [2] )

Set/Get the position of the title. This has no effect if AdjustTitlePosition is true.

virtual double* vtkXYPlotActor::GetTitlePosition ( )

virtual

Set/Get the position of the title. This has no effect if AdjustTitlePosition is true.

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

virtual

Set/Get the position of the title. This has no effect if AdjustTitlePosition is true.

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

virtual

Set/Get the position of the title. This has no effect if AdjustTitlePosition is true.

virtual void vtkXYPlotActor::SetAdjustTitlePosition ( int )

virtual

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

virtual int vtkXYPlotActor::GetAdjustTitlePosition ( )

virtual

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

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.

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.

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

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

virtual void vtkXYPlotActor::SetTitleTextProperty ( vtkTextProperty * p )

virtual

Set/Get the title text property.

virtual vtkTextProperty* vtkXYPlotActor::GetTitleTextProperty ( )

virtual

Set/Get the title text property.

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.

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.

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.

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.

virtual void vtkXYPlotActor::SetLogx ( int )

virtual

Enable/Disable plotting of Log of x-values.

virtual int vtkXYPlotActor::GetLogx ( )

virtual

Enable/Disable plotting of Log of x-values.

virtual void vtkXYPlotActor::LogxOn ( )

virtual

Enable/Disable plotting of Log of x-values.

virtual void vtkXYPlotActor::LogxOff ( )

virtual

Enable/Disable plotting of Log of x-values.

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.

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 500 of file vtkXYPlotActor.h.

virtual void vtkXYPlotActor::SetXLabelFormat ( const char * )

virtual

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

virtual char* vtkXYPlotActor::GetXLabelFormat ( )

virtual

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

virtual void vtkXYPlotActor::SetYLabelFormat ( const char * )

virtual

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

virtual char* vtkXYPlotActor::GetYLabelFormat ( )

virtual

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

virtual void vtkXYPlotActor::SetBorder ( int )

virtual

Set/Get the spacing between the plot window and the plot. The value is specified in pixels.

virtual int vtkXYPlotActor::GetBorder ( )

virtual

Set/Get the spacing between the plot window and the plot. The value is specified in pixels.

virtual int 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.

virtual void vtkXYPlotActor::SetPlotPoints ( int )

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.

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.

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.

virtual int vtkXYPlotActor::GetPlotLines ( )

virtual

Set/Get whether the lines are rendered. The line width can be set in the property object.

virtual void vtkXYPlotActor::SetPlotLines ( int )

virtual

Set/Get whether the lines are rendered. The line width can be set in the property object.

virtual void vtkXYPlotActor::PlotLinesOn ( )

virtual

Set/Get whether the lines are rendered. The line width can be set in the property object.

virtual void vtkXYPlotActor::PlotLinesOff ( )

virtual

Set/Get whether the lines are rendered. The line width can be set in the property object.

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.

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.

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)

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.

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.

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.

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.

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.

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.

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

Given a plot coordinate, return the viewpoint position

void vtkXYPlotActor::PlotToViewportCoordinate ( vtkViewport * viewport )