Slicer  4.11
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes
vtkMRMLPlotChartNode Class Reference

MRML node for referencing a collection of data to plot. More...

#include <Libs/MRML/Core/vtkMRMLPlotChartNode.h>

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

Public Types

enum  { PlotModifiedEvent = 17000 }
 
enum  PlotSeriesNodeProperty { PlotType, PlotXColumnName, PlotYColumnName, PlotMarkerStyle }
 Properties used by SetPropertyToAllPlotSeriesNodes() and GetPropertyFromAllPlotSeriesNodes() methods. More...
 
typedef vtkMRMLNode Superclass
 
- Public Types inherited from vtkMRMLNode
enum  {
  HierarchyModifiedEvent = 16000, IDChangedEvent = 16001, ReferenceAddedEvent, ReferenceModifiedEvent,
  ReferenceRemovedEvent, ReferencedNodeModifiedEvent
}
 
typedef vtkObject Superclass
 

Public Member Functions

void AddAndObservePlotSeriesNodeID (const char *plotSeriesNodeID)
 
void Copy (vtkMRMLNode *node) override
 
Copy the node's attributes to this object. More...
 
vtkMRMLNodeCreateNodeInstance () override
 Create instance of the default node. Like New only virtual. More...
 
virtual void EnablePointMoveAlongXOff ()
 
virtual void EnablePointMoveAlongXOn ()
 
virtual void EnablePointMoveAlongYOff ()
 
virtual void EnablePointMoveAlongYOn ()
 
virtual int GetAxisLabelFontSize ()
 
virtual int GetAxisTitleFontSize ()
 
virtual const char * GetClassName ()
 
virtual bool GetEnablePointMoveAlongX ()
 
virtual bool GetEnablePointMoveAlongY ()
 
virtual char * GetFontType ()
 
virtual bool GetGridVisibility ()
 
virtual int GetLegendFontSize ()
 
virtual bool GetLegendVisibility ()
 
const char * GetNodeTagName () override
 
Get node XML tag name (like Volume, Model). More...
 
vtkMRMLPlotSeriesNodeGetNthPlotSeriesNode (int n)
 
const char * GetNthPlotSeriesNodeID (int n)
 
Return the ID of n-th plot data node ID. Or 0 if no such node exist. More...
 
int GetNumberOfPlotSeriesNodes ()
 
vtkMRMLPlotSeriesNodeGetPlotSeriesNode ()
 
const char * GetPlotSeriesNodeID ()
 Access methods. More...
 
virtual int GetPlotSeriesNodeIDs (std::vector< std::string > &plotSeriesNodeIDs)
 
Get IDs of all associated plot data nodes. More...
 
int GetPlotSeriesNodeIndexFromID (const char *plotSeriesNodeID)
 
virtual int GetPlotSeriesNodeNames (std::vector< std::string > &plotSeriesNodeNames)
 
Get names of all associated plot data nodes. More...
 
virtual const char * GetPlotSeriesNodeReferenceRole ()
 Node reference role used for storing plot data node references. More...
 
bool GetPropertyFromAllPlotSeriesNodes (PlotSeriesNodeProperty plotProperty, std::string &value)
 
virtual char * GetTitle ()
 
virtual int GetTitleFontSize ()
 
virtual bool GetTitleVisibility ()
 
virtual bool GetXAxisLogScale ()
 
virtual double * GetXAxisRange ()
 
virtual void GetXAxisRange (double &, double &)
 
virtual void GetXAxisRange (double [2])
 
virtual bool GetXAxisRangeAuto ()
 
virtual char * GetXAxisTitle ()
 
virtual bool GetXAxisTitleVisibility ()
 
virtual bool GetYAxisLogScale ()
 
virtual double * GetYAxisRange ()
 
virtual void GetYAxisRange (double &, double &)
 
virtual void GetYAxisRange (double [2])
 
virtual bool GetYAxisRangeAuto ()
 
virtual char * GetYAxisTitle ()
 
virtual bool GetYAxisTitleVisibility ()
 
virtual void GridVisibilityOff ()
 
virtual void GridVisibilityOn ()
 Show horizontal and vertical grid lines. More...
 
bool HasPlotSeriesNodeID (const char *plotSeriesNodeID)
 
Return true if PlotSeriesNodeID is in the plot node ID list. More...
 
virtual int IsA (const char *type)
 
virtual void LegendVisibilityOff ()
 
virtual void LegendVisibilityOn ()
 Show horizontal and vertical grid lines. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void ProcessMRMLEvents (vtkObject *caller, unsigned long event, void *callData) override
 
Method to propagate events generated in mrml. More...
 
void ReadXMLAttributes (const char **atts) override
 
Set node attributes. More...
 
void RemoveAllPlotSeriesNodeIDs ()
 
Remove all plot data nodes from the chart. More...
 
void RemoveNthPlotSeriesNodeID (int n)
 
void RemovePlotSeriesNodeID (const char *plotSeriesNodeID)
 
void SetAndObserveNthPlotSeriesNodeID (int n, const char *plotSeriesNodeID)
 
void SetAndObservePlotSeriesNodeID (const char *plotSeriesNodeID)
 
virtual void SetAxisLabelFontSize (int)
 Axis label font size. Default: 12. More...
 
virtual void SetAxisTitleFontSize (int)
 Axis title font size. Default: 16. More...
 
virtual void SetEnablePointMoveAlongX (bool)
 
virtual void SetEnablePointMoveAlongY (bool)
 
virtual void SetFontType (const char *)
 Font type for all text in the chart: "Arial", "Times", "Courier". More...
 
virtual void SetGridVisibility (bool)
 
virtual void SetLegendFontSize (int)
 Title font size. Default: 20. More...
 
virtual void SetLegendVisibility (bool)
 
void SetPropertyToAllPlotSeriesNodes (PlotSeriesNodeProperty plotProperty, const char *value)
 Helper function to set common properties for all associated plot data nodes. More...
 
virtual void SetTitle (const char *)
 Title of the chart. More...
 
virtual void SetTitleFontSize (int)
 Title font size. Default: 20. More...
 
virtual void SetTitleVisibility (bool)
 
virtual void SetXAxisLogScale (bool)
 
void SetXAxisRange (double [2])
 
virtual void SetXAxisRange (double, double)
 
virtual void SetXAxisRangeAuto (bool)
 
virtual void SetXAxisTitle (const char *)
 Title of X axis. More...
 
virtual void SetXAxisTitleVisibility (bool)
 
virtual void SetYAxisLogScale (bool)
 
virtual void SetYAxisRange (double, double)
 
void SetYAxisRange (double [2])
 
virtual void SetYAxisRangeAuto (bool)
 
virtual void SetYAxisTitle (const char *)
 Title of Y axis. More...
 
virtual void SetYAxisTitleVisibility (bool)
 
virtual void TitleVisibilityOff ()
 
virtual void TitleVisibilityOn ()
 Show title of the chart. More...
 
void WriteXML (ostream &of, int indent) override
 
Write this node's information to a MRML file in XML format. More...
 
virtual void XAxisLogScaleOff ()
 
virtual void XAxisLogScaleOn ()
 
virtual void XAxisRangeAutoOff ()
 
virtual void XAxisRangeAutoOn ()
 
virtual void XAxisTitleVisibilityOff ()
 
virtual void XAxisTitleVisibilityOn ()
 Show title of X axis. More...
 
virtual void YAxisLogScaleOff ()
 
virtual void YAxisLogScaleOn ()
 
virtual void YAxisRangeAutoOff ()
 
virtual void YAxisRangeAutoOn ()
 
virtual void YAxisTitleVisibilityOff ()
 
virtual void YAxisTitleVisibilityOn ()
 Show title of Y axis. More...
 
- Public Member Functions inherited from vtkMRMLNode
vtkMRMLNodeAddAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr)
 Add and observe a reference node from this node for a specific referenceRole. More...
 
vtkMRMLNodeAddNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Convenience method that adds a referencedNodeID at the end of the list. More...
 
void AddNodeReferenceRole (const char *referenceRole, const char *mrmlAttributeName=nullptr, vtkIntArray *events=nullptr)
 Add a referenceRole. More...
 
virtual void AddToSceneOff ()
 
virtual void AddToSceneOn ()
 
virtual void CopyReferences (vtkMRMLNode *node)
 Copy the references of the node into this. More...
 
void CopyWithoutModifiedEvent (vtkMRMLNode *node)
 
void CopyWithScene (vtkMRMLNode *node)
 Copy everything (including Scene and ID) from another node of the same type. More...
 
void CopyWithSceneWithSingleModifiedEvent (vtkMRMLNode *node)
 Copy everything (including Scene and ID) from another node of the same type. More...
 
void CopyWithSingleModifiedEvent (vtkMRMLNode *node)
 
void DisableModifiedEventOff ()
 
void DisableModifiedEventOn ()
 
virtual int EndModify (int previousDisableModifiedEventState)
 End modifying the node. More...
 
virtual int GetAddToScene ()
 node added to MRML scene. More...
 
const char * GetAttribute (const char *name)
 Get value of a name value pair attribute. More...
 
std::vector< std::string > GetAttributeNames ()
 Get all attribute names. More...
 
void GetAttributeNames (vtkStringArray *attributeNames)
 Get all attribute names. Python-wrappable version. More...
 
virtual char * GetDescription ()
 
virtual int GetDisableModifiedEvent ()
 Turn on/off generating InvokeEvent for set macros. More...
 
virtual int GetHideFromEditors ()
 Describes if the node is hidden. More...
 
virtual char * GetID ()
 ID use by other nodes to reference this node in XML. More...
 
virtual int GetInMRMLCallbackFlag ()
 Flags to avoid event loops. More...
 
virtual int GetModifiedEventPending ()
 
virtual char * GetName ()
 
vtkMRMLNodeGetNodeReference (const char *referenceRole)
 
const char * GetNodeReferenceID (const char *referenceRole)
 Utility function that returns the first node id for a specific referenceRole. More...
 
void GetNodeReferenceIDs (const char *referenceRole, std::vector< const char *> &referencedNodeIDs)
 Return a list of the referenced node IDs. More...
 
void GetNodeReferenceRoles (std::vector< std::string > &roles)
 
void GetNodeReferences (const char *referenceRole, std::vector< vtkMRMLNode *> &nodes)
 Return a list of the referenced nodes. More...
 
vtkMRMLNodeGetNthNodeReference (const char *referenceRole, int n)
 Get referenced MRML node for a specific referenceRole. More...
 
const char * GetNthNodeReferenceID (const char *referenceRole, int n)
 Return the string of the Nth node ID for a specific reference role. More...
 
const char * GetNthNodeReferenceRole (int n)
 
int GetNumberOfNodeReferenceRoles ()
 
int GetNumberOfNodeReferences (const char *referenceRole)
 Return the number of node IDs for a specific reference role (and nodes as they always have the same size). More...
 
virtual int GetSaveWithScene ()
 Save node with MRML scene. More...
 
virtual vtkMRMLSceneGetScene ()
 Get the scene this node has been added to. More...
 
virtual int GetSelectable ()
 Describes if the node is selectable. More...
 
virtual int GetSelected ()
 Get/Set for Selected. More...
 
virtual char * GetSingletonTag ()
 
virtual bool GetUndoEnabled ()
 
bool HasNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Return true if referencedNodeID is in the node ID list for a specific referenceRole. More...
 
virtual void HideFromEditorsOff ()
 
virtual void HideFromEditorsOn ()
 
virtual void InvokeCustomModifiedEvent (int eventId, void *callData=nullptr)
 This method allows the node to compress events. More...
 
virtual int InvokePendingModifiedEvent ()
 Invokes any modified events that are pending. More...
 
bool IsSingleton ()
 
void Modified () override
 Customized version of Modified() allowing to compress vtkCommand::ModifiedEvent. More...
 
virtual void OnNodeAddedToScene ()
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual void ProcessChildNode (vtkMRMLNode *)
 Set dependencies between this node and a child node when parsing XML file. More...
 
void RemoveAttribute (const char *name)
 Remove attribute with the specified name. More...
 
void RemoveNodeReferenceIDs (const char *referenceRole)
 Remove all node IDs and associated nodes for a specific referenceRole. More...
 
void RemoveNthNodeReferenceID (const char *referenceRole, int n)
 Convenience method that removes the Nth node ID from the list. More...
 
virtual void Reset (vtkMRMLNode *defaultNode)
 Reset node attributes to the initial state as defined in the constructor or the passed default node. More...
 
virtual void SaveWithSceneOff ()
 
virtual void SaveWithSceneOn ()
 
virtual void SelectableOff ()
 
virtual void SelectableOn ()
 
virtual void SelectedOff ()
 
virtual void SelectedOn ()
 
virtual void SetAddToScene (int)
 
void SetAddToSceneNoModify (int value)
 
vtkMRMLNodeSetAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr)
 Set and observe a reference node from this node for a specific referenceRole. More...
 
vtkMRMLNodeSetAndObserveNthNodeReferenceID (const char *referenceRole, int n, const char *referencedNodeID, vtkIntArray *events=nullptr)
 Set and observe the Nth node ID for a specific reference role. More...
 
void SetAttribute (const char *name, const char *value)
 Set a name value pair attribute. More...
 
virtual void SetDescription (const char *)
 Text description of this node, to be set by the user. More...
 
void SetDisableModifiedEvent (int onOff)
 
virtual void SetHideFromEditors (int)
 
void SetInMRMLCallbackFlag (int flag)
 
virtual void SetName (const char *)
 Name of this node, to be set by the user. More...
 
vtkMRMLNodeSetNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Set a reference to a node with specified nodeID from this node for a specific referenceRole. More...
 
vtkMRMLNodeSetNthNodeReferenceID (const char *referenceRole, int n, const char *referencedNodeID)
 Set a N-th reference from this node with specified referencedNodeID for a specific referenceRole. More...
 
virtual void SetSaveWithScene (int)
 
virtual void SetScene (vtkMRMLScene *scene)
 This method is for internal use only. Use AddNode method of vtkMRMLScene to add a node to the scene. More...
 
virtual void SetSceneReferences ()
 Update the references of the node to the scene. More...
 
virtual void SetSelectable (int)
 
virtual void SetSelected (int)
 
void SetSingletonOff ()
 
void SetSingletonOn ()
 
virtual void SetSingletonTag (const char *)
 Tag that make this node a singleton in the scene. More...
 
virtual void SetUndoEnabled (bool)
 
virtual int StartModify ()
 Start modifying the node. Disable Modify events. More...
 
virtual void UndoEnabledOff ()
 
virtual void UndoEnabledOn ()
 
virtual void UpdateReferenceID (const char *oldID, const char *newID)
 Update the stored reference to another node in the scene. More...
 
virtual void UpdateReferences ()
 The method should remove all pointers and observations to all nodes that are not in the scene anymore. More...
 
virtual void UpdateScene (vtkMRMLScene *)
 
const char * URLDecodeString (const char *inString)
 Decode a URL string. More...
 
const char * URLEncodeString (const char *inString)
 Encode a URL string. More...
 
virtual void WriteNodeBodyXML (ostream &of, int indent)
 Write this node's body to a MRML file in XML format. More...
 
std::string XMLAttributeDecodeString (const std::string &inString)
 Decode an XML attribute string. More...
 
std::string XMLAttributeEncodeString (const std::string &inString)
 Encode an XML attribute string (replaces special characters by code sequences) More...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkMRMLPlotChartNodeNew ()
 Standard methods for MRML nodes. More...
 
static vtkMRMLPlotChartNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLNode
static int IsTypeOf (const char *type)
 
static vtkMRMLNodeSafeDownCast (vtkObject *o)
 

Protected Member Functions

void OnNodeReferenceAdded (vtkMRMLNodeReference *reference) override
 
Called when a node reference ID is added (list size increased). More...
 
void OnNodeReferenceModified (vtkMRMLNodeReference *reference) override
 
Called when a node reference ID is modified. More...
 
void OnNodeReferenceRemoved (vtkMRMLNodeReference *reference) override
 
Called after a node reference ID is removed (list size decreased). More...
 
void operator= (const vtkMRMLPlotChartNode &)
 
 vtkMRMLPlotChartNode ()
 Constructor and destructor. More...
 
 vtkMRMLPlotChartNode (const vtkMRMLPlotChartNode &)
 
 ~vtkMRMLPlotChartNode () override
 
- Protected Member Functions inherited from vtkMRMLNode
virtual const char * GetMRMLAttributeNameFromReferenceRole (const char *refRole)
 Return the mrml attribute name (if found) associated with a reference role. Return 0 otherwise. More...
 
virtual const char * GetReferenceRoleFromMRMLAttributeName (const char *attName)
 Return the reference role (if found) associated with the attribute name found in a MRML scene file. Return 0 otherwise. More...
 
virtual char * GetTempURLString ()
 
void GetUpdatedReferencedNodeEventList (int &oldReferencedNodeUseCount, int &newReferencedNodeUseCount, vtkIntArray *oldConsolidatedEventList, vtkIntArray *newConsolidatedEventList, vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkMRMLNodeReference *referenceToIgnore, vtkIntArray *newEvents)
 
virtual void InvalidateNodeReferences ()
 
virtual bool IsReferenceRoleGeneric (const char *refRole)
 Return true if the reference role is generic (ends with '/') or false otherwise. More...
 
void operator= (const vtkMRMLNode &)
 
void ParseReferencesAttribute (const char *attValue, std::map< std::string, std::string > &references)
 
virtual void SetTempURLString (const char *)
 Get/Set the string used to manage encoding/decoding of strings/URLs with special characters. More...
 
vtkMRMLNodeUpdateNodeReferenceEventObserver (vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkIntArray *newEvents, vtkMRMLNodeReference *referenceToIgnore)
 
virtual void UpdateNodeReferences (const char *referenceRole=nullptr)
 
virtual void UpdateNthNodeReference (const char *referenceRole, int n)
 
 vtkMRMLNode ()
 
 vtkMRMLNode (const vtkMRMLNode &)
 
 ~vtkMRMLNode () override
 critical to have a virtual destructor! More...
 

Protected Attributes

int AxisLabelFontSize
 
int AxisTitleFontSize
 
bool EnablePointMoveAlongX
 
bool EnablePointMoveAlongY
 
char * FontType
 
bool GridVisibility
 
int LegendFontSize
 
bool LegendVisibility
 
char * Title
 
int TitleFontSize
 
bool TitleVisibility
 
bool XAxisLogScale
 
double XAxisRange [2]
 
bool XAxisRangeAuto
 
char * XAxisTitle
 
bool XAxisTitleVisibility
 
bool YAxisLogScale
 
double YAxisRange [2]
 
bool YAxisRangeAuto
 
char * YAxisTitle
 
bool YAxisTitleVisibility
 
- Protected Attributes inherited from vtkMRMLNode
int AddToScene
 
AttributesType Attributes
 
char * Description
 
int HideFromEditors
 
char * ID
 
int InMRMLCallbackFlag
 
Flag to avoid event loops More...
 
vtkCallbackCommand * MRMLCallbackCommand
 Holders for MRML callbacks. More...
 
vtkObserverManagerMRMLObserverManager
 
char * Name
 
NodeReferenceEventsType NodeReferenceEvents
 
std::map< std::string, std::string > NodeReferenceMRMLAttributeNames
 
NodeReferencesType NodeReferences
 
int SaveWithScene
 
vtkWeakPointer< vtkMRMLSceneScene
 
int Selectable
 
int Selected
 
bool UndoEnabled
 

Static Protected Attributes

static const char * PlotSeriesNodeReferenceRole
 

Additional Inherited Members

- Protected Types inherited from vtkMRMLNode
typedef std::map< std::string, std::string > AttributesType
 
typedef std::map< std::string, vtkSmartPointer< vtkIntArray > > NodeReferenceEventsType
 
typedef std::vector< vtkSmartPointer< vtkMRMLNodeReference > > NodeReferenceListType
 
typedef std::map< std::string, NodeReferenceListTypeNodeReferencesType
 
- Static Protected Member Functions inherited from vtkMRMLNode
static void MRMLCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
 

Detailed Description

MRML node for referencing a collection of data to plot.

Definition at line 33 of file vtkMRMLPlotChartNode.h.

Member Typedef Documentation

◆ Superclass

Definition at line 41 of file vtkMRMLPlotChartNode.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

PlotModifiedEvent is fired when:

  • a new plot node is observed
  • a plot node is not longer observed
  • an associated plot node is modified Note that when SetAndObserve(Nth)NodeID() is called with an ID that has not yet any associated plot node in the scene, then plotModifiedEvent is not fired until found for the first time in the scene, e.g. Get(Nth)PlotSeriesNode(), UpdateScene()...
Enumerator
PlotModifiedEvent 

Definition at line 77 of file vtkMRMLPlotChartNode.h.

◆ PlotSeriesNodeProperty

Properties used by SetPropertyToAllPlotSeriesNodes() and GetPropertyFromAllPlotSeriesNodes() methods.

Enumerator
PlotType 
PlotXColumnName 
PlotYColumnName 
PlotMarkerStyle 

Definition at line 83 of file vtkMRMLPlotChartNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLPlotChartNode() [1/2]

vtkMRMLPlotChartNode::vtkMRMLPlotChartNode ( )
protected

Constructor and destructor.

◆ ~vtkMRMLPlotChartNode()

vtkMRMLPlotChartNode::~vtkMRMLPlotChartNode ( )
overrideprotected

◆ vtkMRMLPlotChartNode() [2/2]

vtkMRMLPlotChartNode::vtkMRMLPlotChartNode ( const vtkMRMLPlotChartNode )
protected

Member Function Documentation

◆ AddAndObservePlotSeriesNodeID()

void vtkMRMLPlotChartNode::AddAndObservePlotSeriesNodeID ( const char *  plotSeriesNodeID)

Adds a plot data node to the chart.

See also
SetAndObserverNthPlotSeriesNodeID(int, const char*)

◆ Copy()

void vtkMRMLPlotChartNode::Copy ( vtkMRMLNode node)
overridevirtual


Copy the node's attributes to this object.

Reimplemented from vtkMRMLNode.

◆ CreateNodeInstance()

vtkMRMLNode* vtkMRMLPlotChartNode::CreateNodeInstance ( )
overridevirtual

Create instance of the default node. Like New only virtual.

Note
Subclasses should implement this method

Implements vtkMRMLNode.

◆ EnablePointMoveAlongXOff()

virtual void vtkMRMLPlotChartNode::EnablePointMoveAlongXOff ( )
virtual

◆ EnablePointMoveAlongXOn()

virtual void vtkMRMLPlotChartNode::EnablePointMoveAlongXOn ( )
virtual

Enable moving of data points along X axis by click-and-drag in plot views. Points may only be moved in the view if moving is enabled in the plot view node as well.

◆ EnablePointMoveAlongYOff()

virtual void vtkMRMLPlotChartNode::EnablePointMoveAlongYOff ( )
virtual

◆ EnablePointMoveAlongYOn()

virtual void vtkMRMLPlotChartNode::EnablePointMoveAlongYOn ( )
virtual

Enable moving of data points along Y axis by click-and-drag in plot views. Points may only be moved in the view if moving is enabled in the plot view node as well.

◆ GetAxisLabelFontSize()

virtual int vtkMRMLPlotChartNode::GetAxisLabelFontSize ( )
virtual

◆ GetAxisTitleFontSize()

virtual int vtkMRMLPlotChartNode::GetAxisTitleFontSize ( )
virtual

◆ GetClassName()

virtual const char* vtkMRMLPlotChartNode::GetClassName ( )
virtual

Reimplemented from vtkMRMLNode.

◆ GetEnablePointMoveAlongX()

virtual bool vtkMRMLPlotChartNode::GetEnablePointMoveAlongX ( )
virtual

◆ GetEnablePointMoveAlongY()

virtual bool vtkMRMLPlotChartNode::GetEnablePointMoveAlongY ( )
virtual

◆ GetFontType()

virtual char* vtkMRMLPlotChartNode::GetFontType ( )
virtual

◆ GetGridVisibility()

virtual bool vtkMRMLPlotChartNode::GetGridVisibility ( )
virtual

◆ GetLegendFontSize()

virtual int vtkMRMLPlotChartNode::GetLegendFontSize ( )
virtual

◆ GetLegendVisibility()

virtual bool vtkMRMLPlotChartNode::GetLegendVisibility ( )
virtual

◆ GetNodeTagName()

const char* vtkMRMLPlotChartNode::GetNodeTagName ( )
inlineoverridevirtual


Get node XML tag name (like Volume, Model).

Implements vtkMRMLNode.

Definition at line 61 of file vtkMRMLPlotChartNode.h.

◆ GetNthPlotSeriesNode()

vtkMRMLPlotSeriesNode* vtkMRMLPlotChartNode::GetNthPlotSeriesNode ( int  n)

Get associated plot data node. Can be 0 in temporary states; e.g. if the plot node has no scene, or if the associated plot is not yet into the scene.

◆ GetNthPlotSeriesNodeID()

const char* vtkMRMLPlotChartNode::GetNthPlotSeriesNodeID ( int  n)


Return the ID of n-th plot data node ID. Or 0 if no such node exist.

◆ GetNumberOfPlotSeriesNodes()

int vtkMRMLPlotChartNode::GetNumberOfPlotSeriesNodes ( )

Return the number of plot node IDs (and plot nodes as they always have the same size).

◆ GetPlotSeriesNode()

vtkMRMLPlotSeriesNode* vtkMRMLPlotChartNode::GetPlotSeriesNode ( )

Convenience method that returns the first plot data node.

See also
GetNthPlotSeriesNode(int), GetPlotSeriesNodeID()

◆ GetPlotSeriesNodeID()

const char* vtkMRMLPlotChartNode::GetPlotSeriesNodeID ( )

Access methods.

Convenience method that returns the ID of the first plot data node in the chart.

See also
GetNthPlotSeriesNodeID(int), GetPlotSeriesNode()

◆ GetPlotSeriesNodeIDs()

virtual int vtkMRMLPlotChartNode::GetPlotSeriesNodeIDs ( std::vector< std::string > &  plotSeriesNodeIDs)
virtual


Get IDs of all associated plot data nodes.

◆ GetPlotSeriesNodeIndexFromID()

int vtkMRMLPlotChartNode::GetPlotSeriesNodeIndexFromID ( const char *  plotSeriesNodeID)

Return the index of the Nth plot node ID. If not found, it returns -1.

◆ GetPlotSeriesNodeNames()

virtual int vtkMRMLPlotChartNode::GetPlotSeriesNodeNames ( std::vector< std::string > &  plotSeriesNodeNames)
virtual


Get names of all associated plot data nodes.

◆ GetPlotSeriesNodeReferenceRole()

virtual const char* vtkMRMLPlotChartNode::GetPlotSeriesNodeReferenceRole ( )
virtual

Node reference role used for storing plot data node references.

◆ GetPropertyFromAllPlotSeriesNodes()

bool vtkMRMLPlotChartNode::GetPropertyFromAllPlotSeriesNodes ( PlotSeriesNodeProperty  plotProperty,
std::string &  value 
)

Helper function to get common properties from all associated plot data nodes. Returns false if property is not the same in all plots. value contains the value found in the first plot data node.

◆ GetTitle()

virtual char* vtkMRMLPlotChartNode::GetTitle ( )
virtual

◆ GetTitleFontSize()

virtual int vtkMRMLPlotChartNode::GetTitleFontSize ( )
virtual

◆ GetTitleVisibility()

virtual bool vtkMRMLPlotChartNode::GetTitleVisibility ( )
virtual

◆ GetXAxisLogScale()

virtual bool vtkMRMLPlotChartNode::GetXAxisLogScale ( )
virtual

Enable logarithmic scaling of X axis. Only positive axis range can be displayed using logarithmic scale.

◆ GetXAxisRange() [1/3]

virtual double* vtkMRMLPlotChartNode::GetXAxisRange ( )
virtual

◆ GetXAxisRange() [2/3]

virtual void vtkMRMLPlotChartNode::GetXAxisRange ( double &  ,
double &   
)
virtual

◆ GetXAxisRange() [3/3]

virtual void vtkMRMLPlotChartNode::GetXAxisRange ( double  [2])
virtual

◆ GetXAxisRangeAuto()

virtual bool vtkMRMLPlotChartNode::GetXAxisRangeAuto ( )
virtual

◆ GetXAxisTitle()

virtual char* vtkMRMLPlotChartNode::GetXAxisTitle ( )
virtual

◆ GetXAxisTitleVisibility()

virtual bool vtkMRMLPlotChartNode::GetXAxisTitleVisibility ( )
virtual

◆ GetYAxisLogScale()

virtual bool vtkMRMLPlotChartNode::GetYAxisLogScale ( )
virtual

Enable logarithmic scaling of Y axis. Only positive axis range can be displayed using logarithmic scale.

◆ GetYAxisRange() [1/3]

virtual double* vtkMRMLPlotChartNode::GetYAxisRange ( )
virtual

◆ GetYAxisRange() [2/3]

virtual void vtkMRMLPlotChartNode::GetYAxisRange ( double &  ,
double &   
)
virtual

◆ GetYAxisRange() [3/3]

virtual void vtkMRMLPlotChartNode::GetYAxisRange ( double  [2])
virtual

◆ GetYAxisRangeAuto()

virtual bool vtkMRMLPlotChartNode::GetYAxisRangeAuto ( )
virtual

◆ GetYAxisTitle()

virtual char* vtkMRMLPlotChartNode::GetYAxisTitle ( )
virtual

◆ GetYAxisTitleVisibility()

virtual bool vtkMRMLPlotChartNode::GetYAxisTitleVisibility ( )
virtual

◆ GridVisibilityOff()

virtual void vtkMRMLPlotChartNode::GridVisibilityOff ( )
virtual

◆ GridVisibilityOn()

virtual void vtkMRMLPlotChartNode::GridVisibilityOn ( )
virtual

Show horizontal and vertical grid lines.

◆ HasPlotSeriesNodeID()

bool vtkMRMLPlotChartNode::HasPlotSeriesNodeID ( const char *  plotSeriesNodeID)


Return true if PlotSeriesNodeID is in the plot node ID list.

◆ IsA()

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

Reimplemented from vtkMRMLNode.

◆ IsTypeOf()

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

◆ LegendVisibilityOff()

virtual void vtkMRMLPlotChartNode::LegendVisibilityOff ( )
virtual

◆ LegendVisibilityOn()

virtual void vtkMRMLPlotChartNode::LegendVisibilityOn ( )
virtual

Show horizontal and vertical grid lines.

◆ New()

static vtkMRMLPlotChartNode* vtkMRMLPlotChartNode::New ( )
static

Standard methods for MRML nodes.

◆ OnNodeReferenceAdded()

void vtkMRMLPlotChartNode::OnNodeReferenceAdded ( vtkMRMLNodeReference reference)
overrideprotectedvirtual


Called when a node reference ID is added (list size increased).

Reimplemented from vtkMRMLNode.

◆ OnNodeReferenceModified()

void vtkMRMLPlotChartNode::OnNodeReferenceModified ( vtkMRMLNodeReference reference)
overrideprotectedvirtual


Called when a node reference ID is modified.

Reimplemented from vtkMRMLNode.

◆ OnNodeReferenceRemoved()

void vtkMRMLPlotChartNode::OnNodeReferenceRemoved ( vtkMRMLNodeReference reference)
overrideprotectedvirtual


Called after a node reference ID is removed (list size decreased).

Reimplemented from vtkMRMLNode.

◆ operator=()

void vtkMRMLPlotChartNode::operator= ( const vtkMRMLPlotChartNode )
protected

◆ PrintSelf()

void vtkMRMLPlotChartNode::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
override

◆ ProcessMRMLEvents()

void vtkMRMLPlotChartNode::ProcessMRMLEvents ( vtkObject *  caller,
unsigned long  event,
void *  callData 
)
overridevirtual


Method to propagate events generated in mrml.

Reimplemented from vtkMRMLNode.

◆ ReadXMLAttributes()

void vtkMRMLPlotChartNode::ReadXMLAttributes ( const char **  atts)
overridevirtual


Set node attributes.

Reimplemented from vtkMRMLNode.

◆ RemoveAllPlotSeriesNodeIDs()

void vtkMRMLPlotChartNode::RemoveAllPlotSeriesNodeIDs ( )


Remove all plot data nodes from the chart.

◆ RemoveNthPlotSeriesNodeID()

void vtkMRMLPlotChartNode::RemoveNthPlotSeriesNodeID ( int  n)

Removes n-th plot data node from the chart.

See also
SetAndObserverNthPlotSeriesNodeID(int, const char*)

◆ RemovePlotSeriesNodeID()

void vtkMRMLPlotChartNode::RemovePlotSeriesNodeID ( const char *  plotSeriesNodeID)

Removes a plot data node from the chart.

See also
SetAndObserverNthPlotSeriesNodeID(int, const char*)

◆ SafeDownCast()

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

◆ SetAndObserveNthPlotSeriesNodeID()

void vtkMRMLPlotChartNode::SetAndObserveNthPlotSeriesNodeID ( int  n,
const char *  plotSeriesNodeID 
)

Set and observe the Nth plot data node ID in the list. If n is larger than the number of plot nodes, the plot node ID is added at the end of the list. If PlotSeriesNodeID is 0, the node ID is removed from the list.

See also
SetAndObservePlotSeriesNodeID(const char*), AddAndObservePlotSeriesNodeID(const char *), RemoveNthPlotSeriesNodeID(int)

◆ SetAndObservePlotSeriesNodeID()

void vtkMRMLPlotChartNode::SetAndObservePlotSeriesNodeID ( const char *  plotSeriesNodeID)

Convenience method that sets the first plot data node in the chart.

See also
SetAndObserverNthPlotSeriesNodeID(int, const char*)

◆ SetAxisLabelFontSize()

virtual void vtkMRMLPlotChartNode::SetAxisLabelFontSize ( int  )
virtual

Axis label font size. Default: 12.

◆ SetAxisTitleFontSize()

virtual void vtkMRMLPlotChartNode::SetAxisTitleFontSize ( int  )
virtual

Axis title font size. Default: 16.

◆ SetEnablePointMoveAlongX()

virtual void vtkMRMLPlotChartNode::SetEnablePointMoveAlongX ( bool  )
virtual

◆ SetEnablePointMoveAlongY()

virtual void vtkMRMLPlotChartNode::SetEnablePointMoveAlongY ( bool  )
virtual

◆ SetFontType()

virtual void vtkMRMLPlotChartNode::SetFontType ( const char *  )
virtual

Font type for all text in the chart: "Arial", "Times", "Courier".

◆ SetGridVisibility()

virtual void vtkMRMLPlotChartNode::SetGridVisibility ( bool  )
virtual

◆ SetLegendFontSize()

virtual void vtkMRMLPlotChartNode::SetLegendFontSize ( int  )
virtual

Title font size. Default: 20.

◆ SetLegendVisibility()

virtual void vtkMRMLPlotChartNode::SetLegendVisibility ( bool  )
virtual

◆ SetPropertyToAllPlotSeriesNodes()

void vtkMRMLPlotChartNode::SetPropertyToAllPlotSeriesNodes ( PlotSeriesNodeProperty  plotProperty,
const char *  value 
)

Helper function to set common properties for all associated plot data nodes.

◆ SetTitle()

virtual void vtkMRMLPlotChartNode::SetTitle ( const char *  )
virtual

Title of the chart.

◆ SetTitleFontSize()

virtual void vtkMRMLPlotChartNode::SetTitleFontSize ( int  )
virtual

Title font size. Default: 20.

◆ SetTitleVisibility()

virtual void vtkMRMLPlotChartNode::SetTitleVisibility ( bool  )
virtual

◆ SetXAxisLogScale()

virtual void vtkMRMLPlotChartNode::SetXAxisLogScale ( bool  )
virtual

◆ SetXAxisRange() [1/2]

virtual void vtkMRMLPlotChartNode::SetXAxisRange ( double  ,
double   
)
virtual

◆ SetXAxisRange() [2/2]

void vtkMRMLPlotChartNode::SetXAxisRange ( double  [2])

◆ SetXAxisRangeAuto()

virtual void vtkMRMLPlotChartNode::SetXAxisRangeAuto ( bool  )
virtual

◆ SetXAxisTitle()

virtual void vtkMRMLPlotChartNode::SetXAxisTitle ( const char *  )
virtual

Title of X axis.

◆ SetXAxisTitleVisibility()

virtual void vtkMRMLPlotChartNode::SetXAxisTitleVisibility ( bool  )
virtual

◆ SetYAxisLogScale()

virtual void vtkMRMLPlotChartNode::SetYAxisLogScale ( bool  )
virtual

◆ SetYAxisRange() [1/2]

void vtkMRMLPlotChartNode::SetYAxisRange ( double  [2])

◆ SetYAxisRange() [2/2]

virtual void vtkMRMLPlotChartNode::SetYAxisRange ( double  ,
double   
)
virtual

◆ SetYAxisRangeAuto()

virtual void vtkMRMLPlotChartNode::SetYAxisRangeAuto ( bool  )
virtual

◆ SetYAxisTitle()

virtual void vtkMRMLPlotChartNode::SetYAxisTitle ( const char *  )
virtual

Title of Y axis.

◆ SetYAxisTitleVisibility()

virtual void vtkMRMLPlotChartNode::SetYAxisTitleVisibility ( bool  )
virtual

◆ TitleVisibilityOff()

virtual void vtkMRMLPlotChartNode::TitleVisibilityOff ( )
virtual

◆ TitleVisibilityOn()

virtual void vtkMRMLPlotChartNode::TitleVisibilityOn ( )
virtual

Show title of the chart.

◆ WriteXML()

void vtkMRMLPlotChartNode::WriteXML ( ostream &  of,
int  indent 
)
overridevirtual


Write this node's information to a MRML file in XML format.

Reimplemented from vtkMRMLNode.

◆ XAxisLogScaleOff()

virtual void vtkMRMLPlotChartNode::XAxisLogScaleOff ( )
virtual

◆ XAxisLogScaleOn()

virtual void vtkMRMLPlotChartNode::XAxisLogScaleOn ( )
virtual

◆ XAxisRangeAutoOff()

virtual void vtkMRMLPlotChartNode::XAxisRangeAutoOff ( )
virtual

◆ XAxisRangeAutoOn()

virtual void vtkMRMLPlotChartNode::XAxisRangeAutoOn ( )
virtual

◆ XAxisTitleVisibilityOff()

virtual void vtkMRMLPlotChartNode::XAxisTitleVisibilityOff ( )
virtual

◆ XAxisTitleVisibilityOn()

virtual void vtkMRMLPlotChartNode::XAxisTitleVisibilityOn ( )
virtual

Show title of X axis.

◆ YAxisLogScaleOff()

virtual void vtkMRMLPlotChartNode::YAxisLogScaleOff ( )
virtual

◆ YAxisLogScaleOn()

virtual void vtkMRMLPlotChartNode::YAxisLogScaleOn ( )
virtual

◆ YAxisRangeAutoOff()

virtual void vtkMRMLPlotChartNode::YAxisRangeAutoOff ( )
virtual

◆ YAxisRangeAutoOn()

virtual void vtkMRMLPlotChartNode::YAxisRangeAutoOn ( )
virtual

◆ YAxisTitleVisibilityOff()

virtual void vtkMRMLPlotChartNode::YAxisTitleVisibilityOff ( )
virtual

◆ YAxisTitleVisibilityOn()

virtual void vtkMRMLPlotChartNode::YAxisTitleVisibilityOn ( )
virtual

Show title of Y axis.

Member Data Documentation

◆ AxisLabelFontSize

int vtkMRMLPlotChartNode::AxisLabelFontSize
protected

Definition at line 317 of file vtkMRMLPlotChartNode.h.

◆ AxisTitleFontSize

int vtkMRMLPlotChartNode::AxisTitleFontSize
protected

Definition at line 316 of file vtkMRMLPlotChartNode.h.

◆ EnablePointMoveAlongX

bool vtkMRMLPlotChartNode::EnablePointMoveAlongX
protected

Definition at line 319 of file vtkMRMLPlotChartNode.h.

◆ EnablePointMoveAlongY

bool vtkMRMLPlotChartNode::EnablePointMoveAlongY
protected

Definition at line 320 of file vtkMRMLPlotChartNode.h.

◆ FontType

char* vtkMRMLPlotChartNode::FontType
protected

Definition at line 318 of file vtkMRMLPlotChartNode.h.

◆ GridVisibility

bool vtkMRMLPlotChartNode::GridVisibility
protected

Definition at line 303 of file vtkMRMLPlotChartNode.h.

◆ LegendFontSize

int vtkMRMLPlotChartNode::LegendFontSize
protected

Definition at line 305 of file vtkMRMLPlotChartNode.h.

◆ LegendVisibility

bool vtkMRMLPlotChartNode::LegendVisibility
protected

Definition at line 304 of file vtkMRMLPlotChartNode.h.

◆ PlotSeriesNodeReferenceRole

const char* vtkMRMLPlotChartNode::PlotSeriesNodeReferenceRole
staticprotected

Definition at line 298 of file vtkMRMLPlotChartNode.h.

◆ Title

char* vtkMRMLPlotChartNode::Title
protected

Definition at line 300 of file vtkMRMLPlotChartNode.h.

◆ TitleFontSize

int vtkMRMLPlotChartNode::TitleFontSize
protected

Definition at line 301 of file vtkMRMLPlotChartNode.h.

◆ TitleVisibility

bool vtkMRMLPlotChartNode::TitleVisibility
protected

Definition at line 302 of file vtkMRMLPlotChartNode.h.

◆ XAxisLogScale

bool vtkMRMLPlotChartNode::XAxisLogScale
protected

Definition at line 310 of file vtkMRMLPlotChartNode.h.

◆ XAxisRange

double vtkMRMLPlotChartNode::XAxisRange[2]
protected

Definition at line 308 of file vtkMRMLPlotChartNode.h.

◆ XAxisRangeAuto

bool vtkMRMLPlotChartNode::XAxisRangeAuto
protected

Definition at line 306 of file vtkMRMLPlotChartNode.h.

◆ XAxisTitle

char* vtkMRMLPlotChartNode::XAxisTitle
protected

Definition at line 312 of file vtkMRMLPlotChartNode.h.

◆ XAxisTitleVisibility

bool vtkMRMLPlotChartNode::XAxisTitleVisibility
protected

Definition at line 313 of file vtkMRMLPlotChartNode.h.

◆ YAxisLogScale

bool vtkMRMLPlotChartNode::YAxisLogScale
protected

Definition at line 311 of file vtkMRMLPlotChartNode.h.

◆ YAxisRange

double vtkMRMLPlotChartNode::YAxisRange[2]
protected

Definition at line 309 of file vtkMRMLPlotChartNode.h.

◆ YAxisRangeAuto

bool vtkMRMLPlotChartNode::YAxisRangeAuto
protected

Definition at line 307 of file vtkMRMLPlotChartNode.h.

◆ YAxisTitle

char* vtkMRMLPlotChartNode::YAxisTitle
protected

Definition at line 314 of file vtkMRMLPlotChartNode.h.

◆ YAxisTitleVisibility

bool vtkMRMLPlotChartNode::YAxisTitleVisibility
protected

Definition at line 315 of file vtkMRMLPlotChartNode.h.


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