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

Inheritance diagram for NXOpen::CAE::Xyplot::BaseGridLayoutStyleSetting:

Public Member Functions
NXOpen::NXColor *	BackgroundColor ()
	Returns the background color Created in NX9.0.0. More...

NXOpen::NXColor *	ColorOfBackgroundPlane ()
	Returns the color of grid background plane Created in NX12.0.0. 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::NXColor *	DenseColor ()
	Returns the grid dense line color More...

NXOpen::CAE::Xyplot::CurveDisplaySettings *	DenseGridDisplayStyleSettings ()
	Returns the dense grid display style Created in NX12.0.0. More...

bool	DisplayContouring ()
	Returns a value indicating whether to display contouring Created in NX9.0.0. More...

NXOpen::NXColor *	GridColor ()
	Returns the grid line color More...

NXOpen::DisplayableObject::ObjectFont	GridFont ()
	Returns the grid line font More...

NXOpen::DisplayableObject::ObjectWidth	GridWidth ()
	Returns the grid line width More...

NXOpen::CAE::Xyplot::CurveDisplaySettings *	MajorGridDisplayStyleSettings ()
	Returns the major grid display style Created in NX12.0.0. More...

void	SetBackgroundColor (NXOpen::NXColor *bgColor)
	Sets the background color Created in NX9.0.0. More...

void	SetColorOfBackgroundPlane (NXOpen::NXColor *bgColor)
	Sets the color of grid background plane Created in NX12.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 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 More...

void	SetGridFont (NXOpen::DisplayableObject::ObjectFont gridFont)
	Sets the grid line font More...

void	SetGridWidth (NXOpen::DisplayableObject::ObjectWidth gridWidth)
	Sets the grid line width More...

void	SetShowBackground (bool showBg)
	Sets a value indicating whether to display the background Created in NX9.0.0. More...

void	SetShowBackgroundPlane (bool showBg)
	Sets a value indicating whether to display the grid background plane Created in NX12.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...

bool	ShowBackgroundPlane ()
	Returns a value indicating whether to display the grid background plane Created in NX12.0.0. More...

NXOpen::CAE::Xyplot::CurveDisplaySettings *	TicksDisplayStyleSettings ()
	Returns the ticks display style Created in NX12.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::CAE::Xyplot::BaseDisplayStyleSetting
virtual void	CommitChange ()
	Commits any edits that have been applied to the display style. More...

NXOpen::TaggedObject *	Find (const NXString &journalIdentifier)
	Finds the NXOpen::TaggedObject with the given identifier as recorded in a journal. More...

NXOpen::TaggedObject *	Find (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 base grid layout display style.

Call CAE::Xyplot::BaseDisplayStyleSetting::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

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

Returns the color of grid background plane
Created in NX12.0.0.

License requirements : None

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

Deprecated:: Deprecated in NX12.0.0.

Use NXOpen::CAE::Xyplot::CurveDisplaySettings::Color instead.

Created in NX9.0.0.

License requirements : None

NXOpen::CAE::Xyplot::CurveDisplaySettings* NXOpen::CAE::Xyplot::BaseGridLayoutStyleSetting::DenseGridDisplayStyleSettings ( )

Returns the dense grid display style
Created in NX12.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

Deprecated:: Deprecated in NX12.0.0.

Use NXOpen::CAE::Xyplot::CurveDisplaySettings::Color instead.

Created in NX9.0.0.

License requirements : None

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

Returns the grid line font

Deprecated:: Deprecated in NX12.0.0.

Use NXOpen::CAE::Xyplot::CurveDisplaySettings::Font instead.

Created in NX9.0.0.

License requirements : None

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

Returns the grid line width

Deprecated:: Deprecated in NX12.0.0.

Use NXOpen::CAE::Xyplot::CurveDisplaySettings::Width instead.

Created in NX9.0.0.

License requirements : None

NXOpen::CAE::Xyplot::CurveDisplaySettings* NXOpen::CAE::Xyplot::BaseGridLayoutStyleSetting::MajorGridDisplayStyleSettings ( )

Returns the major grid display style
Created in NX12.0.0.

License requirements : None

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

Sets the background color
Created in NX9.0.0.

License requirements : None

Parameters

bgColor bgcolor

void NXOpen::CAE::Xyplot::BaseGridLayoutStyleSetting::SetColorOfBackgroundPlane ( NXOpen::NXColor * bgColor )

Sets the color of grid background plane
Created in NX12.0.0.

License requirements : None

Parameters

bgColor bgcolor

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 : None

Parameters

contouringLevel contouringlevel

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 : None

Parameters

contouringRange contouringrange

void NXOpen::CAE::Xyplot::BaseGridLayoutStyleSetting::SetDenseColor ( NXOpen::NXColor * color )

Sets the grid dense line color

Deprecated:: Deprecated in NX12.0.0.

Use NXOpen::CAE::Xyplot::CurveDisplaySettings::SetColor instead.

Created in NX9.0.0.

License requirements : None

Parameters

color color

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

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

License requirements : None

Parameters

dispContouring dispcontouring

void NXOpen::CAE::Xyplot::BaseGridLayoutStyleSetting::SetGridColor ( NXOpen::NXColor * color )

Sets the grid line color

Deprecated:: Deprecated in NX12.0.0.

Use NXOpen::CAE::Xyplot::CurveDisplaySettings::SetColor instead.

Created in NX9.0.0.

License requirements : None

Parameters

color color

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

Sets the grid line font

Deprecated:: Deprecated in NX12.0.0.

Use NXOpen::CAE::Xyplot::CurveDisplaySettings::SetFont instead.

Created in NX9.0.0.

License requirements : None

Parameters

gridFont gridfont

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

Sets the grid line width

Deprecated:: Deprecated in NX12.0.0.

Use NXOpen::CAE::Xyplot::CurveDisplaySettings::SetWidth instead.

Created in NX9.0.0.

License requirements : None

Parameters

gridWidth gridwidth

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

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

License requirements : None

Parameters

showBg showbg

void NXOpen::CAE::Xyplot::BaseGridLayoutStyleSetting::SetShowBackgroundPlane ( bool showBg )

Sets a value indicating whether to display the grid background plane
Created in NX12.0.0.

License requirements : None

Parameters

showBg showbg

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 : None

Parameters

gridStyle gridstyle

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

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

License requirements : None

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

Returns a value indicating whether to display the grid background plane
Created in NX12.0.0.

License requirements : None

NXOpen::CAE::Xyplot::CurveDisplaySettings* NXOpen::CAE::Xyplot::BaseGridLayoutStyleSetting::TicksDisplayStyleSettings ( )

Returns the ticks display style
Created in NX12.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:

CAE_Xyplot_BaseGridLayoutStyleSetting.hxx

Public Member Functions

Detailed Description

Member Function Documentation