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

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

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

Public Member Functions

NXOpen::CAE::Xyplot::ComplexOption2D ComplexOption ()
 Returns the complex option
Created in NX7.5.0.
 
NXOpen::CAE::Xyplot::BarOption2D GetBarOption (int styleIndex)
 Gets bar style option.
 
NXOpen::CAE::Xyplot::LineOption2D GetLineOption (int styleIndex)
 Gets line style option.
 
NXOpen::CAE::Xyplot::PlateOption2D GetPlateOption (int styleIndex)
 Gets plate style option.
 
NXOpen::CAE::Xyplot::GridLayout2D GridLayout ()
 Returns the grid layout style

 
double PhaseAngle ()
 Returns the phase angle in degree
Created in NX9.0.0.
 
NXOpen::CAE::Xyplot::PhaseRangeOption PhaseRangeOption ()
 Returns the phase range option
Created in NX8.0.0.
 
void SetBarOption (int styleIndex, const NXOpen::CAE::Xyplot::BarOption2D &barOption)
 Sets bar style option

 
void SetComplexOption (NXOpen::CAE::Xyplot::ComplexOption2D complexOption)
 Sets the complex option
Created in NX7.5.0.
 
void SetGridLayout (const NXOpen::CAE::Xyplot::GridLayout2D &gridLayout)
 Sets the grid layout style

 
void SetLineOption (int styleIndex, const NXOpen::CAE::Xyplot::LineOption2D &lineOption)
 Sets line style option

 
void SetPhaseAngle (double phaseAngle)
 Sets the phase angle in degree
Created in NX9.0.0.
 
void SetPhaseRangeOption (NXOpen::CAE::Xyplot::PhaseRangeOption phaseRangeOption)
 Sets the phase range option
Created in NX8.0.0.
 
void SetPlateOption (int styleIndex, const NXOpen::CAE::Xyplot::PlateOption2D &plateOption)
 Sets plate style option

 
void SetShowOrderedAbscissa (bool ordered)
 Sets a value indicating whether to show the data by ordered abscissa or not
Created in NX9.0.0.
 
bool ShowOrderedAbscissa ()
 Returns a value indicating whether to show the data by ordered abscissa or not
Created in NX9.0.0.
 
void SwitchXyAxis ()
 Switches the X/Y axis
Created in NX7.5.0.
 
- Public Member Functions inherited from NXOpen::CAE::Xyplot::BaseTemplate
virtual void CommitChange ()
 Commits any edits that have been applied to the display style.
 
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.
 
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.
 
NXOpen::CAE::Xyplot::AxisStyle GetAxisStyle (NXOpen::CAE::Xyplot::AxisDirection axisDirection)
 Gets the axis display style.
 
NXOpen::CAE::Xyplot::AxisStyleSettingGetAxisStyleSetting (NXOpen::CAE::Xyplot::AxisDirection axisDirection)
 Gets the axis display style.
 
NXOpen::CAE::Xyplot::UnitSystem GetAxisUnitSystem (NXOpen::CAE::Xyplot::AxisDirection axisDirection)
 Gets the axis unit system.
 
NXOpen::CAE::Xyplot::BaseBarStyleSettingGetBarStyleSetting (int styleIndex)
 Gets the bar display style.
 
NXOpen::CAE::Xyplot::GraphStyle GetGraphStyle (int styleIndex)
 Gets the graph style.
 
NXOpen::CAE::Xyplot::BaseLineStyleSettingGetLineStyleSetting (int styleIndex)
 Gets the line display style.
 
NXOpen::CAE::Xyplot::ScatterStyleSettingGetScatterStyleSetting (int styleIndex)
 Gets the scatter display style.
 
NXOpen::CAE::Xyplot::TextOption GetTextOption (NXOpen::CAE::Xyplot::TextType textType)
 Gets the text option.
 
NXOpen::CAE::Xyplot::TextStyleSettingGetTextStyleSetting (NXOpen::CAE::Xyplot::TextType textType)
 Gets the text style.
 
NXOpen::CAE::Xyplot::BaseGridLayoutStyleSettingGridLayoutStyleSetting ()
 Returns the grid layout display style
Created in NX9.0.0.
 
void ImportTemplate (const NXString &strXmlFile)
 Updates current graph template setting from a template xml file
Created in NX9.0.0.
 
void ImportTemplate (const char *strXmlFile)
 Updates current graph template setting from a template xml file
Created in NX9.0.0.
 
void ResetToDefault ()
 Resets the graph template to default values
Created in NX9.0.0.
 
void SetAxisStyle (NXOpen::CAE::Xyplot::AxisDirection axisDirection, const NXOpen::CAE::Xyplot::AxisStyle &axisStyle)
 Sets the axis display style

 
void SetAxisUnitSystem (NXOpen::CAE::Xyplot::AxisDirection axisDirection, NXOpen::CAE::Xyplot::UnitSystem unitSystem)
 Sets the axis unit system

 
void SetGraphStyle (int styleIndex, NXOpen::CAE::Xyplot::GraphStyle graphStyle)
 Sets the graph style
Created in NX7.5.0.
 
void SetTextOption (NXOpen::CAE::Xyplot::TextType textType, const NXOpen::CAE::Xyplot::TextOption &textOption)
 Sets the text option

 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t GetTag () const
 
<b>Deprecated</b>:<br>

   Use Tag instead.

 
tag_t Tag () const
 Returns the tag of this object.
 

Detailed Description

Manages the 2D display style
Not support KF.



Created in NX7.5.0.

Member Function Documentation

NXOpen::CAE::Xyplot::ComplexOption2D NXOpen::CAE::Xyplot::Template2D::ComplexOption ( )

Returns the complex option
Created in NX7.5.0.



License requirements : nx_ftk ("NX Advanced Graphing")

NXOpen::CAE::Xyplot::BarOption2D NXOpen::CAE::Xyplot::Template2D::GetBarOption ( int  styleIndex)

Gets bar style option.

Returns
Bar style option
Deprecated:
Deprecated in NX9.0.0. Use CAE::Xyplot::BaseTemplate::GetBarStyleSetting instead.


Created in NX7.5.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters
styleIndexStyle index
NXOpen::CAE::Xyplot::LineOption2D NXOpen::CAE::Xyplot::Template2D::GetLineOption ( int  styleIndex)

Gets line style option.

Returns
Line style option
Deprecated:
Deprecated in NX9.0.0. Use CAE::Xyplot::BaseTemplate::GetLineStyleSetting instead.


Created in NX7.5.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters
styleIndexStyle index
NXOpen::CAE::Xyplot::PlateOption2D NXOpen::CAE::Xyplot::Template2D::GetPlateOption ( int  styleIndex)

Gets plate style option.

Returns
Plate style option
Deprecated:
Deprecated in NX9.0.0. Use CAE::Xyplot::BaseTemplate::GetPlateStyleSetting instead.


Created in NX7.5.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters
styleIndexStyle index
NXOpen::CAE::Xyplot::GridLayout2D NXOpen::CAE::Xyplot::Template2D::GridLayout ( )

Returns the grid layout style

Deprecated:
Deprecated in NX9.0.0.

Use CAE::Xyplot::BaseTemplate::GridLayoutStyleSetting instead.


Created in NX7.5.0.

License requirements : nx_ftk ("NX Advanced Graphing")

double NXOpen::CAE::Xyplot::Template2D::PhaseAngle ( )

Returns the phase angle in degree
Created in NX9.0.0.



License requirements : None

NXOpen::CAE::Xyplot::PhaseRangeOption NXOpen::CAE::Xyplot::Template2D::PhaseRangeOption ( )

Returns the phase range option
Created in NX8.0.0.



License requirements : None

void NXOpen::CAE::Xyplot::Template2D::SetBarOption ( int  styleIndex,
const NXOpen::CAE::Xyplot::BarOption2D barOption 
)

Sets bar style option

Deprecated:
Deprecated in NX9.0.0.

Use CAE::Xyplot::IDisplayStyle::CommitChange instead.


Created in NX7.5.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters
styleIndexStyle index
barOptionBar style option
void NXOpen::CAE::Xyplot::Template2D::SetComplexOption ( NXOpen::CAE::Xyplot::ComplexOption2D  complexOption)

Sets the complex option
Created in NX7.5.0.



License requirements : nx_ftk ("NX Advanced Graphing")

Parameters
complexOptionComplex option
void NXOpen::CAE::Xyplot::Template2D::SetGridLayout ( const NXOpen::CAE::Xyplot::GridLayout2D gridLayout)

Sets the grid layout style

Deprecated:
Deprecated in NX9.0.0.

Use CAE::Xyplot::IDisplayStyle::CommitChange instead.


Created in NX7.5.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters
gridLayoutGrid layout style
void NXOpen::CAE::Xyplot::Template2D::SetLineOption ( int  styleIndex,
const NXOpen::CAE::Xyplot::LineOption2D lineOption 
)

Sets line style option

Deprecated:
Deprecated in NX9.0.0.

Use CAE::Xyplot::IDisplayStyle::CommitChange instead.


Created in NX7.5.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters
styleIndexStyle index
lineOptionLine style option
void NXOpen::CAE::Xyplot::Template2D::SetPhaseAngle ( double  phaseAngle)

Sets the phase angle in degree
Created in NX9.0.0.



License requirements : nx_ftk ("NX Advanced Graphing")

Parameters
phaseAnglePhase angle
void NXOpen::CAE::Xyplot::Template2D::SetPhaseRangeOption ( NXOpen::CAE::Xyplot::PhaseRangeOption  phaseRangeOption)

Sets the phase range option
Created in NX8.0.0.



License requirements : nx_ftk ("NX Advanced Graphing")

Parameters
phaseRangeOptionPhase range option
void NXOpen::CAE::Xyplot::Template2D::SetPlateOption ( int  styleIndex,
const NXOpen::CAE::Xyplot::PlateOption2D plateOption 
)

Sets plate style option

Deprecated:
Deprecated in NX9.0.0.

Use CAE::Xyplot::IDisplayStyle::CommitChange instead.


Created in NX7.5.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters
styleIndexStyle index
plateOptionPlate style option
void NXOpen::CAE::Xyplot::Template2D::SetShowOrderedAbscissa ( bool  ordered)

Sets a value indicating whether to show the data by ordered abscissa or not
Created in NX9.0.0.



License requirements : nx_ftk ("NX Advanced Graphing")

Parameters
orderedordered
bool NXOpen::CAE::Xyplot::Template2D::ShowOrderedAbscissa ( )

Returns a value indicating whether to show the data by ordered abscissa or not
Created in NX9.0.0.



License requirements : None

void NXOpen::CAE::Xyplot::Template2D::SwitchXyAxis ( )

Switches the X/Y axis
Created in NX7.5.0.



License requirements : nx_ftk ("NX Advanced Graphing")


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