NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::CAE::Xyplot::BaseTemplate Class Reference

Manages the display style
Not support KF. More...

Inheritance diagram for NXOpen::CAE::Xyplot::BaseTemplate:
NXOpen::TaggedObject NXOpen::CAE::Xyplot::IDisplayStyle NXOpen::CAE::Xyplot::Template2D NXOpen::CAE::Xyplot::Template3D

Public Member Functions

virtual void CommitChange ()
 Commits any edits that have been applied to the display style. More...
 
void ExportTemplate (const NXString &strXmlFile)
 Exports current graph template setting to a template xml file, it will override the template file if it is existing. More...
 
void ExportTemplate (const char *strXmlFile)
 Exports current graph template setting to a template xml file, it will override the template file if it is existing. More...
 
NXOpen::CAE::Xyplot::AxisStyleSettingGetAxisStyleSetting (NXOpen::CAE::Xyplot::AxisDirection axisDirection)
 Gets the axis display style. More...
 
NXOpen::CAE::Xyplot::BaseBarStyleSettingGetBarStyleSetting (int styleIndex)
 Gets the bar display style. More...
 
NXOpen::CAE::Xyplot::GraphStyle GetGraphStyle (int styleIndex)
 Gets the graph style. More...
 
NXOpen::CAE::Xyplot::BaseLineStyleSettingGetLineStyleSetting (int styleIndex)
 Gets the line display style. More...
 
NXOpen::CAE::Xyplot::BasePlateStyleSettingGetPlateStyleSetting (int styleIndex)
 Gets the plate display style. More...
 
NXOpen::CAE::Xyplot::ScatterStyleSettingGetScatterStyleSetting (int styleIndex)
 Gets the scatter display style. More...
 
NXOpen::CAE::Xyplot::TextStyleSettingGetTextStyleSetting (NXOpen::CAE::Xyplot::TextType textType)
 Gets the text style. More...
 
NXOpen::CAE::Xyplot::BaseGridLayoutStyleSettingGridLayoutStyleSetting ()
 Returns the grid layout display style
More...
 
void ImportTemplate (const NXString &strXmlFile)
 Updates current graph template setting from a template xml file
More...
 
void ImportTemplate (const char *strXmlFile)
 Updates current graph template setting from a template xml file
More...
 
virtual
NXOpen::CAE::Xyplot::IDisplayStyle
Owner ()
 Returns the owner style
Created in NX10.0.0. More...
 
void ResetToDefault ()
 Resets the graph template to default values
More...
 
void SetGraphStyle (int styleIndex, NXOpen::CAE::Xyplot::GraphStyle graphStyle)
 Sets the graph style
More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Manages the display style
Not support KF.



Created in NX7.5.0.

Member Function Documentation

virtual void NXOpen::CAE::Xyplot::BaseTemplate::CommitChange ( )
virtual

Commits any edits that have been applied to the display style.

Triggers the corresponding plot to update graph.
Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Implements NXOpen::CAE::Xyplot::IDisplayStyle.

void NXOpen::CAE::Xyplot::BaseTemplate::ExportTemplate ( const NXString strXmlFile)

Exports current graph template setting to a template xml file, it will override the template file if it is existing.


Deprecated:
Deprecated in NX10.0.0. Use CAE::Xyplot::PlotGraphTemplate::ExportTemplate instead.


Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters
strXmlFilethe template xml file name
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::CAE::Xyplot::BaseTemplate::ExportTemplate ( const char *  strXmlFile)

Exports current graph template setting to a template xml file, it will override the template file if it is existing.


Deprecated:
Deprecated in NX10.0.0. Use CAE::Xyplot::PlotGraphTemplate::ExportTemplate instead.


Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters
strXmlFilethe template xml file name
NOTE: The full Unicode character set is not supported for this parameter.
NXOpen::CAE::Xyplot::AxisStyleSetting* NXOpen::CAE::Xyplot::BaseTemplate::GetAxisStyleSetting ( NXOpen::CAE::Xyplot::AxisDirection  axisDirection)

Gets the axis display style.

Returns
Axis style
Deprecated:
Deprecated in NX10.0.0. Use CAE::Xyplot::WallDisplayStyles::GetAxisStyleSetting instead.


Created in NX9.0.0.

License requirements : None

Parameters
axisDirectionAxis direction
NXOpen::CAE::Xyplot::BaseBarStyleSetting* NXOpen::CAE::Xyplot::BaseTemplate::GetBarStyleSetting ( int  styleIndex)

Gets the bar display style.

Returns
Bar style
Deprecated:
Deprecated in NX10.0.0. Use CAE::Xyplot::DiagramDisplayStyles::GetBarStyleSetting instead.


Created in NX9.0.0.

License requirements : None

Parameters
styleIndexStyle index, from 0 to 19
NXOpen::CAE::Xyplot::GraphStyle NXOpen::CAE::Xyplot::BaseTemplate::GetGraphStyle ( int  styleIndex)

Gets the graph style.

Returns
Graph style
Deprecated:
Deprecated in NX10.0.0. Use CAE::Xyplot::DiagramDisplayStyles::GetGraphStyle instead.


Created in NX7.5.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters
styleIndexStyle index
NXOpen::CAE::Xyplot::BaseLineStyleSetting* NXOpen::CAE::Xyplot::BaseTemplate::GetLineStyleSetting ( int  styleIndex)

Gets the line display style.

Returns
Line style
Deprecated:
Deprecated in NX10.0.0. Use CAE::Xyplot::DiagramDisplayStyles::GetLineStyleSetting instead.


Created in NX9.0.0.

License requirements : None

Parameters
styleIndexStyle index, from 0 to 19
NXOpen::CAE::Xyplot::BasePlateStyleSetting* NXOpen::CAE::Xyplot::BaseTemplate::GetPlateStyleSetting ( int  styleIndex)

Gets the plate display style.

Returns
Plate style
Deprecated:
Deprecated in NX10.0.0. Use CAE::Xyplot::DiagramDisplayStyles::GetPlateStyleSetting instead.


Created in NX9.0.0.

License requirements : None

Parameters
styleIndexStyle index, from 0 to 19
NXOpen::CAE::Xyplot::ScatterStyleSetting* NXOpen::CAE::Xyplot::BaseTemplate::GetScatterStyleSetting ( int  styleIndex)

Gets the scatter display style.

Returns
Scatter style
Deprecated:
Deprecated in NX10.0.0. Use CAE::Xyplot::DiagramDisplayStyles::GetScatterStyleSetting instead.


Created in NX9.0.0.

License requirements : None

Parameters
styleIndexStyle index, from 0 to 19
NXOpen::CAE::Xyplot::TextStyleSetting* NXOpen::CAE::Xyplot::BaseTemplate::GetTextStyleSetting ( NXOpen::CAE::Xyplot::TextType  textType)

Gets the text style.

Returns
Text display style
Deprecated:
Deprecated in NX10.0.0. Use CAE::Xyplot::WallDisplayStyles::GetTextStyleSetting instead.


Created in NX9.0.0.

License requirements : None

Parameters
textTypeText type
NXOpen::CAE::Xyplot::BaseGridLayoutStyleSetting* NXOpen::CAE::Xyplot::BaseTemplate::GridLayoutStyleSetting ( )

Returns the grid layout display style

Deprecated:
Deprecated in NX10.0.0.

Use CAE::Xyplot::WallDisplayStyles::GridLayoutStyleSetting instead.


Created in NX9.0.0.

License requirements : None

void NXOpen::CAE::Xyplot::BaseTemplate::ImportTemplate ( const NXString strXmlFile)

Updates current graph template setting from a template xml file

Deprecated:
Deprecated in NX10.0.0.

Use CAE::Xyplot::PlotGraphTemplate::ImportTemplate instead.


Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters
strXmlFilethe template xml file name
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::CAE::Xyplot::BaseTemplate::ImportTemplate ( const char *  strXmlFile)

Updates current graph template setting from a template xml file

Deprecated:
Deprecated in NX10.0.0.

Use CAE::Xyplot::PlotGraphTemplate::ImportTemplate instead.


Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters
strXmlFilethe template xml file name
NOTE: The full Unicode character set is not supported for this parameter.
virtual NXOpen::CAE::Xyplot::IDisplayStyle* NXOpen::CAE::Xyplot::BaseTemplate::Owner ( )
virtual

Returns the owner style
Created in NX10.0.0.



License requirements : None

Implements NXOpen::CAE::Xyplot::IDisplayStyle.

void NXOpen::CAE::Xyplot::BaseTemplate::ResetToDefault ( )

Resets the graph template to default values

Deprecated:
Deprecated in NX10.0.0.

Use CAE::Xyplot::PlotGraphTemplate::ResetToDefault instead.


Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

void NXOpen::CAE::Xyplot::BaseTemplate::SetGraphStyle ( int  styleIndex,
NXOpen::CAE::Xyplot::GraphStyle  graphStyle 
)

Sets the graph style

Deprecated:
Deprecated in NX10.0.0.

Use CAE::Xyplot::DiagramDisplayStyles::SetGraphStyle instead.


Created in NX7.5.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters
styleIndexStyle index
graphStyleGraph style

The documentation for this class was generated from the following file:
Copyright 2012 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.