ParaView
|
vtkXYChartRepresentation is representation that is used to add vtkPlot subclasses to a vtkChartXY instance e.g. More...
#include <vtkXYChartRepresentation.h>
Classes | |
class | vtkInternals |
Public Types | |
typedef vtkChartRepresentation | Superclass |
![]() | |
typedef vtkPVDataRepresentation | Superclass |
![]() | |
typedef vtkDataRepresentation | Superclass |
Public Member Functions | |
virtual const char * | GetClassName () |
virtual int | IsA (const char *type) |
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... | |
![]() | |
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 vtkStdString | GetDefaultSeriesLabel (const vtkStdString &tableName, const vtkStdString &columnName) |
Method to provide the default name given the name of a table and a column in that table. 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... | |
![]() | |
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 vtkXYChartRepresentation * | New () |
static int | IsTypeOf (const char *type) |
static vtkXYChartRepresentation * | SafeDownCast (vtkObject *o) |
![]() | |
static vtkChartRepresentation * | New () |
static int | IsTypeOf (const char *type) |
static vtkChartRepresentation * | SafeDownCast (vtkObject *o) |
![]() | |
static int | IsTypeOf (const char *type) |
static vtkPVDataRepresentation * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
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... | |
![]() | |
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... | |
![]() | |
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 | |
vtkInternals * | Internals |
![]() | |
int | FieldAssociation |
vtkPVCacheKeeper * | CacheKeeper |
vtkWeakPointer< vtkPVContextView > | ContextView |
bool | EnableServerSideRendering |
int | FlattenTable |
vtkSmartPointer< vtkMultiBlockDataSet > | LocalOutput |
std::set< unsigned int > | CompositeIndices |
vtkWeakPointer< vtkChartSelectionRepresentation > | SelectionRepresentation |
![]() | |
double | UpdateTime |
bool | UpdateTimeValid |
unsigned int | UniqueIdentifier |
Friends | |
class | vtkInternals |
Additional Inherited Members | |
![]() | |
typedef std::map< std::string, vtkSmartPointer< vtkTable > > | MapOfTables |
vtkXYChartRepresentation is representation that is used to add vtkPlot subclasses to a vtkChartXY instance e.g.
adding vtkPlotBar to create a bar chart or vtkPlotLine to create a line chart. For every selected series (or column in a vtkTable), this class adds a new vtkPlot to the vtkChartXY. vtkXYChartRepresentation provides a union of APIs for changing the appearance of vtkPlot instances. Developers should only expose the applicable API in the ServerManager XML.
To select which type of vtkPlot instances this class will use, you must set the ChartType. Refer to vtkChartXY::AddPlot() for details on what the type must be.
Definition at line 39 of file vtkXYChartRepresentation.h.
Definition at line 43 of file vtkXYChartRepresentation.h.
|
protected |
|
protected |
|
static |
|
virtual |
Reimplemented from vtkChartRepresentation.
Reimplemented in vtkPVHistogramChartRepresentation, and vtkQuartileChartRepresentation.
|
static |
|
virtual |
Reimplemented from vtkChartRepresentation.
Reimplemented in vtkPVHistogramChartRepresentation, and vtkQuartileChartRepresentation.
|
static |
void vtkXYChartRepresentation::PrintSelf | ( | ostream & | os, |
vtkIndent | indent | ||
) |
|
virtual |
Set visibility of the representation.
Overridden to ensure that internally added vtkPlot instances are updated when hiding the representation.
Reimplemented from vtkChartRepresentation.
|
virtual |
Get/Set the chart type, defaults to line chart.
This must be set before this representation is updated. Valid values are vtkChart::LINE, vtkChart::POINTS, vtkChart::BAR, etc. Default is vtkChart::LINE.
|
virtual |
Get/Set the chart type, defaults to line chart.
This must be set before this representation is updated. Valid values are vtkChart::LINE, vtkChart::POINTS, vtkChart::BAR, etc. Default is vtkChart::LINE.
void vtkXYChartRepresentation::SetChartTypeToLine | ( | ) |
void vtkXYChartRepresentation::SetChartTypeToPoints | ( | ) |
void vtkXYChartRepresentation::SetChartTypeToBar | ( | ) |
void vtkXYChartRepresentation::SetChartTypeToStacked | ( | ) |
void vtkXYChartRepresentation::SetChartTypeToBag | ( | ) |
void vtkXYChartRepresentation::SetChartTypeToFunctionalBag | ( | ) |
void vtkXYChartRepresentation::SetChartTypeToArea | ( | ) |
vtkChartXY* vtkXYChartRepresentation::GetChart | ( | ) |
Returns the vtkChartXY instance from the view to which this representation is added.
Thus this will return a non-null value only when this representation is added to a view.
|
virtual |
Set the series to use as the X-axis.
|
virtual |
Set the series to use as the X-axis.
|
virtual |
Set whether the index should be used for the x axis.
When true, XSeriesName is ignored.
|
virtual |
Set whether the index should be used for the x axis.
When true, XSeriesName is ignored.
void vtkXYChartRepresentation::SetSeriesVisibility | ( | const char * | seriesname, |
bool | visible | ||
) |
Set/Clear the properties for Y series/columns.
void vtkXYChartRepresentation::SetLineThickness | ( | const char * | name, |
int | value | ||
) |
Set/Clear the properties for Y series/columns.
void vtkXYChartRepresentation::SetLineStyle | ( | const char * | name, |
int | value | ||
) |
Set/Clear the properties for Y series/columns.
void vtkXYChartRepresentation::SetColor | ( | const char * | name, |
double | r, | ||
double | g, | ||
double | b | ||
) |
Set/Clear the properties for Y series/columns.
void vtkXYChartRepresentation::SetAxisCorner | ( | const char * | name, |
int | corner | ||
) |
Set/Clear the properties for Y series/columns.
void vtkXYChartRepresentation::SetMarkerStyle | ( | const char * | name, |
int | style | ||
) |
Set/Clear the properties for Y series/columns.
void vtkXYChartRepresentation::SetLabel | ( | const char * | name, |
const char * | label | ||
) |
Set/Clear the properties for Y series/columns.
void vtkXYChartRepresentation::SetUseColorMapping | ( | const char * | name, |
bool | useColorMapping | ||
) |
Set/Clear the properties for Y series/columns.
void vtkXYChartRepresentation::SetLookupTable | ( | const char * | name, |
vtkScalarsToColors * | lut | ||
) |
Set/Clear the properties for Y series/columns.
const char* vtkXYChartRepresentation::GetLabel | ( | const char * | name | ) | const |
Set/Clear the properties for Y series/columns.
void vtkXYChartRepresentation::ClearSeriesVisibilities | ( | ) |
void vtkXYChartRepresentation::ClearLineThicknesses | ( | ) |
void vtkXYChartRepresentation::ClearLineStyles | ( | ) |
void vtkXYChartRepresentation::ClearColors | ( | ) |
void vtkXYChartRepresentation::ClearAxisCorners | ( | ) |
void vtkXYChartRepresentation::ClearMarkerStyles | ( | ) |
void vtkXYChartRepresentation::ClearLabels | ( | ) |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Get/Set the series label prefix.
|
virtual |
Get/Set the series label prefix.
|
virtual |
Called by vtkPVContextView::Export() to export the representation's data to a CSV file.
Return false on failure which will call the exporting process to abort and raise an error. Default implementation simply returns false.
|
protectedvirtual |
Overridden to remove all plots from the view.
Reimplemented from vtkChartRepresentation.
|
protectedvirtual |
Subclasses should override this to connect inputs to the internal pipeline as necessary.
Since most representations are "meta-filters" (i.e. filters containing other filters), you should create shallow copies of your input before connecting to the internal pipeline. The convenience method GetInternalOutputPort will create a cached shallow copy of a specified input for you. The related helper functions GetInternalAnnotationOutputPort, GetInternalSelectionOutputPort should be used to obtain a selection or annotation port whose selections are localized for a particular input data object.
Reimplemented from vtkChartRepresentation.
|
protectedvirtual |
This method is called before actual render if this->MTime was modified since the last time this method was called.
Subclasses should override to update "appearance" related changes that don't affect data. When this method is called, you're assured that this->ContextView is valid. Note that this method will not be called if this->GetVisibility() returns false, this subclasses should also override SetVisibility() to hide "actors" and such.
Reimplemented from vtkChartRepresentation.
Reimplemented in vtkPVHistogramChartRepresentation.
|
friend |
Definition at line 150 of file vtkXYChartRepresentation.h.
|
protected |
Definition at line 152 of file vtkXYChartRepresentation.h.