NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | List of all members
NXOpen::CAE::Xyplot::ArgumentAxisStyleSetting Class Reference

Represents the argument axis display style. More...

Inheritance diagram for NXOpen::CAE::Xyplot::ArgumentAxisStyleSetting:
NXOpen::CAE::Xyplot::BaseDisplayStyleSetting NXOpen::CAE::Xyplot::IAxisStyle NXOpen::TaggedObject NXOpen::CAE::Xyplot::IDisplayStyle

Public Member Functions

std::vector< NXStringGetAbsCustomerRange ()
 Gets the abscissa customer range. More...
 
virtual
NXOpen::CAE::Xyplot::TextStyleSetting
GetAnnotationStyle ()
 Gets the annotation style. More...
 
NXOpen::CAE::Xyplot::TextStyleSettingGetAxisItemStyleSetting ()
 Gets the axis item style. More...
 
std::vector< int > GetCustomerRange ()
 Gets the customer indices. More...
 
NXOpen::CAE::FTK::BaseUnitGetDisplayUnit ()
 Gets display unit
Created in NX1847.0.0. More...
 
std::vector< int > GetIndicesOfLabel (const NXString &itemLabel)
 Gets the indices of label. More...
 
std::vector< int > GetIndicesOfLabel (const char *itemLabel)
 Gets the indices of label. More...
 
virtual
NXOpen::CAE::Xyplot::CustomTextStyleSetting
GetLabelDisplayStyle ()
 Gets the label style
Created in NX1847.0.0. More...
 
NXOpen::CAE::Xyplot::CustomTextStyleSettingGetLabelStyle ()
 Gets the label style
More...
 
NXString GetNthItemLabel (int nth)
 Gets nth item label. More...
 
void LogUnitChangedEvent ()
 Logs an update event for changing display unit before committing AxisStyleSetting change. More...
 
bool RangeAuto ()
 Returns a value indicating whether to set axis range automatically
Created in NX12.0.0. More...
 
void SetAbsCustomerRange (const std::vector< NXString > &absCustomerRange)
 Sets the abscissa customer range
More...
 
void SetCustomerIndices (const std::vector< int > &customerIndices)
 Sets the customer indices
Created in NX1847.0.0. More...
 
void SetRangeAuto (bool rangeAutomation)
 Sets a value indicating whether to set axis range automatically
Created in NX12.0.0. More...
 
void SetUnitSystemType (NXOpen::CAE::XyFunctionUnitSystem unitSystemType)
 Sets the unit system type
Created in NX1847.0.0. More...
 
NXOpen::CAE::XyFunctionUnitSystem UnitSystemType ()
 Returns the unit system type
Created in NX1847.0.0. More...
 
- Public Member Functions inherited from NXOpen::CAE::Xyplot::BaseDisplayStyleSetting
virtual void CommitChange ()
 Commits any edits that have been applied to the display style. More...
 
NXOpen::TaggedObjectFind (const NXString &journalIdentifier)
 Finds the NXOpen::TaggedObject with the given identifier as recorded in a journal. More...
 
NXOpen::TaggedObjectFind (const char *journalIdentifier)
 Finds the NXOpen::TaggedObject with the given identifier as recorded in a journal. More...
 
NXString JournalIdentifier ()
 Returns the identifier that would be recorded in a journal for this object. More...
 
virtual
NXOpen::CAE::Xyplot::IDisplayStyle
Owner ()
 Returns the owner style
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

Represents the argument axis display style.

Call CAE::Xyplot::BaseDisplayStyleSetting::CommitChange to apply style changes to corresponding plot after it's modified.
Not support KF.

Created in NX12.0.0.

Member Function Documentation

std::vector<NXString> NXOpen::CAE::Xyplot::ArgumentAxisStyleSetting::GetAbsCustomerRange ( )

Gets the abscissa customer range.

Returns
Abscissa customer range
Deprecated:
Deprecated in NX1847.0.0. Use NXOpen::CAE::Xyplot::ArgumentAxisStyleSetting::GetCustomerRange


Created in NX12.0.0.

License requirements : None

virtual NXOpen::CAE::Xyplot::TextStyleSetting* NXOpen::CAE::Xyplot::ArgumentAxisStyleSetting::GetAnnotationStyle ( )
virtual

Gets the annotation style.

Returns
Axis item style
Created in NX1847.0.0.

License requirements : None

Implements NXOpen::CAE::Xyplot::IAxisStyle.

NXOpen::CAE::Xyplot::TextStyleSetting* NXOpen::CAE::Xyplot::ArgumentAxisStyleSetting::GetAxisItemStyleSetting ( )

Gets the axis item style.

Returns
Axis item style
Deprecated:
Deprecated in NX1847.0.0. Use NXOpen::CAE::Xyplot::IAxisStyle::GetAnnotationStyle instead.


Created in NX12.0.0.

License requirements : None

std::vector<int> NXOpen::CAE::Xyplot::ArgumentAxisStyleSetting::GetCustomerRange ( )

Gets the customer indices.

Returns
Customer range
Created in NX1847.0.0.

License requirements : None
NXOpen::CAE::FTK::BaseUnit* NXOpen::CAE::Xyplot::ArgumentAxisStyleSetting::GetDisplayUnit ( )

Gets display unit
Created in NX1847.0.0.



License requirements : None

std::vector<int> NXOpen::CAE::Xyplot::ArgumentAxisStyleSetting::GetIndicesOfLabel ( const NXString itemLabel)

Gets the indices of label.

Returns
Customer range
Created in NX1847.0.0.

License requirements : None
Parameters
itemLabelitemlabel
std::vector<int> NXOpen::CAE::Xyplot::ArgumentAxisStyleSetting::GetIndicesOfLabel ( const char *  itemLabel)

Gets the indices of label.

Returns
Customer range
Created in NX1847.0.0.

License requirements : None
Parameters
itemLabelitemlabel
virtual NXOpen::CAE::Xyplot::CustomTextStyleSetting* NXOpen::CAE::Xyplot::ArgumentAxisStyleSetting::GetLabelDisplayStyle ( )
virtual

Gets the label style
Created in NX1847.0.0.



License requirements : None

Implements NXOpen::CAE::Xyplot::IAxisStyle.

NXOpen::CAE::Xyplot::CustomTextStyleSetting* NXOpen::CAE::Xyplot::ArgumentAxisStyleSetting::GetLabelStyle ( )

Gets the label style

Deprecated:
Deprecated in NX1847.0.0.

Use NXOpen::CAE::Xyplot::IAxisStyle::GetLabelDisplayStyle instead.


Created in NX12.0.0.

License requirements : None

NXString NXOpen::CAE::Xyplot::ArgumentAxisStyleSetting::GetNthItemLabel ( int  nth)

Gets nth item label.

Returns

Created in NX1847.0.0.

License requirements : None
Parameters
nthnth
void NXOpen::CAE::Xyplot::ArgumentAxisStyleSetting::LogUnitChangedEvent ( )

Logs an update event for changing display unit before committing AxisStyleSetting change.


Created in NX1847.0.0.

License requirements : None

bool NXOpen::CAE::Xyplot::ArgumentAxisStyleSetting::RangeAuto ( )

Returns a value indicating whether to set axis range automatically
Created in NX12.0.0.



License requirements : None

void NXOpen::CAE::Xyplot::ArgumentAxisStyleSetting::SetAbsCustomerRange ( const std::vector< NXString > &  absCustomerRange)

Sets the abscissa customer range

Deprecated:
Deprecated in NX1847.0.0.

Use NXOpen::CAE::Xyplot::ArgumentAxisStyleSetting::SetCustomerIndices


Created in NX12.0.0.

License requirements : None

Parameters
absCustomerRangeAbscissa customer range
void NXOpen::CAE::Xyplot::ArgumentAxisStyleSetting::SetCustomerIndices ( const std::vector< int > &  customerIndices)

Sets the customer indices
Created in NX1847.0.0.



License requirements : None

Parameters
customerIndicesCustomer range
void NXOpen::CAE::Xyplot::ArgumentAxisStyleSetting::SetRangeAuto ( bool  rangeAutomation)

Sets a value indicating whether to set axis range automatically
Created in NX12.0.0.



License requirements : None

Parameters
rangeAutomationRange auto
void NXOpen::CAE::Xyplot::ArgumentAxisStyleSetting::SetUnitSystemType ( NXOpen::CAE::XyFunctionUnitSystem  unitSystemType)

Sets the unit system type
Created in NX1847.0.0.



License requirements : None

Parameters
unitSystemTypeunitsystemtype
NXOpen::CAE::XyFunctionUnitSystem NXOpen::CAE::Xyplot::ArgumentAxisStyleSetting::UnitSystemType ( )

Returns the unit system type
Created in NX1847.0.0.



License requirements : None


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