vtkPVWebExporter Class Reference

vtkPVWebExporter is used to produce vtkjs export in the ParaView application. More...

#include <vtkPVWebExporter.h>

Inherits vtkJSONSceneExporter.

Public Types
typedef vtkJSONSceneExporter	Superclass

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent) override
virtual void	SetParaViewGlanceHTML (std::string)
	Specify file name of the custom ParaViewGlance HTML file to use to embed the data in. More...
virtual std::string	GetParaViewGlanceHTML ()
	Specify file name of the custom ParaViewGlance HTML file to use to embed the data in. More...
virtual bool	GetExportToGlance ()
	In addition to writing the scene as a .vtkjs file, bundle its content encoded in base64 into a Kitware Glance viewer standalone HTML file. More...
virtual void	SetExportToGlance (bool)
	In addition to writing the scene as a .vtkjs file, bundle its content encoded in base64 into a Kitware Glance viewer standalone HTML file. More...
virtual bool	GetAutomaticGlanceHTML ()
	Ignore ParaViewGlanceHTML file path and try to find the ParaViewGlance.html file coming with the ParaView distribution. More...
virtual void	SetAutomaticGlanceHTML (bool)
	Ignore ParaViewGlanceHTML file path and try to find the ParaViewGlance.html file coming with the ParaView distribution. More...
virtual bool	GetDisableNetwork ()
	Disable components requiring network access through Girder in the Glance application, by forcing the URL parameter 'noGirder'. More...
virtual void	SetDisableNetwork (bool)
	Disable components requiring network access through Girder in the Glance application, by forcing the URL parameter 'noGirder'. More...

Static Public Member Functions
static vtkPVWebExporter *	New ()
static int	IsTypeOf (const char *type)
static vtkPVWebExporter *	SafeDownCast (vtkObject *o)

Protected Member Functions
	vtkPVWebExporter ()
	~vtkPVWebExporter () override
void	Write () override

Detailed Description

vtkPVWebExporter is used to produce vtkjs export in the ParaView application.

vtkPVWebExporter is used to produce scene export for web sharing.

Definition at line 17 of file vtkPVWebExporter.h.

Member Typedef Documentation

Superclass

typedef vtkJSONSceneExporter vtkPVWebExporter::Superclass

Definition at line 21 of file vtkPVWebExporter.h.

Constructor & Destructor Documentation

vtkPVWebExporter()

vtkPVWebExporter::vtkPVWebExporter ( )

protected

~vtkPVWebExporter()

vtkPVWebExporter::~vtkPVWebExporter ( )

overrideprotected

Member Function Documentation

New()

static vtkPVWebExporter* vtkPVWebExporter::New ( )

static

GetClassName()

virtual const char* vtkPVWebExporter::GetClassName ( )

virtual

IsTypeOf()

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

static

IsA()

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

virtual

SafeDownCast()

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

static

PrintSelf()

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

override

SetParaViewGlanceHTML()

virtual void vtkPVWebExporter::SetParaViewGlanceHTML ( std::string  )

virtual

Specify file name of the custom ParaViewGlance HTML file to use to embed the data in.

GetParaViewGlanceHTML()

virtual std::string vtkPVWebExporter::GetParaViewGlanceHTML ( )

virtual

Specify file name of the custom ParaViewGlance HTML file to use to embed the data in.

GetExportToGlance()

virtual bool vtkPVWebExporter::GetExportToGlance ( )

virtual

In addition to writing the scene as a .vtkjs file, bundle its content encoded in base64 into a Kitware Glance viewer standalone HTML file.

Defaults to true.

SetExportToGlance()

virtual void vtkPVWebExporter::SetExportToGlance ( bool  )

virtual

In addition to writing the scene as a .vtkjs file, bundle its content encoded in base64 into a Kitware Glance viewer standalone HTML file.

Defaults to true.

GetAutomaticGlanceHTML()

virtual bool vtkPVWebExporter::GetAutomaticGlanceHTML ( )

virtual

Ignore ParaViewGlanceHTML file path and try to find the ParaViewGlance.html file coming with the ParaView distribution.

This file is supposed to be in [PARAVIEW ROOT]/share/paraview-[VERSION]/web/glance/ParaViewGlance.html Defaults to true.

SetAutomaticGlanceHTML()

virtual void vtkPVWebExporter::SetAutomaticGlanceHTML ( bool  )

virtual

Ignore ParaViewGlanceHTML file path and try to find the ParaViewGlance.html file coming with the ParaView distribution.

This file is supposed to be in [PARAVIEW ROOT]/share/paraview-[VERSION]/web/glance/ParaViewGlance.html Defaults to true.

GetDisableNetwork()

virtual bool vtkPVWebExporter::GetDisableNetwork ( )

virtual

Disable components requiring network access through Girder in the Glance application, by forcing the URL parameter 'noGirder'.

This will inject a script reloading the page if the 'noGirder' parameter is not set, effectively preventing any external network call from the Glance webapp. Defaults to true (Girder disabled).

SetDisableNetwork()

virtual void vtkPVWebExporter::SetDisableNetwork ( bool  )

virtual

Disable components requiring network access through Girder in the Glance application, by forcing the URL parameter 'noGirder'.

This will inject a script reloading the page if the 'noGirder' parameter is not set, effectively preventing any external network call from the Glance webapp. Defaults to true (Girder disabled).

Write()

void vtkPVWebExporter::Write ( )

overrideprotected

---

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

• /builds/gitlab-kitware-sciviz-ci/Remoting/Export/vtkPVWebExporter.h