Manages the preference data. More...

Inheritance diagram for NXOpen::CAE::Xyplot::Preference:

Public Types
enum	NewWindowChoice { NewWindowChoicePrompt, NewWindowChoiceAlways }
	Defines whether to always show plot graph on a new separate graphic window. More...

enum	TargetGraphicWindowOption { TargetGraphicWindowOptionMain, TargetGraphicWindowOptionSeparate, TargetGraphicWindowOptionBoth }
	Defines the target graphic window type. More...

Public Member Functions
NXOpen::CAE::FTK::DataManager::AfuRecordZValue	AfuRecordZValue ()
	Returns the Z value type for afu record in 3D plot Created in NX10.0.0. More...

int	MaximumLegendsInGraph ()
	Returns the maximum legend count on a graph. More...

int	MaximumSubGraphsInStack ()
	Returns the maximum sub-graph count in a stacked graph Created in NX10.0.0. More...

NXOpen::CAE::Xyplot::Preference::NewWindowChoice	NewWindowSetting ()
	Returns the new window setting value. More...

void	Save ()
	Saves preference settings to memory file so that preference setting could be shared among sessions Created in NX10.0.0. More...

void	SetAfuRecordZValue (NXOpen::CAE::FTK::DataManager::AfuRecordZValue afuZValue)
	Sets the Z value type for afu record in 3D plot Created in NX10.0.0. More...

void	SetMaximumLegendsInGraph (int legendCount)
	Sets the maximum legend count on a graph. More...

void	SetMaximumSubGraphsInStack (int graphCount)
	Sets the maximum sub-graph count in a stacked graph Created in NX10.0.0. More...

void	SetNewWindowSetting (NXOpen::CAE::Xyplot::Preference::NewWindowChoice newWindowSetting)
	Sets the new window setting value. More...

void	SetTargetWindowSetting (NXOpen::CAE::Xyplot::Preference::TargetGraphicWindowOption targetWindowSetting)
	Sets the target window setting value Created in NX9.0.0. More...

void	SetUpdateOverlayingAxisLimitsAutomatically (bool updateAxisLimits)
	Sets the status whether to update the axis limits automatically when overlaying records at next time Created in NX10.0.0. More...

NXOpen::CAE::Xyplot::Preference::TargetGraphicWindowOption	TargetWindowSetting ()
	Returns the target window setting value Created in NX9.0.0. More...

bool	UpdateOverlayingAxisLimitsAutomatically ()
	Returns the status whether to update the axis limits automatically when overlaying records at next time Created in NX10.0.0. More...

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Manages the preference data.

Not support KF.

Created in NX9.0.0.

Member Enumeration Documentation

enum NXOpen::CAE::Xyplot::Preference::NewWindowChoice

Defines whether to always show plot graph on a new separate graphic window.

Enumerator
NewWindowChoicePrompt	Prompts user to show plot graph on either an existing or a new separate graphic window.
NewWindowChoiceAlways	Always show plot graph on a new separate graphic window.

enum NXOpen::CAE::Xyplot::Preference::TargetGraphicWindowOption

Defines the target graphic window type.

Enumerator
TargetGraphicWindowOptionMain	Only shows plot graph on main graphic window.
TargetGraphicWindowOptionSeparate	Only shows plot graph on a separate graphic window.
TargetGraphicWindowOptionBoth	Shows plot graph on either main graphic window or a separate graphic window.

Member Function Documentation

NXOpen::CAE::FTK::DataManager::AfuRecordZValue NXOpen::CAE::Xyplot::Preference::AfuRecordZValue ( )

Returns the Z value type for afu record in 3D plot
Created in NX10.0.0.

License requirements : None

int NXOpen::CAE::Xyplot::Preference::MaximumLegendsInGraph ( )

Returns the maximum legend count on a graph.

If the record count on a graph exceeds this maximum number, legends will not be displayed and synchronized probing will be disabled.

Deprecated:: Deprecated in NX12.0.0. Use NXOpen::CAE::Xyplot::LegendTableStyle::MaximumLegendItemCount

Created in NX10.0.0.

License requirements : None

int NXOpen::CAE::Xyplot::Preference::MaximumSubGraphsInStack ( )

Returns the maximum sub-graph count in a stacked graph
Created in NX10.0.0.

License requirements : None

NXOpen::CAE::Xyplot::Preference::NewWindowChoice NXOpen::CAE::Xyplot::Preference::NewWindowSetting ( )

Returns the new window setting value.

Avaliable when CAE::Xyplot::Preference::TargetWindowSetting and CAE::Xyplot::Preference::SetTargetWindowSetting is CAE::Xyplot::Preference::TargetGraphicWindowOptionSeparate .
Created in NX9.0.0.

License requirements : None

void NXOpen::CAE::Xyplot::Preference::Save ( )

Saves preference settings to memory file so that preference setting could be shared among sessions
Created in NX10.0.0.

License requirements : None

void NXOpen::CAE::Xyplot::Preference::SetAfuRecordZValue ( NXOpen::CAE::FTK::DataManager::AfuRecordZValue afuZValue )

Sets the Z value type for afu record in 3D plot
Created in NX10.0.0.

License requirements : None

Parameters

afuZValue The 3D afu record z value

void NXOpen::CAE::Xyplot::Preference::SetMaximumLegendsInGraph ( int legendCount )

Sets the maximum legend count on a graph.

If the record count on a graph exceeds this maximum number, legends will not be displayed and synchronized probing will be disabled.

Deprecated:: Deprecated in NX12.0.0. Use NXOpen::CAE::Xyplot::LegendTableStyle::SetMaximumLegendItemCount

Created in NX10.0.0.

License requirements : None

Parameters

legendCount The maximum legend count

void NXOpen::CAE::Xyplot::Preference::SetMaximumSubGraphsInStack ( int graphCount )

Sets the maximum sub-graph count in a stacked graph
Created in NX10.0.0.

License requirements : None

Parameters

graphCount The maximum sub-graph count

void NXOpen::CAE::Xyplot::Preference::SetNewWindowSetting ( NXOpen::CAE::Xyplot::Preference::NewWindowChoice newWindowSetting )

Sets the new window setting value.

Avaliable when CAE::Xyplot::Preference::TargetWindowSetting and CAE::Xyplot::Preference::SetTargetWindowSetting is CAE::Xyplot::Preference::TargetGraphicWindowOptionSeparate .
Created in NX9.0.0.

License requirements : None

Parameters

newWindowSetting New window setting

void NXOpen::CAE::Xyplot::Preference::SetTargetWindowSetting ( NXOpen::CAE::Xyplot::Preference::TargetGraphicWindowOption targetWindowSetting )

Sets the target window setting value
Created in NX9.0.0.

License requirements : None

Parameters

targetWindowSetting targetwindowsetting

void NXOpen::CAE::Xyplot::Preference::SetUpdateOverlayingAxisLimitsAutomatically ( bool updateAxisLimits )

Sets the status whether to update the axis limits automatically when overlaying records at next time
Created in NX10.0.0.

License requirements : None

Parameters

updateAxisLimits Whether to update axis limits

NXOpen::CAE::Xyplot::Preference::TargetGraphicWindowOption NXOpen::CAE::Xyplot::Preference::TargetWindowSetting ( )

Returns the target window setting value
Created in NX9.0.0.

License requirements : None

bool NXOpen::CAE::Xyplot::Preference::UpdateOverlayingAxisLimitsAutomatically ( )

Returns the status whether to update the axis limits automatically when overlaying records at next time
Created in NX10.0.0.

License requirements : None

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

CAE_Xyplot_Preference.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation