exporter used by certain views to export data into a file or stream. More...

#include <vtkAbstractChartExporter.h>

Inheritance diagram for vtkAbstractChartExporter:

[legend]

Collaboration diagram for vtkAbstractChartExporter:

[legend]

Public Types
enum	ExporterModes { STREAM_ROWS, STREAM_COLUMNS }

typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

virtual bool	Open (ExporterModes mode=STREAM_ROWS)=0
	Open the file and set mode in which the exporter is operating. More...

virtual void	Close ()=0
	Closes the file cleanly. More...

virtual void	Abort ()=0
	Same as Close except deletes the file, if created. More...

virtual void	AddColumn (vtkAbstractArray yarray, const char yarrayname=nullptr, vtkDataArray *xarray=nullptr)=0
	In STREAM_COLUMNS mode, use this method to add a column (`yarray`). More...

virtual void	AddStyle (vtkPlot plot, const char plotName)=0
	Attach information about the style of the plot (color,line type, marker type etc. More...

virtual void	SetGlobalStyle (vtkChart *chart)=0
	Set Global style elements like graph and axis titles. More...


virtual void	WriteHeader (vtkFieldData *)=0
	In STREAM_ROWS mode, use these methods to write column headers once using WriteHeader and then use WriteData as many times as needed to write out rows. More...

virtual void	WriteData (vtkFieldData *)=0
	In STREAM_ROWS mode, use these methods to write column headers once using WriteHeader and then use WriteData as many times as needed to write out rows. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual vtkMTimeType	GetMTime ()

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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 )

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

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

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)

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 )

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

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

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)

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)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkAbstractChartExporter *	New ()

static int	IsTypeOf (const char *type)

static vtkAbstractChartExporter *	SafeDownCast (vtkObject *o)

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

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

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

static vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkAbstractChartExporter ()

	~vtkAbstractChartExporter () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

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

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

exporter used by certain views to export data into a file or stream.

Definition at line 23 of file vtkAbstractChartExporter.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkAbstractChartExporter::Superclass

Definition at line 27 of file vtkAbstractChartExporter.h.

Member Enumeration Documentation

◆ ExporterModes

enum vtkAbstractChartExporter::ExporterModes

Enumerator
STREAM_ROWS
STREAM_COLUMNS

Definition at line 30 of file vtkAbstractChartExporter.h.

Constructor & Destructor Documentation

◆ vtkAbstractChartExporter()

vtkAbstractChartExporter::vtkAbstractChartExporter ( )

protected

◆ ~vtkAbstractChartExporter()

vtkAbstractChartExporter::~vtkAbstractChartExporter ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkAbstractChartExporter* vtkAbstractChartExporter::New ( )

static

◆ GetClassName()

virtual const char* vtkAbstractChartExporter::GetClassName ( )

virtual

Reimplemented in vtkCSVExporter, and vtkPlotlyJsonExporter.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkObjectBase.

Reimplemented in vtkCSVExporter, and vtkPlotlyJsonExporter.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

Reimplemented in vtkCSVExporter, and vtkPlotlyJsonExporter.

◆ Open()

virtual bool vtkAbstractChartExporter::Open ( ExporterModes mode = STREAM_ROWS )

pure virtual

Open the file and set mode in which the exporter is operating.

Implemented in vtkCSVExporter, and vtkPlotlyJsonExporter.

◆ Close()

virtual void vtkAbstractChartExporter::Close ( )

pure virtual

Closes the file cleanly.

Call this at the end to close the file and dump out any cached data.

Implemented in vtkCSVExporter, and vtkPlotlyJsonExporter.

◆ Abort()

virtual void vtkAbstractChartExporter::Abort ( )

pure virtual

Same as Close except deletes the file, if created.

This is useful to interrupt the exporting on failure.

Implemented in vtkCSVExporter, and vtkPlotlyJsonExporter.

◆ WriteHeader()

virtual void vtkAbstractChartExporter::WriteHeader ( vtkFieldData * )

pure virtual

In STREAM_ROWS mode, use these methods to write column headers once using WriteHeader and then use WriteData as many times as needed to write out rows.

Implemented in vtkCSVExporter, and vtkPlotlyJsonExporter.

◆ WriteData()

virtual void vtkAbstractChartExporter::WriteData ( vtkFieldData * )

pure virtual

In STREAM_ROWS mode, use these methods to write column headers once using WriteHeader and then use WriteData as many times as needed to write out rows.

Implemented in vtkCSVExporter, and vtkPlotlyJsonExporter.

◆ AddColumn()

virtual void vtkAbstractChartExporter::AddColumn	(	vtkAbstractArray *	yarray,
		const char *	yarrayname = `nullptr`,
		vtkDataArray *	xarray = `nullptr`
	)

pure virtual

In STREAM_COLUMNS mode, use this method to add a column (yarray).

One can assign it a name different the the name of the array using yarrayname. If xarray is not nullptr, then is used as the row-id. This makes it possible to add multiple columns with varying number of samples. The final output will have empty cells for missing values.

Implemented in vtkCSVExporter, and vtkPlotlyJsonExporter.

◆ AddStyle()

virtual void vtkAbstractChartExporter::AddStyle	(	vtkPlot *	plot,
		const char *	plotName
	)

pure virtual

Attach information about the style of the plot (color,line type, marker type etc.

To the plot accosiated with plotName. plotName should match the yarrayname used when adding the data via Add Column. AddColumn needs to be called before adding the style.

Implemented in vtkPlotlyJsonExporter.

◆ SetGlobalStyle()

virtual void vtkAbstractChartExporter::SetGlobalStyle ( vtkChart * chart )

pure virtual

Set Global style elements like graph and axis titles.

Each implementation is expected to get what it can support from the public vtkChart API.

Implemented in vtkPlotlyJsonExporter.

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

/builds/gitlab-kitware-sciviz-ci/VTKExtensions/FiltersRendering/vtkAbstractChartExporter.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ ExporterModes

Constructor & Destructor Documentation

◆ vtkAbstractChartExporter()

◆ ~vtkAbstractChartExporter()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ Open()

◆ Close()

◆ Abort()

◆ WriteHeader()

◆ WriteData()

◆ AddColumn()

◆ AddStyle()

◆ SetGlobalStyle()