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

Represents the marker display style. More...

Inheritance diagram for NXOpen::CAE::Xyplot::MarkerStyleSetting:
NXOpen::CAE::Xyplot::TextStyleSetting NXOpen::CAE::Xyplot::BaseDisplayStyleSetting NXOpen::CAE::Xyplot::IVisibleDisplayStyle NXOpen::TaggedObject NXOpen::CAE::Xyplot::IDisplayStyle

Public Member Functions

double AbsPercentage ()
 Returns the scale of abscissa percentage setting, just for attachment type: Abscissa Percentage, and the value shuould be limited in [0.0, 1.0]
Created in NX12.0.0. More...
 
NXOpen::CAE::Xyplot::AnchorType AttachmentType ()
 Returns the attachment type for associative marker
Created in NX12.0.0. More...
 
std::vector< NXStringGetNoteTexts ()
 Gets the note texts. More...
 
bool NoteTextVisibility ()
 Returns the option specifies whether to show note text
Created in NX12.0.0. More...
 
bool NumberTextVisibility ()
 Returns the option specifies whether to show number text
Created in NX12.0.0. More...
 
void SetAbsPercentage (double absPercentage)
 Sets the scale of abscissa percentage setting, just for attachment type: Abscissa Percentage, and the value shuould be limited in [0.0, 1.0]
Created in NX12.0.0. More...
 
void SetAttachmentType (NXOpen::CAE::Xyplot::AnchorType anchorType)
 Sets the attachment type for associative marker
Created in NX12.0.0. More...
 
void SetNoteTexts (const std::vector< NXString > &noteTexts)
 Sets the note texts
Created in NX12.0.0. More...
 
void SetNoteTextVisibility (bool isNoteTextVisible)
 Sets the option specifies whether to show note text
Created in NX12.0.0. More...
 
void SetNumberTextVisibility (bool isNumberTextVisible)
 Sets the option specifies whether to show number text
Created in NX12.0.0. More...
 
void SetSnapToData (bool isSnapToData)
 Sets the option specifies whether just to search source data when creating associative marker
Created in NX12.0.0. More...
 
bool SnapToData ()
 Returns the option specifies whether just to search source data when creating associative marker
Created in NX12.0.0. More...
 
- Public Member Functions inherited from NXOpen::CAE::Xyplot::TextStyleSetting
NXOpen::CAE::Xyplot::TextAlignment Alignment ()
 Returns the text alignment. More...
 
NXOpen::NXColorColor ()
 Returns the text color
Created in NX9.0.0. More...
 
NXString Font ()
 Returns the text font
Created in NX9.0.0. More...
 
NXOpen::Preferences::VisualizationFonts::StyleType FontStyle ()
 Returns the text font style. More...
 
NXOpen::CAE::Xyplot::Fonttype FontType ()
 Returns the text font type
Created in NX9.0.0. More...
 
double GlobalSizeScale ()
 Returns the scale of global text size. More...
 
bool IsGlobalSizeAutoScaled ()
 Returns a value indicating whether to automatically adjust the scale of global text size to fit the screen. More...
 
NXOpen::CAE::Xyplot::LeaderStyleLeaderStyle ()
 Returns the leader style
Created in NX12.0.0. More...
 
NXOpen::CAE::NumberFormatNumberFormat ()
 Returns the number format options
Created in NX12.0.0. More...
 
NXOpen::CAE::Xyplot::TextOrientation Orientation ()
 Returns the text orientation. More...
 
void SetAlignment (NXOpen::CAE::Xyplot::TextAlignment alignment)
 Sets the text alignment. More...
 
void SetColor (NXOpen::NXColor *color)
 Sets the text color
Created in NX9.0.0. More...
 
void SetFont (const NXString &font)
 Sets the text font
Created in NX9.0.0. More...
 
void SetFont (const char *font)
 Sets the text font
Created in NX9.0.0. More...
 
void SetFontStyle (NXOpen::Preferences::VisualizationFonts::StyleType fontStyle)
 Sets the text font style. More...
 
void SetFontType (NXOpen::CAE::Xyplot::Fonttype fontType)
 Sets the text font type
Created in NX9.0.0. More...
 
void SetGlobalSizeAutoScaled (bool isGlobalSizeAutoScaled)
 Sets a value indicating whether to automatically adjust the scale of global text size to fit the screen. More...
 
void SetGlobalSizeScale (double sizeScale)
 Sets the scale of global text size. More...
 
void SetOrientation (NXOpen::CAE::Xyplot::TextOrientation orientation)
 Sets the text orientation. More...
 
void SetSize (int size)
 Sets the text size. More...
 
void SetUseGlobalFontSetting (bool useGlobalFontSetting)
 Sets a value indicating whether to use the global setting of text font, font style and font size. More...
 
virtual void SetVisibility (bool visibility)
 Sets the visibility
Created in NX12.0.0. More...
 
void SetWeight (NXOpen::Display::TransientText::TextSize weight)
 Sets the text weight. More...
 
int Size ()
 Returns the text size. More...
 
NXOpen::CAE::Xyplot::TextBoxStyleSettingTextBoxStyle ()
 Returns the style of text box
Created in NX9.0.0. More...
 
bool UseGlobalFontSetting ()
 Returns a value indicating whether to use the global setting of text font, font style and font size. More...
 
virtual bool Visibility ()
 Returns the visibility
Created in NX12.0.0. More...
 
NXOpen::Display::TransientText::TextSize Weight ()
 Returns the text weight. 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 marker 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

double NXOpen::CAE::Xyplot::MarkerStyleSetting::AbsPercentage ( )

Returns the scale of abscissa percentage setting, just for attachment type: Abscissa Percentage, and the value shuould be limited in [0.0, 1.0]
Created in NX12.0.0.



License requirements : None

NXOpen::CAE::Xyplot::AnchorType NXOpen::CAE::Xyplot::MarkerStyleSetting::AttachmentType ( )

Returns the attachment type for associative marker
Created in NX12.0.0.



License requirements : None

std::vector<NXString> NXOpen::CAE::Xyplot::MarkerStyleSetting::GetNoteTexts ( )

Gets the note texts.

Returns
Note Texts
Created in NX12.0.0.

License requirements : None
bool NXOpen::CAE::Xyplot::MarkerStyleSetting::NoteTextVisibility ( )

Returns the option specifies whether to show note text
Created in NX12.0.0.



License requirements : None

bool NXOpen::CAE::Xyplot::MarkerStyleSetting::NumberTextVisibility ( )

Returns the option specifies whether to show number text
Created in NX12.0.0.



License requirements : None

void NXOpen::CAE::Xyplot::MarkerStyleSetting::SetAbsPercentage ( double  absPercentage)

Sets the scale of abscissa percentage setting, just for attachment type: Abscissa Percentage, and the value shuould be limited in [0.0, 1.0]
Created in NX12.0.0.



License requirements : None

Parameters
absPercentageabscissa percentage
void NXOpen::CAE::Xyplot::MarkerStyleSetting::SetAttachmentType ( NXOpen::CAE::Xyplot::AnchorType  anchorType)

Sets the attachment type for associative marker
Created in NX12.0.0.



License requirements : None

Parameters
anchorTypeattachment type
void NXOpen::CAE::Xyplot::MarkerStyleSetting::SetNoteTexts ( const std::vector< NXString > &  noteTexts)

Sets the note texts
Created in NX12.0.0.



License requirements : None

Parameters
noteTextsNote Texts
void NXOpen::CAE::Xyplot::MarkerStyleSetting::SetNoteTextVisibility ( bool  isNoteTextVisible)

Sets the option specifies whether to show note text
Created in NX12.0.0.



License requirements : None

Parameters
isNoteTextVisiblenote text
void NXOpen::CAE::Xyplot::MarkerStyleSetting::SetNumberTextVisibility ( bool  isNumberTextVisible)

Sets the option specifies whether to show number text
Created in NX12.0.0.



License requirements : None

Parameters
isNumberTextVisiblenumber text
void NXOpen::CAE::Xyplot::MarkerStyleSetting::SetSnapToData ( bool  isSnapToData)

Sets the option specifies whether just to search source data when creating associative marker
Created in NX12.0.0.



License requirements : None

Parameters
isSnapToDatasnap to data
bool NXOpen::CAE::Xyplot::MarkerStyleSetting::SnapToData ( )

Returns the option specifies whether just to search source data when creating associative marker
Created in NX12.0.0.



License requirements : None


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