vtkQuartileChartRepresentation extends to vtkXYChartRepresentation to add support for combining quartile plots. More...

#include <vtkQuartileChartRepresentation.h>

Inheritance diagram for vtkQuartileChartRepresentation:

Collaboration diagram for vtkQuartileChartRepresentation:

[legend]

Public Types
typedef vtkXYChartRepresentation	Superclass

Public Types inherited from vtkXYChartRepresentation
typedef vtkChartRepresentation	Superclass

Public Types inherited from vtkChartRepresentation
typedef vtkPVDataRepresentation	Superclass

Public Types inherited from vtkPVDataRepresentation
typedef vtkDataRepresentation	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent)

virtual vtkStdString	GetDefaultSeriesLabel (const vtkStdString &tableName, const vtkStdString &columnName)
	Overridden to format the series name to remove the operation applied e.g. More...


virtual void	SetQuartileVisibility (bool)
	When set to true, q1/q3 region is rendered. More...

virtual bool	GetQuartileVisibility ()
	When set to true, q1/q3 region is rendered. More...


virtual void	SetRangeVisibility (bool)
	When set to true, min/max region is rendered. More...

virtual bool	GetRangeVisibility ()
	When set to true, min/max region is rendered. More...


virtual void	SetAverageVisibility (bool)
	When set to true, the avg curve is rendered. More...

virtual bool	GetAverageVisibility ()
	When set to true, the avg curve is rendered. More...


virtual void	SetMedianVisibility (bool)
	When set to true, the med curve is rendered. More...

virtual bool	GetMedianVisibility ()
	When set to true, the med curve is rendered. More...

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

virtual void	SetVisibility (bool visible)
	Set visibility of the representation. More...

void	SetChartTypeToLine ()

void	SetChartTypeToPoints ()

void	SetChartTypeToBar ()

void	SetChartTypeToStacked ()

void	SetChartTypeToBag ()

void	SetChartTypeToFunctionalBag ()

void	SetChartTypeToArea ()

vtkChartXY *	GetChart ()
	Returns the vtkChartXY instance from the view to which this representation is added. More...

void	ClearSeriesVisibilities ()

void	ClearLineThicknesses ()

void	ClearLineStyles ()

void	ClearColors ()

void	ClearAxisCorners ()

void	ClearMarkerStyles ()

void	ClearLabels ()

virtual void	SetSelectionColor (double, double, double)

virtual void	SetSelectionColor (double [3])

virtual double *	GetSelectionColor ()

virtual void	GetSelectionColor (double &, double &, double &)

virtual void	GetSelectionColor (double [3])

virtual bool	Export (vtkCSVExporter *exporter)
	Called by vtkPVContextView::Export() to export the representation's data to a CSV file. More...

virtual void	SetChartType (int)
	Get/Set the chart type, defaults to line chart. More...

virtual int	GetChartType ()
	Get/Set the chart type, defaults to line chart. More...

virtual void	SetXAxisSeriesName (const char *)
	Set the series to use as the X-axis. More...

virtual char *	GetXAxisSeriesName ()
	Set the series to use as the X-axis. More...

virtual void	SetUseIndexForXAxis (bool)
	Set whether the index should be used for the x axis. More...

virtual bool	GetUseIndexForXAxis ()
	Set whether the index should be used for the x axis. More...

void	SetSeriesVisibility (const char *seriesname, bool visible)
	Set/Clear the properties for Y series/columns. More...

void	SetLineThickness (const char *name, int value)
	Set/Clear the properties for Y series/columns. More...

void	SetLineStyle (const char *name, int value)
	Set/Clear the properties for Y series/columns. More...

void	SetColor (const char *name, double r, double g, double b)
	Set/Clear the properties for Y series/columns. More...

void	SetAxisCorner (const char *name, int corner)
	Set/Clear the properties for Y series/columns. More...

void	SetMarkerStyle (const char *name, int style)
	Set/Clear the properties for Y series/columns. More...

void	SetLabel (const char name, const char label)
	Set/Clear the properties for Y series/columns. More...

void	SetUseColorMapping (const char *name, bool useColorMapping)
	Set/Clear the properties for Y series/columns. More...

void	SetLookupTable (const char name, vtkScalarsToColors lut)
	Set/Clear the properties for Y series/columns. More...

const char *	GetLabel (const char *name) const
	Set/Clear the properties for Y series/columns. More...

virtual void	SetSeriesLabelPrefix (const char *)
	Get/Set the series label prefix. More...

virtual char *	GetSeriesLabelPrefix ()
	Get/Set the series label prefix. More...

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

void	SetSelectionRepresentation (vtkChartSelectionRepresentation *)
	These must only be set during initialization before adding the representation to any views or calling Update(). More...

virtual void	MarkModified ()
	This needs to be called on all instances of vtkGeometryRepresentation when the input is modified. More...

void	SetCompositeDataSetIndex (unsigned int)

void	AddCompositeDataSetIndex (unsigned int)

void	ResetCompositeDataSetIndices ()

virtual unsigned int	Initialize (unsigned int minIdAvailable, unsigned int maxIdAvailable)
	Override because of internal selection representations that need to be initialized as well. More...

virtual int	ProcessViewRequest (vtkInformationRequestKey request_type, vtkInformation inInfo, vtkInformation *outInfo)
	vtkAlgorithm::ProcessRequest() equivalent for rendering passes. More...

virtual bool	MapSelectionToInput (vtkSelection *sel)
	This method is called on the client-side by the vtkPVContextView whenever a new selection is made on all the visible representations in that view. More...

virtual bool	MapSelectionToView (vtkSelection *sel)
	This is the inverse of MapSelectionToInput(). More...

virtual bool	Export (vtkCSVExporter *vtkNotUsed(exporter))
	Called by vtkPVContextView::Export() to export the representation's data to a CSV file. More...

void	SetFieldAssociation (int)
	Set the field association for arrays to use. More...

virtual int	GetFieldAssociation ()
	Set the field association for arrays to use. More...

virtual void	SetFlattenTable (int)
	Flatten the table, i.e. More...

virtual int	GetFlattenTable ()
	Flatten the table, i.e. More...

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

unsigned int	GetUniqueIdentifier ()
	Return 0 if the Initialize() method was not called otherwise a unique ID that will be shared across the processes for that same object. More...

virtual bool	GetVisibility ()

virtual vtkDataObject *	GetRenderedDataObject (int vtkNotUsed(port))
	Returns the data object that is rendered from the given input port. More...

virtual void	SetForcedCacheKey (double val)
	Typically a representation decides whether to use cache based on the view's values for UseCache and CacheKey. More...

virtual void	SetForceUseCache (bool val)

bool	GetUsingCacheForUpdate ()
	Called by vtkPVDataRepresentationPipeline to see if using cache is valid and will be used for the update. More...

virtual bool	GetNeedUpdate ()

virtual vtkAlgorithmOutput *	GetInternalOutputPort ()
	Retrieves an output port for the input data object at the specified port and connection index. More...

virtual vtkAlgorithmOutput *	GetInternalOutputPort (int port)

virtual vtkAlgorithmOutput *	GetInternalOutputPort (int port, int conn)

vtkView *	GetView () const
	Provides access to the view. More...

virtual void	SetUpdateTime (double time)
	Set the update time. More...

virtual double	GetUpdateTime ()
	Set the update time. More...

virtual bool	GetUpdateTimeValid ()
	Set whether the UpdateTime is valid. More...

virtual void	SetUseCache (bool)

virtual void	SetCacheKey (double val)

virtual double	GetCacheKey ()
	Returns whether caching is used and what key to use when caching is enabled. More...

virtual bool	GetUseCache ()
	Returns whether caching is used and what key to use when caching is enabled. More...

Static Public Member Functions
static vtkQuartileChartRepresentation *	New ()

static int	IsTypeOf (const char *type)

static vtkQuartileChartRepresentation *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkXYChartRepresentation
static vtkXYChartRepresentation *	New ()

static int	IsTypeOf (const char *type)

static vtkXYChartRepresentation *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkChartRepresentation
static vtkChartRepresentation *	New ()

static int	IsTypeOf (const char *type)

static vtkChartRepresentation *	SafeDownCast (vtkObject *o)

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

static vtkPVDataRepresentation *	SafeDownCast (vtkObject *o)

Protected Member Functions
	vtkQuartileChartRepresentation ()

	~vtkQuartileChartRepresentation ()

Protected Member Functions inherited from vtkXYChartRepresentation
	vtkXYChartRepresentation ()

	~vtkXYChartRepresentation ()

virtual bool	RemoveFromView (vtkView *view)
	Overridden to remove all plots from the view. More...

virtual int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
	Subclasses should override this to connect inputs to the internal pipeline as necessary. More...

virtual void	PrepareForRendering ()
	This method is called before actual render if this->MTime was modified since the last time this method was called. More...

Protected Member Functions inherited from vtkChartRepresentation
	vtkChartRepresentation ()

	~vtkChartRepresentation ()

virtual int	FillInputPortInformation (int port, vtkInformation *info)
	Fill input port information. More...

virtual bool	AddToView (vtkView *view)
	Adds the representation to the view. More...

virtual bool	IsCached (double cache_key)
	Overridden to check with the vtkPVCacheKeeper to see if the key is cached. More...

vtkTable *	GetLocalOutput ()
	Convenience method to get the first vtkTable from LocalOutput, if any. More...

virtual vtkDataObject *	TransformInputData (vtkInformationVector *inputVector, vtkDataObject data)
	Method to be overrided to transform input data to a vtkTable. More...

bool	GetLocalOutput (MapOfTables &tables)
	Convenience method to get all vtkTable instances with their associated names. More...

Protected Member Functions inherited from vtkPVDataRepresentation
	vtkPVDataRepresentation ()

	~vtkPVDataRepresentation ()

virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive. More...

virtual int	RequestUpdateExtent (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

virtual int	RequestUpdateTime (vtkInformation , vtkInformationVector , vtkInformationVector )

Protected Attributes
bool	QuartileVisibility

bool	RangeVisibility

bool	AverageVisibility

bool	MedianVisibility

Protected Attributes inherited from vtkXYChartRepresentation
vtkInternals *	Internals

Protected Attributes inherited from vtkChartRepresentation
int	FieldAssociation

vtkPVCacheKeeper *	CacheKeeper

vtkWeakPointer< vtkPVContextView >	ContextView

bool	EnableServerSideRendering

int	FlattenTable

vtkSmartPointer< vtkMultiBlockDataSet >	LocalOutput

std::set< unsigned int >	CompositeIndices

vtkWeakPointer< vtkChartSelectionRepresentation >	SelectionRepresentation

Protected Attributes inherited from vtkPVDataRepresentation
double	UpdateTime

bool	UpdateTimeValid

unsigned int	UniqueIdentifier

Friends
class	vtkQCRInternals

Additional Inherited Members
Protected Types inherited from vtkChartRepresentation
typedef std::map< std::string, vtkSmartPointer< vtkTable > >	MapOfTables

Detailed Description

vtkQuartileChartRepresentation extends to vtkXYChartRepresentation to add support for combining quartile plots.

A quartile plot is created by treating multiple input arrays are ranges for area plots. All properties, like color, label etc. are specified collectively.

Definition at line 29 of file vtkQuartileChartRepresentation.h.

Member Typedef Documentation

§ Superclass

typedef vtkXYChartRepresentation vtkQuartileChartRepresentation::Superclass

Definition at line 34 of file vtkQuartileChartRepresentation.h.

Constructor & Destructor Documentation

§ vtkQuartileChartRepresentation()

vtkQuartileChartRepresentation::vtkQuartileChartRepresentation ( )

protected

§ ~vtkQuartileChartRepresentation()

vtkQuartileChartRepresentation::~vtkQuartileChartRepresentation ( )

protected

Member Function Documentation

§ New()

static vtkQuartileChartRepresentation* vtkQuartileChartRepresentation::New ( )

static

§ GetClassName()

virtual const char* vtkQuartileChartRepresentation::GetClassName ( )

virtual

Reimplemented from vtkXYChartRepresentation.

§ IsTypeOf()

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

static

§ IsA()

virtual int vtkQuartileChartRepresentation::IsA ( const char * type )

virtual

Reimplemented from vtkXYChartRepresentation.

§ SafeDownCast()

static vtkQuartileChartRepresentation* vtkQuartileChartRepresentation::SafeDownCast ( vtkObject * o )

static

§ PrintSelf()

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

§ GetDefaultSeriesLabel()

virtual vtkStdString vtkQuartileChartRepresentation::GetDefaultSeriesLabel	(	const vtkStdString &	tableName,
		const vtkStdString &	columnName
	)

virtual

Overridden to format the series name to remove the operation applied e.g.

a columnName of "min(EQPS)" and "max(EQPS)" both will return "EQPS".

Reimplemented from vtkChartRepresentation.

§ SetQuartileVisibility()

virtual void vtkQuartileChartRepresentation::SetQuartileVisibility ( bool )

virtual

When set to true, q1/q3 region is rendered.

§ GetQuartileVisibility()

virtual bool vtkQuartileChartRepresentation::GetQuartileVisibility ( )

virtual

When set to true, q1/q3 region is rendered.

§ SetRangeVisibility()

virtual void vtkQuartileChartRepresentation::SetRangeVisibility ( bool )

virtual

When set to true, min/max region is rendered.

§ GetRangeVisibility()

virtual bool vtkQuartileChartRepresentation::GetRangeVisibility ( )

virtual

When set to true, min/max region is rendered.

§ SetAverageVisibility()

virtual void vtkQuartileChartRepresentation::SetAverageVisibility ( bool )

virtual

When set to true, the avg curve is rendered.

§ GetAverageVisibility()

virtual bool vtkQuartileChartRepresentation::GetAverageVisibility ( )

virtual

When set to true, the avg curve is rendered.

§ SetMedianVisibility()

virtual void vtkQuartileChartRepresentation::SetMedianVisibility ( bool )

virtual

When set to true, the med curve is rendered.

§ GetMedianVisibility()

virtual bool vtkQuartileChartRepresentation::GetMedianVisibility ( )

virtual

When set to true, the med curve is rendered.

Friends And Related Function Documentation

§ vtkQCRInternals

friend class vtkQCRInternals

friend

Definition at line 89 of file vtkQuartileChartRepresentation.h.

Member Data Documentation

§ QuartileVisibility

bool vtkQuartileChartRepresentation::QuartileVisibility

protected

Definition at line 80 of file vtkQuartileChartRepresentation.h.

§ RangeVisibility

bool vtkQuartileChartRepresentation::RangeVisibility

protected

Definition at line 81 of file vtkQuartileChartRepresentation.h.

§ AverageVisibility

bool vtkQuartileChartRepresentation::AverageVisibility

protected

Definition at line 82 of file vtkQuartileChartRepresentation.h.

§ MedianVisibility

bool vtkQuartileChartRepresentation::MedianVisibility

protected

Definition at line 83 of file vtkQuartileChartRepresentation.h.

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

/builddir/build/BUILD/ParaView-v5.2.0/ParaViewCore/ClientServerCore/Rendering/vtkQuartileChartRepresentation.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

§ Superclass

Constructor & Destructor Documentation

§ vtkQuartileChartRepresentation()

§ ~vtkQuartileChartRepresentation()

Member Function Documentation

§ New()

§ GetClassName()

§ IsTypeOf()

§ IsA()

§ SafeDownCast()

§ PrintSelf()

§ GetDefaultSeriesLabel()

§ SetQuartileVisibility()

§ GetQuartileVisibility()

§ SetRangeVisibility()

§ GetRangeVisibility()

§ SetAverageVisibility()

§ GetAverageVisibility()

§ SetMedianVisibility()

§ GetMedianVisibility()

Friends And Related Function Documentation

§ vtkQCRInternals

Member Data Documentation

§ QuartileVisibility

§ RangeVisibility

§ AverageVisibility

§ MedianVisibility