Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkSpreadSheetView Class Reference

vtkSpreadSheetView is a vtkPVView subclass for a view used to show any data as a spreadsheet. More...

#include <vtkSpreadSheetView.h>

Inheritance diagram for vtkSpreadSheetView:
Inheritance graph
[legend]
Collaboration diagram for vtkSpreadSheetView:
Collaboration graph
[legend]

Public Types

typedef vtkPVView Superclass
 
- Public Types inherited from vtkPVView
typedef vtkView Superclass
 
- Public Types inherited from vtkView
typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void StillRender () override
 Triggers a high-resolution render. More...
 
void InteractiveRender () override
 Triggers a interactive render. More...
 
void Update () override
 Overridden to identify and locate the active-representation. More...
 
virtual vtkIdType GetNumberOfColumns ()
 Get the number of columns. More...
 
virtual vtkIdType GetNumberOfRows ()
 Get the number of rows. More...
 
virtual const char * GetColumnName (vtkIdType index)
 Returns the name for the column. More...
 
vtkIdType GetColumnByName (const char *columnName)
 Returns the column index for a column given its name. More...
 
virtual bool GetColumnVisibility (vtkIdType index)
 Returns the visibility for the column at the given index. More...
 
virtual bool IsRowSelected (vtkIdType row)
 Returns true if the row is selected. More...
 
virtual bool IsAvailable (vtkIdType row)
 Returns true is the data for the particular row is locally available. More...
 
virtual bool IsDataValid (vtkIdType row, vtkIdType col)
 Returns true of the data at the given row and column is valid. More...
 
void SetColumnNameToSort (const char *)
 Get/Set the column name to sort by. More...
 
void SetColumnNameToSort ()
 
void SetInvertSortOrder (bool)
 Get/Set whether the sort order must be Max to Min rather than Min to Max. More...
 
void SetBlockSize (vtkIdType val)
 Set the block size. More...
 
virtual bool Export (vtkCSVExporter *exporter)
 Export the contents of this view using the exporter. More...
 
void ClearCache ()
 Allow user to clear the cache if he needs to. More...
 
vtkTableFetchBlockCallback (vtkIdType blockindex)
 
virtual void SetIdentifier (vtkTypeUInt32)
 A unique identifier for this vtkSpreadSheetView across all processes. More...
 
virtual vtkTypeUInt32 GetIdentifier ()
 A unique identifier for this vtkSpreadSheetView across all processes. More...
 
void SetShowExtractedSelection (bool)
 Get/Set if the view shows extracted selection only or the actual data. More...
 
virtual void ShowExtractedSelectionOn ()
 Get/Set if the view shows extracted selection only or the actual data. More...
 
virtual void ShowExtractedSelectionOff ()
 Get/Set if the view shows extracted selection only or the actual data. More...
 
virtual bool GetShowExtractedSelection ()
 Get/Set if the view shows extracted selection only or the actual data. More...
 
virtual void SetGenerateCellConnectivity (bool)
 Allow user to enable/disable cell connectivity generation. More...
 
virtual bool GetGenerateCellConnectivity ()
 Allow user to enable/disable cell connectivity generation. More...
 
virtual void GenerateCellConnectivityOn ()
 Allow user to enable/disable cell connectivity generation. More...
 
virtual void GenerateCellConnectivityOff ()
 Allow user to enable/disable cell connectivity generation. More...
 
virtual void SetFieldAssociation (int)
 Specify the field association for the data to be shown in the view. More...
 
virtual int GetFieldAssociation ()
 Specify the field association for the data to be shown in the view. More...
 
void HideColumnByName (const char *columnName)
 This API enables the users to hide columns that should be shown. More...
 
bool IsColumnHiddenByName (const char *columnName)
 This API enables the users to hide columns that should be shown. More...
 
void ClearHiddenColumnsByName ()
 This API enables the users to hide columns that should be shown. More...
 
void HideColumnByLabel (const char *columnLabel)
 This API enables the users to hide columns that should be shown. More...
 
bool IsColumnHiddenByLabel (const std::string &columnLabel)
 This API enables the users to hide columns that should be shown. More...
 
void ClearHiddenColumnsByLabel ()
 This API enables the users to hide columns that should be shown. More...
 
virtual bool IsColumnInternal (vtkIdType index)
 Returns true if the column is internal. More...
 
virtual bool IsColumnInternal (const char *columnName)
 Returns true if the column is internal. More...
 
virtual std::string GetColumnLabel (vtkIdType index)
 Returns the user-friendly label to use for the column in the spreadsheet view. More...
 
virtual std::string GetColumnLabel (const char *columnName)
 Returns the user-friendly label to use for the column in the spreadsheet view. More...
 
virtual vtkVariant GetValue (vtkIdType row, vtkIdType col)
 Returns the value at given location. More...
 
virtual vtkVariant GetValueByName (vtkIdType row, const char *columnName)
 Returns the value at given location. More...
 
- Public Member Functions inherited from vtkPVView
virtual void SetPPI (int)
 Description: Set the screen PPI. More...
 
virtual int GetPPI ()
 
bool InTileDisplayMode ()
 Returns true if the application is currently in tile display mode. More...
 
bool InCaveDisplayMode ()
 Returns true if the application is currently in cave/immersive display mode. More...
 
bool GetLocalProcessSupportsInteraction ()
 Returns true if the local process can support interaction. More...
 
vtkRenderWindowGetRenderWindow ()
 If this view needs a render window (not all views may use one), this method can be used to get the render window associated with this view on the current process. More...
 
virtual void ScaleRendererViewports (const double viewport[4])
 vtkViewLayout calls this method to update the total viewport available for this view. More...
 
vtkMTimeType GetUpdateTimeStamp ()
 Provides access to the time when Update() was last called. More...
 
virtual void Deliver (int use_lod, unsigned int size, unsigned int *representation_ids)
 Called on all processes to request data-delivery for the list of representations. More...
 
virtual bool IsCached (vtkPVDataRepresentation *)
 Called in vtkPVDataRepresentation::ProcessViewRequest to check if the representation already has cached data. More...
 
virtual void ClearCache (vtkPVDataRepresentation *)
 Called by vtkPVDataRepresentation whenever vtkPVDataRepresentation::MarkModified is called. More...
 
virtual void SetPosition (int, int)
 Set the position on this view in the multiview configuration. More...
 
virtual intGetPosition ()
 Set the position on this view in the multiview configuration. More...
 
virtual void GetPosition (int &, int &)
 Set the position on this view in the multiview configuration. More...
 
virtual void GetPosition (int [2])
 Set the position on this view in the multiview configuration. More...
 
virtual void SetSize (int, int)
 Set the size of this view in the multiview configuration. More...
 
virtual intGetSize ()
 Set the size of this view in the multiview configuration. More...
 
virtual void GetSize (int &, int &)
 Set the size of this view in the multiview configuration. More...
 
virtual void GetSize (int [2])
 Set the size of this view in the multiview configuration. More...
 
virtual void SetViewTime (double value)
 Get/Set the time this view is showing. More...
 
virtual double GetViewTime ()
 Get/Set the time this view is showing. More...
 
virtual void SetCacheKey (double)
 Get/Set the cache key. More...
 
virtual double GetCacheKey ()
 Get/Set the cache key. More...
 
virtual void SetUseCache (bool)
 Get/Set whether caching is enabled. More...
 
virtual bool GetUseCache ()
 Get/Set whether caching is enabled. More...
 
virtual void PrepareForScreenshot ()
 These methods are used to setup the view for capturing screen shots. More...
 
virtual void CleanupAfterScreenshot ()
 These methods are used to setup the view for capturing screen shots. More...
 
void SetTileScale (int x, int y)
 When saving screenshots with tiling, these methods get called. More...
 
void SetTileViewport (double x0, double y0, double x1, double y1)
 When saving screenshots with tiling, these methods get called. More...
 
virtual void SetLogName (const std::string &name)
 This is solely intended to simplify debugging and use for any other purpose is vehemently discouraged. More...
 
const std::stringGetLogName () const
 This is solely intended to simplify debugging and use for any other purpose is vehemently discouraged. More...
 
void SetDeliveryManager (vtkPVDataDeliveryManager *)
 Provides access to data delivery & cache manager for this view. More...
 
virtual vtkPVDataDeliveryManagerGetDeliveryManager ()
 Provides access to data delivery & cache manager for this view. More...
 
- Public Member Functions inherited from vtkView
vtkViewNewInstance () const
 
void AddRepresentation (vtkDataRepresentation *rep)
 
void SetRepresentation (vtkDataRepresentation *rep)
 
vtkDataRepresentationAddRepresentationFromInputConnection (vtkAlgorithmOutput *conn)
 
vtkDataRepresentationSetRepresentationFromInputConnection (vtkAlgorithmOutput *conn)
 
vtkDataRepresentationAddRepresentationFromInput (vtkDataObject *input)
 
vtkDataRepresentationSetRepresentationFromInput (vtkDataObject *input)
 
void RemoveRepresentation (vtkDataRepresentation *rep)
 
void RemoveRepresentation (vtkAlgorithmOutput *rep)
 
void RemoveAllRepresentations ()
 
int GetNumberOfRepresentations ()
 
vtkDataRepresentationGetRepresentation (int index=0)
 
bool IsRepresentationPresent (vtkDataRepresentation *rep)
 
virtual void ApplyViewTheme (vtkViewTheme *vtkNotUsed(theme))
 
vtkCommandGetObserver ()
 
void RegisterProgress (vtkObject *algorithm, const char *message=NULL)
 
void UnRegisterProgress (vtkObject *algorithm)
 
- 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)
 
vtkCommandGetCommand (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)
 
vtkCommandGetCommand (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 vtkSpreadSheetViewNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSpreadSheetViewSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkPVView
static int IsTypeOf (const char *type)
 
static vtkPVViewSafeDownCast (vtkObject *o)
 
static void SetEnableStreaming (bool)
 
static bool GetEnableStreaming ()
 
static vtkInformationObjectBaseKeyVIEW ()
 Key used to pass the vtkPVView pointer to the representation during any of the view passes such as REQUEST_UPDATE(), REQUEST_UPDATE_LOD(), REQUEST_RENDER(), etc. More...
 
static vtkInformationRequestKeyREQUEST_UPDATE ()
 This is a Update-Data pass. More...
 
static vtkInformationRequestKeyREQUEST_UPDATE_LOD ()
 This is a Update-LOD-Data pass. More...
 
static vtkInformationRequestKeyREQUEST_RENDER ()
 This is a render pass. More...
 
static void SetPiece (vtkInformation *info, vtkPVDataRepresentation *repr, vtkDataObject *data, unsigned long trueSize=0, int port=0)
 
static vtkDataObjectGetPiece (vtkInformation *info, vtkPVDataRepresentation *repr, int port=0)
 
static vtkDataObjectGetDeliveredPiece (vtkInformation *info, vtkPVDataRepresentation *repr, int port=0)
 
static void SetPieceLOD (vtkInformation *info, vtkPVDataRepresentation *repr, vtkDataObject *data, unsigned long trueSize=0, int port=0)
 
static vtkDataObjectGetPieceLOD (vtkInformation *info, vtkPVDataRepresentation *repr, int port=0)
 
static vtkDataObjectGetDeliveredPieceLOD (vtkInformation *info, vtkPVDataRepresentation *repr, int port=0)
 
static void SetUseGenericOpenGLRenderWindow (bool val)
 Use this to indicate that the process should use vtkGenericOpenGLRenderWindow rather than vtkRenderWindow when creating an new render window. More...
 
static bool GetUseGenericOpenGLRenderWindow ()
 Use this to indicate that the process should use vtkGenericOpenGLRenderWindow rather than vtkRenderWindow when creating an new render window. More...
 
- Static Public Member Functions inherited from vtkView
static vtkViewNew ()
 
static int IsTypeOf (const char *type)
 
static vtkViewSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
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 vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Types

enum  { FETCH_BLOCK_TAG = 394732 }
 

Protected Member Functions

 vtkSpreadSheetView ()
 
 ~vtkSpreadSheetView () override
 
int StreamToClient ()
 On render streams all the data from the processes to the client. More...
 
void OnRepresentationUpdated ()
 
virtual vtkTableFetchBlock (vtkIdType blockindex)
 
- Protected Member Functions inherited from vtkPVView
 vtkPVView (bool create_render_window=true)
 
 ~vtkPVView () override
 
vtkRenderWindowNewRenderWindow ()
 Subclasses should use this method to create new render windows instead of directly creating a new one. More...
 
void SetRenderWindow (vtkRenderWindow *)
 Subclasses can use this method to set the render window created for this view. More...
 
void AllReduce (const vtkBoundingBox &source, vtkBoundingBox &dest)
 Reduce bounding box between all participating processes. More...
 
void AllReduce (vtkTypeUInt64 source, vtkTypeUInt64 &dest, int operation, bool skip_data_server=false)
 Reduce between all participating processes using the operation (vtkCommunicator::StandardOperations) specified. More...
 
vtkPVSessionGetSession ()
 
virtual bool GetInCaptureScreenshot ()
 Flag set to true between calls to PrepareForScreenshot and CleanupAfterScreenshot. More...
 
void AddRepresentationInternal (vtkDataRepresentation *rep) override
 Overridden to assign IDs to each representation. More...
 
void RemoveRepresentationInternal (vtkDataRepresentation *rep) override
 Overridden to assign IDs to each representation. More...
 
int CallProcessViewRequest (vtkInformationRequestKey *passType, vtkInformation *request, vtkInformationVector *reply)
 Subclasses can use this method to trigger a pass on all representations. More...
 
- Protected Member Functions inherited from vtkView
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkView ()
 
 ~vtkView ()
 
virtual vtkDataRepresentationCreateDefaultRepresentation (vtkAlgorithmOutput *conn)
 
virtual void ProcessEvents (vtkObject *caller, unsigned long eventId, void *callData)
 
virtual void AddRepresentationInternal (vtkDataRepresentation *vtkNotUsed(rep))
 
virtual void RemoveRepresentationInternal (vtkDataRepresentation *vtkNotUsed(rep))
 
virtual void ProcessEvents (vtkObject *caller, unsigned long eventId, void *callData)
 
virtual void AddRepresentationInternal (vtkDataRepresentation *vtkNotUsed(rep))
 
virtual void RemoveRepresentationInternal (vtkDataRepresentation *vtkNotUsed(rep))
 
virtual void SetReuseSingleRepresentation (bool)
 
virtual bool GetReuseSingleRepresentation ()
 
virtual void ReuseSingleRepresentationOn ()
 
virtual void ReuseSingleRepresentationOff ()
 
- 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 &)
 

Protected Attributes

bool ShowExtractedSelection
 
bool GenerateCellConnectivity
 
vtkSortedTableStreamerTableStreamer
 
vtkMarkSelectedRowsTableSelectionMarker
 
vtkReductionFilterReductionFilter
 
vtkClientServerMoveDataDeliveryFilter
 
vtkIdType NumberOfRows
 
unsigned long CRMICallbackTag
 
unsigned long PRMICallbackTag
 
vtkTypeUInt32 Identifier
 
- Protected Attributes inherited from vtkPVView
double ViewTime
 
double CacheKey
 
bool UseCache
 
int Size [2]
 
int Position [2]
 
int PPI
 
vtkTimeStamp UpdateTimeStamp
 Keeps track of the time when vtkPVRenderView::Update() was called. More...
 
vtkInformationRequestInformation
 These are passed as arguments to vtkDataRepresentation::ProcessViewRequest(). More...
 
vtkInformationVectorReplyInformationVector
 These are passed as arguments to vtkDataRepresentation::ProcessViewRequest(). More...
 
- Protected Attributes inherited from vtkView
bool ReuseSingleRepresentation
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class vtkInternals
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkPVView
static vtkPVDataDeliveryManagerGetDeliveryManager (vtkInformation *info)
 

Detailed Description

vtkSpreadSheetView is a vtkPVView subclass for a view used to show any data as a spreadsheet.

This view can only show one representation at a time. If more than one representation is added to this view, only the first visible representation will be shown.

Definition at line 40 of file vtkSpreadSheetView.h.

Member Typedef Documentation

◆ Superclass

Definition at line 44 of file vtkSpreadSheetView.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected
Enumerator
FETCH_BLOCK_TAG 

Definition at line 257 of file vtkSpreadSheetView.h.

Constructor & Destructor Documentation

◆ vtkSpreadSheetView()

vtkSpreadSheetView::vtkSpreadSheetView ( )
protected

◆ ~vtkSpreadSheetView()

vtkSpreadSheetView::~vtkSpreadSheetView ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkSpreadSheetView* vtkSpreadSheetView::New ( )
static

◆ GetClassName()

virtual const char* vtkSpreadSheetView::GetClassName ( )
virtual

Reimplemented from vtkPVView.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkPVView.

◆ SafeDownCast()

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

◆ PrintSelf()

void vtkSpreadSheetView::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Reimplemented from vtkPVView.

◆ SetIdentifier()

virtual void vtkSpreadSheetView::SetIdentifier ( vtkTypeUInt32  )
virtual

A unique identifier for this vtkSpreadSheetView across all processes.

◆ GetIdentifier()

virtual vtkTypeUInt32 vtkSpreadSheetView::GetIdentifier ( )
virtual

A unique identifier for this vtkSpreadSheetView across all processes.

◆ StillRender()

void vtkSpreadSheetView::StillRender ( )
inlineoverridevirtual

Triggers a high-resolution render.

Note
CallOnAllProcesses

Implements vtkPVView.

Definition at line 60 of file vtkSpreadSheetView.h.

◆ InteractiveRender()

void vtkSpreadSheetView::InteractiveRender ( )
inlineoverridevirtual

Triggers a interactive render.

Based on the settings on the view, this may result in a low-resolution rendering or a simplified geometry rendering.

Note
CallOnAllProcesses

Implements vtkPVView.

Definition at line 67 of file vtkSpreadSheetView.h.

◆ Update()

void vtkSpreadSheetView::Update ( )
overridevirtual

Overridden to identify and locate the active-representation.

Reimplemented from vtkPVView.

◆ SetShowExtractedSelection()

void vtkSpreadSheetView::SetShowExtractedSelection ( bool  )

Get/Set if the view shows extracted selection only or the actual data.

false by default.

Note
CallOnAllProcesses

◆ ShowExtractedSelectionOn()

virtual void vtkSpreadSheetView::ShowExtractedSelectionOn ( )
virtual

Get/Set if the view shows extracted selection only or the actual data.

false by default.

Note
CallOnAllProcesses

◆ ShowExtractedSelectionOff()

virtual void vtkSpreadSheetView::ShowExtractedSelectionOff ( )
virtual

Get/Set if the view shows extracted selection only or the actual data.

false by default.

Note
CallOnAllProcesses

◆ GetShowExtractedSelection()

virtual bool vtkSpreadSheetView::GetShowExtractedSelection ( )
virtual

Get/Set if the view shows extracted selection only or the actual data.

false by default.

Note
CallOnAllProcesses

◆ SetGenerateCellConnectivity()

virtual void vtkSpreadSheetView::SetGenerateCellConnectivity ( bool  )
virtual

Allow user to enable/disable cell connectivity generation.

◆ GetGenerateCellConnectivity()

virtual bool vtkSpreadSheetView::GetGenerateCellConnectivity ( )
virtual

Allow user to enable/disable cell connectivity generation.

◆ GenerateCellConnectivityOn()

virtual void vtkSpreadSheetView::GenerateCellConnectivityOn ( )
virtual

Allow user to enable/disable cell connectivity generation.

◆ GenerateCellConnectivityOff()

virtual void vtkSpreadSheetView::GenerateCellConnectivityOff ( )
virtual

Allow user to enable/disable cell connectivity generation.

◆ SetFieldAssociation()

virtual void vtkSpreadSheetView::SetFieldAssociation ( int  )
virtual

Specify the field association for the data to be shown in the view.

This is passed on to the vtkSpreadSheetRepresentation in Update pass.

◆ GetFieldAssociation()

virtual int vtkSpreadSheetView::GetFieldAssociation ( )
virtual

Specify the field association for the data to be shown in the view.

This is passed on to the vtkSpreadSheetRepresentation in Update pass.

◆ HideColumnByName()

void vtkSpreadSheetView::HideColumnByName ( const char *  columnName)

This API enables the users to hide columns that should be shown.

Columns can be hidden using their names or labels.

◆ IsColumnHiddenByName()

bool vtkSpreadSheetView::IsColumnHiddenByName ( const char *  columnName)

This API enables the users to hide columns that should be shown.

Columns can be hidden using their names or labels.

◆ ClearHiddenColumnsByName()

void vtkSpreadSheetView::ClearHiddenColumnsByName ( )

This API enables the users to hide columns that should be shown.

Columns can be hidden using their names or labels.

◆ HideColumnByLabel()

void vtkSpreadSheetView::HideColumnByLabel ( const char *  columnLabel)

This API enables the users to hide columns that should be shown.

Columns can be hidden using their names or labels.

◆ IsColumnHiddenByLabel()

bool vtkSpreadSheetView::IsColumnHiddenByLabel ( const std::string columnLabel)

This API enables the users to hide columns that should be shown.

Columns can be hidden using their names or labels.

◆ ClearHiddenColumnsByLabel()

void vtkSpreadSheetView::ClearHiddenColumnsByLabel ( )

This API enables the users to hide columns that should be shown.

Columns can be hidden using their names or labels.

◆ GetNumberOfColumns()

virtual vtkIdType vtkSpreadSheetView::GetNumberOfColumns ( )
virtual

Get the number of columns.

Note
CallOnClient

◆ GetNumberOfRows()

virtual vtkIdType vtkSpreadSheetView::GetNumberOfRows ( )
virtual

Get the number of rows.

Note
CallOnClient

◆ GetColumnName()

virtual const char* vtkSpreadSheetView::GetColumnName ( vtkIdType  index)
virtual

Returns the name for the column.

Note
CallOnClient

◆ IsColumnInternal() [1/2]

virtual bool vtkSpreadSheetView::IsColumnInternal ( vtkIdType  index)
virtual

Returns true if the column is internal.

◆ IsColumnInternal() [2/2]

virtual bool vtkSpreadSheetView::IsColumnInternal ( const char *  columnName)
virtual

Returns true if the column is internal.

◆ GetColumnLabel() [1/2]

virtual std::string vtkSpreadSheetView::GetColumnLabel ( vtkIdType  index)
virtual

Returns the user-friendly label to use for the column in the spreadsheet view.

If this->IsColumnInternal(..) is true for the chosen column. Then this method will return nullptr.

Note
CallOnClient

◆ GetColumnLabel() [2/2]

virtual std::string vtkSpreadSheetView::GetColumnLabel ( const char *  columnName)
virtual

Returns the user-friendly label to use for the column in the spreadsheet view.

If this->IsColumnInternal(..) is true for the chosen column. Then this method will return nullptr.

Note
CallOnClient

◆ GetColumnByName()

vtkIdType vtkSpreadSheetView::GetColumnByName ( const char *  columnName)

Returns the column index for a column given its name.

May return -1 is name is not valid or present.

◆ GetColumnVisibility()

virtual bool vtkSpreadSheetView::GetColumnVisibility ( vtkIdType  index)
virtual

Returns the visibility for the column at the given index.

◆ GetValue()

virtual vtkVariant vtkSpreadSheetView::GetValue ( vtkIdType  row,
vtkIdType  col 
)
virtual

Returns the value at given location.

This may result in collective operations is data is not available locally. This method can only be called on the CLIENT process for now.

Note
CallOnClient

◆ GetValueByName()

virtual vtkVariant vtkSpreadSheetView::GetValueByName ( vtkIdType  row,
const char *  columnName 
)
virtual

Returns the value at given location.

This may result in collective operations is data is not available locally. This method can only be called on the CLIENT process for now.

Note
CallOnClient

◆ IsRowSelected()

virtual bool vtkSpreadSheetView::IsRowSelected ( vtkIdType  row)
virtual

Returns true if the row is selected.

◆ IsAvailable()

virtual bool vtkSpreadSheetView::IsAvailable ( vtkIdType  row)
virtual

Returns true is the data for the particular row is locally available.

◆ IsDataValid()

virtual bool vtkSpreadSheetView::IsDataValid ( vtkIdType  row,
vtkIdType  col 
)
virtual

Returns true of the data at the given row and column is valid.

◆ SetColumnNameToSort() [1/2]

void vtkSpreadSheetView::SetColumnNameToSort ( const char *  )

Get/Set the column name to sort by.

Note
CallOnAllProcesses

◆ SetColumnNameToSort() [2/2]

void vtkSpreadSheetView::SetColumnNameToSort ( )
inline

Definition at line 201 of file vtkSpreadSheetView.h.

◆ SetInvertSortOrder()

void vtkSpreadSheetView::SetInvertSortOrder ( bool  )

Get/Set whether the sort order must be Max to Min rather than Min to Max.

Note
CallOnAllProcesses

◆ SetBlockSize()

void vtkSpreadSheetView::SetBlockSize ( vtkIdType  val)

Set the block size.

Note
CallOnAllProcesses

◆ Export()

virtual bool vtkSpreadSheetView::Export ( vtkCSVExporter exporter)
virtual

Export the contents of this view using the exporter.

◆ ClearCache()

void vtkSpreadSheetView::ClearCache ( )

Allow user to clear the cache if he needs to.

◆ FetchBlockCallback()

vtkTable* vtkSpreadSheetView::FetchBlockCallback ( vtkIdType  blockindex)

◆ StreamToClient()

int vtkSpreadSheetView::StreamToClient ( )
protected

On render streams all the data from the processes to the client.

Returns 0 on failure. Note: Was removed from update because you can't call update() while in an update

◆ OnRepresentationUpdated()

void vtkSpreadSheetView::OnRepresentationUpdated ( )
protected

◆ FetchBlock()

virtual vtkTable* vtkSpreadSheetView::FetchBlock ( vtkIdType  blockindex)
protectedvirtual

Friends And Related Function Documentation

◆ vtkInternals

friend class vtkInternals
friend

Definition at line 266 of file vtkSpreadSheetView.h.

Member Data Documentation

◆ ShowExtractedSelection

bool vtkSpreadSheetView::ShowExtractedSelection
protected

Definition at line 245 of file vtkSpreadSheetView.h.

◆ GenerateCellConnectivity

bool vtkSpreadSheetView::GenerateCellConnectivity
protected

Definition at line 246 of file vtkSpreadSheetView.h.

◆ TableStreamer

vtkSortedTableStreamer* vtkSpreadSheetView::TableStreamer
protected

Definition at line 247 of file vtkSpreadSheetView.h.

◆ TableSelectionMarker

vtkMarkSelectedRows* vtkSpreadSheetView::TableSelectionMarker
protected

Definition at line 248 of file vtkSpreadSheetView.h.

◆ ReductionFilter

vtkReductionFilter* vtkSpreadSheetView::ReductionFilter
protected

Definition at line 249 of file vtkSpreadSheetView.h.

◆ DeliveryFilter

vtkClientServerMoveData* vtkSpreadSheetView::DeliveryFilter
protected

Definition at line 250 of file vtkSpreadSheetView.h.

◆ NumberOfRows

vtkIdType vtkSpreadSheetView::NumberOfRows
protected

Definition at line 251 of file vtkSpreadSheetView.h.

◆ CRMICallbackTag

unsigned long vtkSpreadSheetView::CRMICallbackTag
protected

Definition at line 253 of file vtkSpreadSheetView.h.

◆ PRMICallbackTag

unsigned long vtkSpreadSheetView::PRMICallbackTag
protected

Definition at line 254 of file vtkSpreadSheetView.h.

◆ Identifier

vtkTypeUInt32 vtkSpreadSheetView::Identifier
protected

Definition at line 255 of file vtkSpreadSheetView.h.


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