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

#include <vtkPlotlyJsonExporter.h>

Inheritance diagram for vtkPlotlyJsonExporter:

Collaboration diagram for vtkPlotlyJsonExporter:

[legend]

Public Types
typedef vtkAbstractChartExporter	Superclass

enum	ExporterModes

Public Types inherited from vtkAbstractChartExporter
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

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

void	Close () override
	Closes the file cleanly. More...

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

void	AddColumn (vtkAbstractArray yarray, const char yarrayname=nullptr, vtkDataArray *xarray=nullptr) override
	Add a new plot using xarray as "x" values and yarray as "y" values. More...

void	AddStyle (vtkPlot plot, const char plotName) override
	Add the stringified `attribute` under then name `attributeName` in the Adios file. More...

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

std::string	GetOutputString () const


virtual void	SetFileName (const char *)
	Get/Set the filename for the file. More...

virtual char *	GetFileName ()
	Get/Set the filename for the file. More...


void	WriteHeader (vtkFieldData *) override
	No Supported by vtkPlotlyJsonExporter. More...

void	WriteData (vtkFieldData *) override
	No Supported by vtkPlotlyJsonExporter. More...


virtual void	SetWriteToOutputString (bool)
	Whether to output to a string instead of to a file which is the default. More...

virtual bool	GetWriteToOutputString ()
	Whether to output to a string instead of to a file which is the default. More...

virtual void	WriteToOutputStringOn ()
	Whether to output to a string instead of to a file which is the default. More...

virtual void	WriteToOutputStringOff ()
	Whether to output to a string instead of to a file which is the default. 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 vtkPlotlyJsonExporter *	New ()

static int	IsTypeOf (const char *type)

static vtkPlotlyJsonExporter *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkAbstractChartExporter
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
	vtkPlotlyJsonExporter ()

	~vtkPlotlyJsonExporter () override

Protected Member Functions inherited from vtkAbstractChartExporter
	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 17 of file vtkPlotlyJsonExporter.h.

Member Typedef Documentation

◆ Superclass

typedef vtkAbstractChartExporter vtkPlotlyJsonExporter::Superclass

Definition at line 22 of file vtkPlotlyJsonExporter.h.

Member Enumeration Documentation

◆ ExporterModes

enum vtkAbstractChartExporter::ExporterModes

Definition at line 30 of file vtkAbstractChartExporter.h.

Constructor & Destructor Documentation

◆ vtkPlotlyJsonExporter()

vtkPlotlyJsonExporter::vtkPlotlyJsonExporter ( )

protected

◆ ~vtkPlotlyJsonExporter()

vtkPlotlyJsonExporter::~vtkPlotlyJsonExporter ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkPlotlyJsonExporter* vtkPlotlyJsonExporter::New ( )

static

◆ GetClassName()

virtual const char* vtkPlotlyJsonExporter::GetClassName ( )

virtual

Reimplemented from vtkAbstractChartExporter.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkAbstractChartExporter.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkAbstractChartExporter.

◆ SetFileName()

virtual void vtkPlotlyJsonExporter::SetFileName ( const char * )

virtual

Get/Set the filename for the file.

◆ GetFileName()

virtual char* vtkPlotlyJsonExporter::GetFileName ( )

virtual

Get/Set the filename for the file.

◆ Open()

bool vtkPlotlyJsonExporter::Open ( ExporterModes mode = STREAM_ROWS )

overridevirtual

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

Implements vtkAbstractChartExporter.

◆ Close()

void vtkPlotlyJsonExporter::Close ( )

overridevirtual

Closes the file cleanly.

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

Implements vtkAbstractChartExporter.

◆ Abort()

void vtkPlotlyJsonExporter::Abort ( )

overridevirtual

Same as Close except deletes the file, if created.

This is useful to interrupt the exporting on failure.

Implements vtkAbstractChartExporter.

◆ WriteHeader()

void vtkPlotlyJsonExporter::WriteHeader ( vtkFieldData * )

overridevirtual

No Supported by vtkPlotlyJsonExporter.

Implements vtkAbstractChartExporter.

◆ WriteData()

void vtkPlotlyJsonExporter::WriteData ( vtkFieldData * )

overridevirtual

No Supported by vtkPlotlyJsonExporter.

Implements vtkAbstractChartExporter.

◆ AddColumn()

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

overridevirtual

Add a new plot using xarray as "x" values and yarray as "y" values.

The name of the plot will be yarrayname

Implements vtkAbstractChartExporter.

◆ AddStyle()

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

overridevirtual

Add the stringified attribute under then name attributeName in the Adios file.

Implements vtkAbstractChartExporter.

◆ SetGlobalStyle()

void vtkPlotlyJsonExporter::SetGlobalStyle ( vtkChart * chart )

overridevirtual

Set Global style elements like graph and axis titles.

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

Implements vtkAbstractChartExporter.

◆ SetWriteToOutputString()

virtual void vtkPlotlyJsonExporter::SetWriteToOutputString ( bool )

virtual

Whether to output to a string instead of to a file which is the default.

◆ GetWriteToOutputString()

virtual bool vtkPlotlyJsonExporter::GetWriteToOutputString ( )

virtual

Whether to output to a string instead of to a file which is the default.

◆ WriteToOutputStringOn()

virtual void vtkPlotlyJsonExporter::WriteToOutputStringOn ( )

virtual

Whether to output to a string instead of to a file which is the default.

◆ WriteToOutputStringOff()

virtual void vtkPlotlyJsonExporter::WriteToOutputStringOff ( )

virtual

Whether to output to a string instead of to a file which is the default.

◆ GetOutputString()

std::string vtkPlotlyJsonExporter::GetOutputString ( ) const

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

/builds/gitlab-kitware-sciviz-ci/VTKExtensions/FiltersRendering/vtkPlotlyJsonExporter.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

◆ vtkPlotlyJsonExporter()

◆ ~vtkPlotlyJsonExporter()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ SetFileName()

◆ GetFileName()

◆ Open()

◆ Close()

◆ Abort()

◆ WriteHeader()

◆ WriteData()

◆ AddColumn()

◆ AddStyle()

◆ SetGlobalStyle()

◆ SetWriteToOutputString()

◆ GetWriteToOutputString()

◆ WriteToOutputStringOn()

◆ WriteToOutputStringOff()

◆ GetOutputString()