Classes | Public Types | Public Member Functions | Public Attributes | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
vtkXYChartRepresentation::vtkInternals Class Reference

#include <vtkXYChartRepresentationInternals.h>

Collaboration diagram for vtkXYChartRepresentation::vtkInternals:
Collaboration graph
[legend]

Classes

struct  PlotInfo
 
class  PlotsMap
 
struct  TableInfo
 

Public Types

typedef vtkXYChartRepresentation::MapOfTables MapOfTables
 

Public Member Functions

 vtkInternals ()
 
virtual ~vtkInternals ()=default
 
void HideAllPlots ()
 Hide all plots. More...
 
void RemoveAllPlots (vtkChartXY *chartXY)
 Destroy all vtkPlot instances. More...
 
virtual std::vector< std::string > GetSeriesRoles (const std::string &vtkNotUsed(tableName), const std::string &vtkNotUsed(columnName))
 Subclasses can override this method to assign a role for a specific data array in the input dataset. More...
 
virtual vtkPlot * NewPlot (vtkXYChartRepresentation *self, const std::string &tableName, const std::string &columnName, const std::string &role, unsigned int block=0)
 Add new plot. More...
 
virtual int GetInputArrayIndex (const std::string &vtkNotUsed(tableName), const std::string &vtkNotUsed(columnName), const std::string &vtkNotUsed(role))
 
virtual void UpdatePlots (vtkXYChartRepresentation *self, const MapOfTables &tables)
 Update i.e. More...
 
virtual void UpdatePlotProperties (vtkXYChartRepresentation *self)
 Update properties for plots in the chart. More...
 
virtual bool Export (vtkXYChartRepresentation *self, vtkAbstractChartExporter *exporter)
 Export visible plots to a CSV file. More...
 

Public Attributes

std::map< std::string, bool > SeriesVisibilities
 
std::map< std::string, int > SeriesOrder
 
std::map< std::string, int > LineThicknesses
 
std::map< std::string, int > LineStyles
 
std::map< std::string, vtkColor3d > Colors
 
std::map< std::string, double > Opacities
 
std::map< std::string, int > AxisCorners
 
std::map< std::string, int > MarkerStyles
 
std::map< std::string, double > MarkerSizes
 
std::map< std::string, std::string > Labels
 
std::map< std::string, bool > UseColorMapping
 
std::map< std::string, vtkScalarsToColors * > Lut
 
bool PreviousUseIndexForXAxis
 
std::string PreviousXAxisSeriesName
 

Protected Types

typedef std::map< std::string, PlotInfo > PlotsMapItem
 

Protected Member Functions

template<class T >
T GetSeriesParameter (vtkXYChartRepresentation *self, const std::string &tableName, const std::string &columnName, const std::string &vtkNotUsed(role), const std::map< std::string, T > &parameter_map, const T default_value=T()) const
 Makes is easy to obtain a value for a series parameter, is set, else the default. More...
 
virtual bool UpdateSinglePlotProperties (vtkXYChartRepresentation *self, const std::string &tableName, const std::string &columnName, const std::string &role, vtkPlot *plot)
 Returns false for in-visible plots. More...
 

Static Protected Member Functions

static const char * IndexColumnName ()
 Name of the index column added by AddIndexColumn(). More...
 
static vtkSmartPointer< vtkTable > AddIndexColumn (vtkTable *table)
 Returns a shallow copy of the table with an additional column, named IndexColumnName(), holding the row indices. More...
 

Protected Attributes

PlotsMap SeriesPlots
 

Detailed Description

Definition at line 28 of file vtkXYChartRepresentationInternals.h.

Member Typedef Documentation

◆ PlotsMapItem

Definition at line 46 of file vtkXYChartRepresentationInternals.h.

◆ MapOfTables

Definition at line 192 of file vtkXYChartRepresentationInternals.h.

Constructor & Destructor Documentation

◆ vtkInternals()

vtkXYChartRepresentation::vtkInternals::vtkInternals ( )
inline

Definition at line 215 of file vtkXYChartRepresentationInternals.h.

◆ ~vtkInternals()

virtual vtkXYChartRepresentation::vtkInternals::~vtkInternals ( )
virtualdefault

Member Function Documentation

◆ GetSeriesParameter()

template<class T >
T vtkXYChartRepresentation::vtkInternals::GetSeriesParameter ( vtkXYChartRepresentation *  self,
const std::string &  tableName,
const std::string &  columnName,
const std::string &  vtkNotUsedrole,
const std::map< std::string, T > &  parameter_map,
const T  default_value = T() 
) const
inlineprotected

Makes is easy to obtain a value for a series parameter, is set, else the default.

This class supports two mechanisms for addresses series in a collection (multiblock) of tables: (1) using a name that combines the table name and the column name (using vtkChartRepresentation::GetDefaultSeriesLabel), or (2) using the column name alone. (1) is always checked before (2).

Definition at line 163 of file vtkXYChartRepresentationInternals.h.

◆ HideAllPlots()

void vtkXYChartRepresentation::vtkInternals::HideAllPlots ( )
inline

Hide all plots.

Definition at line 226 of file vtkXYChartRepresentationInternals.h.

◆ RemoveAllPlots()

void vtkXYChartRepresentation::vtkInternals::RemoveAllPlots ( vtkChartXY *  chartXY)
inline

Destroy all vtkPlot instances.

Definition at line 232 of file vtkXYChartRepresentationInternals.h.

◆ GetSeriesRoles()

virtual std::vector<std::string> vtkXYChartRepresentation::vtkInternals::GetSeriesRoles ( const std::string &  vtkNotUsedtableName,
const std::string &  vtkNotUsedcolumnName 
)
inlinevirtual

Subclasses can override this method to assign a role for a specific data array in the input dataset.

This is useful when multiple plots are to be created for a single series.

Definition at line 240 of file vtkXYChartRepresentationInternals.h.

◆ NewPlot()

virtual vtkPlot* vtkXYChartRepresentation::vtkInternals::NewPlot ( vtkXYChartRepresentation *  self,
const std::string &  tableName,
const std::string &  columnName,
const std::string &  role,
unsigned int  block = 0 
)
inlinevirtual

Add new plot.

Definition at line 250 of file vtkXYChartRepresentationInternals.h.

◆ GetInputArrayIndex()

virtual int vtkXYChartRepresentation::vtkInternals::GetInputArrayIndex ( const std::string &  vtkNotUsedtableName,
const std::string &  vtkNotUsedcolumnName,
const std::string &  vtkNotUsedrole 
)
inlinevirtual

Definition at line 265 of file vtkXYChartRepresentationInternals.h.

◆ UpdatePlots()

virtual void vtkXYChartRepresentation::vtkInternals::UpdatePlots ( vtkXYChartRepresentation *  self,
const MapOfTables &  tables 
)
inlinevirtual

Update i.e.

add/remove plots based on the data in the tables.

Definition at line 275 of file vtkXYChartRepresentationInternals.h.

◆ UpdatePlotProperties()

virtual void vtkXYChartRepresentation::vtkInternals::UpdatePlotProperties ( vtkXYChartRepresentation *  self)
inlinevirtual

Update properties for plots in the chart.

Definition at line 371 of file vtkXYChartRepresentationInternals.h.

◆ Export()

virtual bool vtkXYChartRepresentation::vtkInternals::Export ( vtkXYChartRepresentation *  self,
vtkAbstractChartExporter *  exporter 
)
inlinevirtual

Export visible plots to a CSV file.

Definition at line 420 of file vtkXYChartRepresentationInternals.h.

◆ IndexColumnName()

static const char* vtkXYChartRepresentation::vtkInternals::IndexColumnName ( )
inlinestaticprotected

Name of the index column added by AddIndexColumn().

Definition at line 459 of file vtkXYChartRepresentationInternals.h.

◆ AddIndexColumn()

static vtkSmartPointer<vtkTable> vtkXYChartRepresentation::vtkInternals::AddIndexColumn ( vtkTable *  table)
inlinestaticprotected

Returns a shallow copy of the table with an additional column, named IndexColumnName(), holding the row indices.

Definition at line 466 of file vtkXYChartRepresentationInternals.h.

◆ UpdateSinglePlotProperties()

virtual bool vtkXYChartRepresentation::vtkInternals::UpdateSinglePlotProperties ( vtkXYChartRepresentation *  self,
const std::string &  tableName,
const std::string &  columnName,
const std::string &  role,
vtkPlot *  plot 
)
inlineprotectedvirtual

Returns false for in-visible plots.

Definition at line 487 of file vtkXYChartRepresentationInternals.h.

Member Data Documentation

◆ SeriesPlots

PlotsMap vtkXYChartRepresentation::vtkInternals::SeriesPlots
protected

Definition at line 151 of file vtkXYChartRepresentationInternals.h.

◆ SeriesVisibilities

std::map<std::string, bool> vtkXYChartRepresentation::vtkInternals::SeriesVisibilities

Definition at line 196 of file vtkXYChartRepresentationInternals.h.

◆ SeriesOrder

std::map<std::string, int> vtkXYChartRepresentation::vtkInternals::SeriesOrder

Definition at line 197 of file vtkXYChartRepresentationInternals.h.

◆ LineThicknesses

std::map<std::string, int> vtkXYChartRepresentation::vtkInternals::LineThicknesses

Definition at line 198 of file vtkXYChartRepresentationInternals.h.

◆ LineStyles

std::map<std::string, int> vtkXYChartRepresentation::vtkInternals::LineStyles

Definition at line 199 of file vtkXYChartRepresentationInternals.h.

◆ Colors

std::map<std::string, vtkColor3d> vtkXYChartRepresentation::vtkInternals::Colors

Definition at line 200 of file vtkXYChartRepresentationInternals.h.

◆ Opacities

std::map<std::string, double> vtkXYChartRepresentation::vtkInternals::Opacities

Definition at line 201 of file vtkXYChartRepresentationInternals.h.

◆ AxisCorners

std::map<std::string, int> vtkXYChartRepresentation::vtkInternals::AxisCorners

Definition at line 202 of file vtkXYChartRepresentationInternals.h.

◆ MarkerStyles

std::map<std::string, int> vtkXYChartRepresentation::vtkInternals::MarkerStyles

Definition at line 203 of file vtkXYChartRepresentationInternals.h.

◆ MarkerSizes

std::map<std::string, double> vtkXYChartRepresentation::vtkInternals::MarkerSizes

Definition at line 204 of file vtkXYChartRepresentationInternals.h.

◆ Labels

std::map<std::string, std::string> vtkXYChartRepresentation::vtkInternals::Labels

Definition at line 205 of file vtkXYChartRepresentationInternals.h.

◆ UseColorMapping

std::map<std::string, bool> vtkXYChartRepresentation::vtkInternals::UseColorMapping

Definition at line 206 of file vtkXYChartRepresentationInternals.h.

◆ Lut

std::map<std::string, vtkScalarsToColors*> vtkXYChartRepresentation::vtkInternals::Lut

Definition at line 207 of file vtkXYChartRepresentationInternals.h.

◆ PreviousUseIndexForXAxis

bool vtkXYChartRepresentation::vtkInternals::PreviousUseIndexForXAxis

Definition at line 212 of file vtkXYChartRepresentationInternals.h.

◆ PreviousXAxisSeriesName

std::string vtkXYChartRepresentation::vtkInternals::PreviousXAxisSeriesName

Definition at line 213 of file vtkXYChartRepresentationInternals.h.


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