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

Inheritance diagram for NXOpen::CAE::Xyplot::BaseTemplate:

Public Member Functions
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::AxisStyleSetting *	GetAxisStyleSetting (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::BaseBarStyleSetting *	GetBarStyleSetting (int styleIndex)
	Gets the bar display style.

NXOpen::CAE::Xyplot::GraphStyle	GetGraphStyle (int styleIndex)
	Gets the graph style.

NXOpen::CAE::Xyplot::BaseLineStyleSetting *	GetLineStyleSetting (int styleIndex)
	Gets the line display style.

NXOpen::CAE::Xyplot::ScatterStyleSetting *	GetScatterStyleSetting (int styleIndex)
	Gets the scatter display style.

NXOpen::CAE::Xyplot::TextOption	GetTextOption (NXOpen::CAE::Xyplot::TextType textType)
	Gets the text option.

NXOpen::CAE::Xyplot::TextStyleSetting *	GetTextStyleSetting (NXOpen::CAE::Xyplot::TextType textType)
	Gets the text style.

NXOpen::CAE::Xyplot::BaseGridLayoutStyleSetting *	GridLayoutStyleSetting ()
	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 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.

Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters

strXmlFile the 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.

Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters

strXmlFile the template xml file name
NOTE: The full Unicode character set is not supported for this parameter.

NXOpen::CAE::Xyplot::AxisStyle NXOpen::CAE::Xyplot::BaseTemplate::GetAxisStyle ( NXOpen::CAE::Xyplot::AxisDirection axisDirection )

Gets the axis display style.

Returns: Axis style

Deprecated:: Deprecated in NX9.0.0. Use CAE::Xyplot::BaseTemplate::GetAxisStyleSetting instead.

Created in NX7.5.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters

axisDirection Axis direction

NXOpen::CAE::Xyplot::AxisStyleSetting* NXOpen::CAE::Xyplot::BaseTemplate::GetAxisStyleSetting ( NXOpen::CAE::Xyplot::AxisDirection axisDirection )

Gets the axis display style.

Returns: Axis style
Created in NX9.0.0.

License requirements : None

Parameters

axisDirection Axis direction

NXOpen::CAE::Xyplot::UnitSystem NXOpen::CAE::Xyplot::BaseTemplate::GetAxisUnitSystem ( NXOpen::CAE::Xyplot::AxisDirection axisDirection )

Gets the axis unit system.

Returns: Unit system

Deprecated:: Deprecated in NX9.0.0. Use CAE::Xyplot::AxisStyleSetting::UnitSystem instead.

Created in NX7.5.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters

axisDirection Axis direction

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

Gets the bar display style.

Returns: Bar style
Created in NX9.0.0.

License requirements : None

Parameters

styleIndex Style index, from 0 to 19

NXOpen::CAE::Xyplot::GraphStyle NXOpen::CAE::Xyplot::BaseTemplate::GetGraphStyle ( int styleIndex )

Gets the graph style.

Returns: Graph style
Created in NX7.5.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters

styleIndex Style index

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

Gets the line display style.

Returns: Line style
Created in NX9.0.0.

License requirements : None

Parameters

styleIndex Style index, from 0 to 19

NXOpen::CAE::Xyplot::ScatterStyleSetting* NXOpen::CAE::Xyplot::BaseTemplate::GetScatterStyleSetting ( int styleIndex )

Gets the scatter display style.

Returns: Scatter style
Created in NX9.0.0.

License requirements : None

Parameters

styleIndex Style index, from 0 to 19

NXOpen::CAE::Xyplot::TextOption NXOpen::CAE::Xyplot::BaseTemplate::GetTextOption ( NXOpen::CAE::Xyplot::TextType textType )

Gets the text option.

Returns: Text display option

Deprecated:: Deprecated in NX9.0.0. Use CAE::Xyplot::BaseTemplate::GetTextStyleSetting instead.

Created in NX7.5.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters

textType Text type

NXOpen::CAE::Xyplot::TextStyleSetting* NXOpen::CAE::Xyplot::BaseTemplate::GetTextStyleSetting ( NXOpen::CAE::Xyplot::TextType textType )

Gets the text style.

Returns: Text display style
Created in NX9.0.0.

License requirements : None

Parameters

textType Text type

NXOpen::CAE::Xyplot::BaseGridLayoutStyleSetting* NXOpen::CAE::Xyplot::BaseTemplate::GridLayoutStyleSetting ( )

Returns the grid layout display style
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
Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters

strXmlFile the 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
Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters

strXmlFile the template xml file name
NOTE: The full Unicode character set is not supported for this parameter.

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

Resets the graph template to default values
Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

void NXOpen::CAE::Xyplot::BaseTemplate::SetAxisStyle	(	NXOpen::CAE::Xyplot::AxisDirection	axisDirection,
		const NXOpen::CAE::Xyplot::AxisStyle &	axisStyle
	)

Sets the axis display 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

axisDirection	Axis direction
axisStyle	Axis style

void NXOpen::CAE::Xyplot::BaseTemplate::SetAxisUnitSystem	(	NXOpen::CAE::Xyplot::AxisDirection	axisDirection,
		NXOpen::CAE::Xyplot::UnitSystem	unitSystem
	)

Sets the axis unit system

Deprecated:: Deprecated in NX9.0.0.

Use CAE::Xyplot::AxisStyleSetting::SetUnitSystem instead.

Created in NX7.5.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters

axisDirection	Axis direction
unitSystem	Unit system

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

Sets the graph style
Created in NX7.5.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters

styleIndex	Style index
graphStyle	Graph style

void NXOpen::CAE::Xyplot::BaseTemplate::SetTextOption	(	NXOpen::CAE::Xyplot::TextType	textType,
		const NXOpen::CAE::Xyplot::TextOption &	textOption
	)

Sets the text 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

textType	Text type
textOption	Text display option

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

CAE_Xyplot_BaseTemplate.hxx

Public Member Functions

Detailed Description

Member Function Documentation