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

Represents the base grid layout display style. More...

Inheritance diagram for NXOpen::CAE::Xyplot::BaseGridLayoutStyleSetting:
NXOpen::TaggedObject NXOpen::CAE::Xyplot::IDisplayStyle NXOpen::CAE::Xyplot::GridLayoutStyle2DSetting NXOpen::CAE::Xyplot::GridLayoutStyle3DSetting

Public Member Functions

NXOpen::NXColorBackgroundColor ()
 Returns the background color
Created in NX9.0.0. More...
 
virtual void CommitChange ()
 Commits any edits that have been applied to the display style. More...
 
int ContouringLevel ()
 Returns the contouring level. More...
 
NXOpen::CAE::Xyplot::ContouringRange ContouringRange ()
 Returns the option to show contour range either on the border or the faces of the grid. More...
 
NXOpen::NXColorDenseColor ()
 Returns the grid dense line color
Created in NX9.0.0. More...
 
bool DisplayContouring ()
 Returns a value indicating whether to display contouring
Created in NX9.0.0. More...
 
NXOpen::NXColorGridColor ()
 Returns the grid line color
Created in NX9.0.0. More...
 
NXOpen::DisplayableObject::ObjectFont GridFont ()
 Returns the grid line font
Created in NX9.0.0. More...
 
NXOpen::DisplayableObject::ObjectWidth GridWidth ()
 Returns the grid line width
Created in NX9.0.0. More...
 
virtual
NXOpen::CAE::Xyplot::IDisplayStyle
Owner ()
 Returns the owner style
Created in NX10.0.0. More...
 
void SetBackgroundColor (NXOpen::NXColor *bgColor)
 Sets the background color
Created in NX9.0.0. More...
 
void SetContouringLevel (int contouringLevel)
 Sets the contouring level. More...
 
void SetContouringRange (NXOpen::CAE::Xyplot::ContouringRange contouringRange)
 Sets the option to show contour range either on the border or the faces of the grid. More...
 
void SetDenseColor (NXOpen::NXColor *color)
 Sets the grid dense line color
Created in NX9.0.0. More...
 
void SetDisplayContouring (bool dispContouring)
 Sets a value indicating whether to display contouring
Created in NX9.0.0. More...
 
void SetGridColor (NXOpen::NXColor *color)
 Sets the grid line color
Created in NX9.0.0. More...
 
void SetGridFont (NXOpen::DisplayableObject::ObjectFont gridFont)
 Sets the grid line font
Created in NX9.0.0. More...
 
void SetGridWidth (NXOpen::DisplayableObject::ObjectWidth gridWidth)
 Sets the grid line width
Created in NX9.0.0. More...
 
void SetShowBackground (bool showBg)
 Sets a value indicating whether to display the background
Created in NX9.0.0. More...
 
void SetXyGridStyle (NXOpen::CAE::Xyplot::GridStyle gridStyle)
 Sets the grid style of XY plane
Created in NX9.0.0. More...
 
bool ShowBackground ()
 Returns a value indicating whether to display the background
Created in NX9.0.0. More...
 
NXOpen::CAE::Xyplot::GridStyle XyGridStyle ()
 Returns the grid style of XY plane
Created in NX9.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 base grid layout display style.

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

Created in NX9.0.0.

Member Function Documentation

NXOpen::NXColor* NXOpen::CAE::Xyplot::BaseGridLayoutStyleSetting::BackgroundColor ( )

Returns the background color
Created in NX9.0.0.



License requirements : None

virtual void NXOpen::CAE::Xyplot::BaseGridLayoutStyleSetting::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.

int NXOpen::CAE::Xyplot::BaseGridLayoutStyleSetting::ContouringLevel ( )

Returns the contouring level.

The value is greater than 0.
Created in NX9.0.0.

License requirements : None

NXOpen::CAE::Xyplot::ContouringRange NXOpen::CAE::Xyplot::BaseGridLayoutStyleSetting::ContouringRange ( )

Returns the option to show contour range either on the border or the faces of the grid.


Created in NX9.0.0.

License requirements : None

NXOpen::NXColor* NXOpen::CAE::Xyplot::BaseGridLayoutStyleSetting::DenseColor ( )

Returns the grid dense line color
Created in NX9.0.0.



License requirements : None

bool NXOpen::CAE::Xyplot::BaseGridLayoutStyleSetting::DisplayContouring ( )

Returns a value indicating whether to display contouring
Created in NX9.0.0.



License requirements : None

NXOpen::NXColor* NXOpen::CAE::Xyplot::BaseGridLayoutStyleSetting::GridColor ( )

Returns the grid line color
Created in NX9.0.0.



License requirements : None

NXOpen::DisplayableObject::ObjectFont NXOpen::CAE::Xyplot::BaseGridLayoutStyleSetting::GridFont ( )

Returns the grid line font
Created in NX9.0.0.



License requirements : None

NXOpen::DisplayableObject::ObjectWidth NXOpen::CAE::Xyplot::BaseGridLayoutStyleSetting::GridWidth ( )

Returns the grid line width
Created in NX9.0.0.



License requirements : None

virtual NXOpen::CAE::Xyplot::IDisplayStyle* NXOpen::CAE::Xyplot::BaseGridLayoutStyleSetting::Owner ( )
virtual

Returns the owner style
Created in NX10.0.0.



License requirements : None

Implements NXOpen::CAE::Xyplot::IDisplayStyle.

void NXOpen::CAE::Xyplot::BaseGridLayoutStyleSetting::SetBackgroundColor ( NXOpen::NXColor bgColor)

Sets the background color
Created in NX9.0.0.



License requirements : nx_ftk ("NX Advanced Graphing")

Parameters
bgColorbgcolor
void NXOpen::CAE::Xyplot::BaseGridLayoutStyleSetting::SetContouringLevel ( int  contouringLevel)

Sets the contouring level.

The value is greater than 0.
Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters
contouringLevelcontouringlevel
void NXOpen::CAE::Xyplot::BaseGridLayoutStyleSetting::SetContouringRange ( NXOpen::CAE::Xyplot::ContouringRange  contouringRange)

Sets the option to show contour range either on the border or the faces of the grid.


Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters
contouringRangecontouringrange
void NXOpen::CAE::Xyplot::BaseGridLayoutStyleSetting::SetDenseColor ( NXOpen::NXColor color)

Sets the grid dense line color
Created in NX9.0.0.



License requirements : nx_ftk ("NX Advanced Graphing")

Parameters
colorcolor
void NXOpen::CAE::Xyplot::BaseGridLayoutStyleSetting::SetDisplayContouring ( bool  dispContouring)

Sets a value indicating whether to display contouring
Created in NX9.0.0.



License requirements : nx_ftk ("NX Advanced Graphing")

Parameters
dispContouringdispcontouring
void NXOpen::CAE::Xyplot::BaseGridLayoutStyleSetting::SetGridColor ( NXOpen::NXColor color)

Sets the grid line color
Created in NX9.0.0.



License requirements : nx_ftk ("NX Advanced Graphing")

Parameters
colorcolor
void NXOpen::CAE::Xyplot::BaseGridLayoutStyleSetting::SetGridFont ( NXOpen::DisplayableObject::ObjectFont  gridFont)

Sets the grid line font
Created in NX9.0.0.



License requirements : nx_ftk ("NX Advanced Graphing")

Parameters
gridFontgridfont
void NXOpen::CAE::Xyplot::BaseGridLayoutStyleSetting::SetGridWidth ( NXOpen::DisplayableObject::ObjectWidth  gridWidth)

Sets the grid line width
Created in NX9.0.0.



License requirements : nx_ftk ("NX Advanced Graphing")

Parameters
gridWidthgridwidth
void NXOpen::CAE::Xyplot::BaseGridLayoutStyleSetting::SetShowBackground ( bool  showBg)

Sets a value indicating whether to display the background
Created in NX9.0.0.



License requirements : nx_ftk ("NX Advanced Graphing")

Parameters
showBgshowbg
void NXOpen::CAE::Xyplot::BaseGridLayoutStyleSetting::SetXyGridStyle ( NXOpen::CAE::Xyplot::GridStyle  gridStyle)

Sets the grid style of XY plane
Created in NX9.0.0.



License requirements : nx_ftk ("NX Advanced Graphing")

Parameters
gridStylegridstyle
bool NXOpen::CAE::Xyplot::BaseGridLayoutStyleSetting::ShowBackground ( )

Returns a value indicating whether to display the background
Created in NX9.0.0.



License requirements : None

NXOpen::CAE::Xyplot::GridStyle NXOpen::CAE::Xyplot::BaseGridLayoutStyleSetting::XyGridStyle ( )

Returns the grid style of XY plane
Created in NX9.0.0.



License requirements : None


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