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

Represents the result legend style. More...

Inheritance diagram for NXOpen::CAE::Xyplot::ResultLegendStyle:
NXOpen::CAE::Xyplot::BaseDisplayStyleSetting NXOpen::CAE::Xyplot::IVisibleDisplayStyle NXOpen::TaggedObject NXOpen::CAE::Xyplot::IDisplayStyle

Public Member Functions

NXOpen::CAE::Xyplot::FlowResultColor OverflowResultColorOption ()
 Returns the overflow result color option
Created in NX1847.0.0. More...
 
NXOpen::NXColorOverflowResultShadedColor ()
 Returns the user defined color of overflow result, only available when NXOpen::CAE::Xyplot::ResultLegendStyle::OverflowResultColorOption and NXOpen::CAE::Xyplot::ResultLegendStyle::SetOverflowResultColorOption is NXOpen::CAE::Xyplot::FlowResultColorShaded
Created in NX1847.0.0. More...
 
void SetOverflowResultColorOption (NXOpen::CAE::Xyplot::FlowResultColor colorOption)
 Sets the overflow result color option
Created in NX1847.0.0. More...
 
void SetOverflowResultShadedColor (NXOpen::NXColor *colorId)
 Sets the user defined color of overflow result, only available when NXOpen::CAE::Xyplot::ResultLegendStyle::OverflowResultColorOption and NXOpen::CAE::Xyplot::ResultLegendStyle::SetOverflowResultColorOption is NXOpen::CAE::Xyplot::FlowResultColorShaded
Created in NX1847.0.0. More...
 
void SetUnderflowResultColorOption (NXOpen::CAE::Xyplot::FlowResultColor colorOption)
 Sets the underflow result color option
Created in NX1847.0.0. More...
 
void SetUnderflowResultShadedColor (NXOpen::NXColor *colorId)
 Sets the user defined color of overflow result, only available when NXOpen::CAE::Xyplot::ResultLegendStyle::UnderflowResultColorOption and NXOpen::CAE::Xyplot::ResultLegendStyle::SetUnderflowResultColorOption is NXOpen::CAE::Xyplot::FlowResultColorShaded
Created in NX1847.0.0. More...
 
void SetUnknownResultColorOption (NXOpen::CAE::Xyplot::UnknownResultColor unknownResultColor)
 Sets the unknown result color option
Created in NX1847.0.0. More...
 
virtual void SetVisibility (bool visibility)
 Sets the visibility
Created in NX12.0.0. More...
 
NXOpen::CAE::Xyplot::FlowResultColor UnderflowResultColorOption ()
 Returns the underflow result color option
Created in NX1847.0.0. More...
 
NXOpen::NXColorUnderflowResultShadedColor ()
 Returns the user defined color of overflow result, only available when NXOpen::CAE::Xyplot::ResultLegendStyle::UnderflowResultColorOption and NXOpen::CAE::Xyplot::ResultLegendStyle::SetUnderflowResultColorOption is NXOpen::CAE::Xyplot::FlowResultColorShaded
Created in NX1847.0.0. More...
 
NXOpen::CAE::Xyplot::UnknownResultColor UnknownResultColorOption ()
 Returns the unknown result color option
Created in NX1847.0.0. More...
 
virtual bool Visibility ()
 Returns the visibility
Created in NX12.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 result legend style.

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

Created in NX1847.0.0.

Member Function Documentation

NXOpen::CAE::Xyplot::FlowResultColor NXOpen::CAE::Xyplot::ResultLegendStyle::OverflowResultColorOption ( )

Returns the overflow result color option
Created in NX1847.0.0.



License requirements : None

NXOpen::NXColor* NXOpen::CAE::Xyplot::ResultLegendStyle::OverflowResultShadedColor ( )

Returns the user defined color of overflow result, only available when NXOpen::CAE::Xyplot::ResultLegendStyle::OverflowResultColorOption and NXOpen::CAE::Xyplot::ResultLegendStyle::SetOverflowResultColorOption is NXOpen::CAE::Xyplot::FlowResultColorShaded
Created in NX1847.0.0.



License requirements : None

void NXOpen::CAE::Xyplot::ResultLegendStyle::SetOverflowResultColorOption ( NXOpen::CAE::Xyplot::FlowResultColor  colorOption)

Sets the overflow result color option
Created in NX1847.0.0.



License requirements : None

Parameters
colorOptioncoloroption
void NXOpen::CAE::Xyplot::ResultLegendStyle::SetOverflowResultShadedColor ( NXOpen::NXColor colorId)

Sets the user defined color of overflow result, only available when NXOpen::CAE::Xyplot::ResultLegendStyle::OverflowResultColorOption and NXOpen::CAE::Xyplot::ResultLegendStyle::SetOverflowResultColorOption is NXOpen::CAE::Xyplot::FlowResultColorShaded
Created in NX1847.0.0.



License requirements : None

Parameters
colorIdcolorid
void NXOpen::CAE::Xyplot::ResultLegendStyle::SetUnderflowResultColorOption ( NXOpen::CAE::Xyplot::FlowResultColor  colorOption)

Sets the underflow result color option
Created in NX1847.0.0.



License requirements : None

Parameters
colorOptioncoloroption
void NXOpen::CAE::Xyplot::ResultLegendStyle::SetUnderflowResultShadedColor ( NXOpen::NXColor colorId)

Sets the user defined color of overflow result, only available when NXOpen::CAE::Xyplot::ResultLegendStyle::UnderflowResultColorOption and NXOpen::CAE::Xyplot::ResultLegendStyle::SetUnderflowResultColorOption is NXOpen::CAE::Xyplot::FlowResultColorShaded
Created in NX1847.0.0.



License requirements : None

Parameters
colorIdcolorid
void NXOpen::CAE::Xyplot::ResultLegendStyle::SetUnknownResultColorOption ( NXOpen::CAE::Xyplot::UnknownResultColor  unknownResultColor)

Sets the unknown result color option
Created in NX1847.0.0.



License requirements : None

Parameters
unknownResultColorunknownresultcolor
virtual void NXOpen::CAE::Xyplot::ResultLegendStyle::SetVisibility ( bool  visibility)
virtual

Sets the visibility
Created in NX12.0.0.



License requirements : None

Parameters
visibilityvisibility

Implements NXOpen::CAE::Xyplot::IVisibleDisplayStyle.

NXOpen::CAE::Xyplot::FlowResultColor NXOpen::CAE::Xyplot::ResultLegendStyle::UnderflowResultColorOption ( )

Returns the underflow result color option
Created in NX1847.0.0.



License requirements : None

NXOpen::NXColor* NXOpen::CAE::Xyplot::ResultLegendStyle::UnderflowResultShadedColor ( )

Returns the user defined color of overflow result, only available when NXOpen::CAE::Xyplot::ResultLegendStyle::UnderflowResultColorOption and NXOpen::CAE::Xyplot::ResultLegendStyle::SetUnderflowResultColorOption is NXOpen::CAE::Xyplot::FlowResultColorShaded
Created in NX1847.0.0.



License requirements : None

NXOpen::CAE::Xyplot::UnknownResultColor NXOpen::CAE::Xyplot::ResultLegendStyle::UnknownResultColorOption ( )

Returns the unknown result color option
Created in NX1847.0.0.



License requirements : None

virtual bool NXOpen::CAE::Xyplot::ResultLegendStyle::Visibility ( )
virtual

Returns the visibility
Created in NX12.0.0.



License requirements : None

Implements NXOpen::CAE::Xyplot::IVisibleDisplayStyle.


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