Manages the legend table styles. More...

Inheritance diagram for NXOpen::CAE::Xyplot::LegendTableStyle:

Public Member Functions
NXOpen::NXColor *	BackgroundColor ()
	Returns the legend table header background color Created in NX12.0.0. More...

NXOpen::CAE::Xyplot::CurveDisplaySettings *	GetBorderLineStyle ()
	Gets the border line style. More...

void	GetColumnTitles (std::vector< NXString > &columnTitles)
	Gets the legend table column titles Created in NX12.0.0. More...

NXOpen::CAE::Xyplot::CurveDisplaySettings *	GetGridLineStyle ()
	Gets the grid line style. More...

NXOpen::CAE::Xyplot::LegendTablePositionType	GetPositionType ()
	Gets the legend table style type. More...

NXOpen::CAE::Xyplot::LegendTableTextStyle *	GetTextStyle ()
	Gets the text style. More...

NXOpen::NXColor *	GridBackgroundColor ()
	Returns the grid background color Created in NX12.0.0. More...

bool	IsBorderLineVisible ()
	Returns the border line visibility Created in NX12.0.0. More...

bool	IsGridBackgroundFilled ()
	Returns the value of controlling whether the grid background is filled Created in NX12.0.0. More...

bool	IsGridLineVisible ()
	Returns the grid line visibility Created in NX12.0.0. More...

bool	IsHeaderVisible ()
	Returns the legend table header visibility Created in NX12.0.0. More...

int	MaximumLegendItemCount ()
	Returns the maximum displayable functions count on legend table page Created in NX12.0.0. More...

void	SetBackgroundColor (NXOpen::NXColor *backgroundColor)
	Sets the legend table header background color Created in NX12.0.0. More...

void	SetBorderLineVisible (bool isBorderLineVisible)
	Sets the border line visibility Created in NX12.0.0. More...

void	SetColumnTitles (std::vector< NXString > &columnTitles)
	Sets the legend table column titles Created in NX12.0.0. More...

void	SetGridBackgroundColor (NXOpen::NXColor *gridBackgroundColor)
	Sets the grid background color Created in NX12.0.0. More...

void	SetGridBackgroundFilled (bool isGridBackgroundFilled)
	Sets the value of controlling whether the grid background is filled Created in NX12.0.0. More...

void	SetGridLineVisible (bool isGridLineVisible)
	Sets the grid line visibility Created in NX12.0.0. More...

void	SetHeaderVisible (bool isHeaderVisible)
	Sets the legend table header visibility Created in NX12.0.0. More...

void	SetMaximumLegendItemCount (int maxLegendItemCount)
	Sets the maximum displayable functions count on legend table page 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::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

Manages the legend table styles.

Not support KF.

Created in NX12.0.0.

Member Function Documentation

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

Returns the legend table header background color
Created in NX12.0.0.

License requirements : None

NXOpen::CAE::Xyplot::CurveDisplaySettings* NXOpen::CAE::Xyplot::LegendTableStyle::GetBorderLineStyle ( )

Gets the border line style.

Returns: Border Line style
Created in NX12.0.0.

License requirements : None

void NXOpen::CAE::Xyplot::LegendTableStyle::GetColumnTitles ( std::vector< NXString > & columnTitles )

Gets the legend table column titles
Created in NX12.0.0.

License requirements : None

Parameters

columnTitles column titles

NXOpen::CAE::Xyplot::CurveDisplaySettings* NXOpen::CAE::Xyplot::LegendTableStyle::GetGridLineStyle ( )

Gets the grid line style.

Returns: Grid Line style
Created in NX12.0.0.

License requirements : None

NXOpen::CAE::Xyplot::LegendTablePositionType NXOpen::CAE::Xyplot::LegendTableStyle::GetPositionType ( )

Gets the legend table style type.

Returns: Created in NX12.0.0.

License requirements : None

NXOpen::CAE::Xyplot::LegendTableTextStyle* NXOpen::CAE::Xyplot::LegendTableStyle::GetTextStyle ( )

Gets the text style.

Returns: Text display style
Created in NX12.0.0.

License requirements : None

NXOpen::NXColor* NXOpen::CAE::Xyplot::LegendTableStyle::GridBackgroundColor ( )

Returns the grid background color
Created in NX12.0.0.

License requirements : None

bool NXOpen::CAE::Xyplot::LegendTableStyle::IsBorderLineVisible ( )

Returns the border line visibility
Created in NX12.0.0.

License requirements : None

bool NXOpen::CAE::Xyplot::LegendTableStyle::IsGridBackgroundFilled ( )

Returns the value of controlling whether the grid background is filled
Created in NX12.0.0.

License requirements : None

bool NXOpen::CAE::Xyplot::LegendTableStyle::IsGridLineVisible ( )

Returns the grid line visibility
Created in NX12.0.0.

License requirements : None

bool NXOpen::CAE::Xyplot::LegendTableStyle::IsHeaderVisible ( )

Returns the legend table header visibility
Created in NX12.0.0.

License requirements : None

int NXOpen::CAE::Xyplot::LegendTableStyle::MaximumLegendItemCount ( )

Returns the maximum displayable functions count on legend table page
Created in NX12.0.0.

License requirements : None

void NXOpen::CAE::Xyplot::LegendTableStyle::SetBackgroundColor ( NXOpen::NXColor * backgroundColor )

Sets the legend table header background color
Created in NX12.0.0.

License requirements : None

Parameters

backgroundColor backgroundcolor

void NXOpen::CAE::Xyplot::LegendTableStyle::SetBorderLineVisible ( bool isBorderLineVisible )

Sets the border line visibility
Created in NX12.0.0.

License requirements : None

Parameters

isBorderLineVisible isborderlinevisible

void NXOpen::CAE::Xyplot::LegendTableStyle::SetColumnTitles ( std::vector< NXString > & columnTitles )

Sets the legend table column titles
Created in NX12.0.0.

License requirements : None

Parameters

columnTitles column titles

void NXOpen::CAE::Xyplot::LegendTableStyle::SetGridBackgroundColor ( NXOpen::NXColor * gridBackgroundColor )

Sets the grid background color
Created in NX12.0.0.

License requirements : None

Parameters

gridBackgroundColor gridbackgroundcolor

void NXOpen::CAE::Xyplot::LegendTableStyle::SetGridBackgroundFilled ( bool isGridBackgroundFilled )

Sets the value of controlling whether the grid background is filled
Created in NX12.0.0.

License requirements : None

Parameters

isGridBackgroundFilled isgridbackgroundfilled

void NXOpen::CAE::Xyplot::LegendTableStyle::SetGridLineVisible ( bool isGridLineVisible )

Sets the grid line visibility
Created in NX12.0.0.

License requirements : None

Parameters

isGridLineVisible isgridlinevisible

void NXOpen::CAE::Xyplot::LegendTableStyle::SetHeaderVisible ( bool isHeaderVisible )

Sets the legend table header visibility
Created in NX12.0.0.

License requirements : None

Parameters

isHeaderVisible isheadervisible

void NXOpen::CAE::Xyplot::LegendTableStyle::SetMaximumLegendItemCount ( int maxLegendItemCount )

Sets the maximum displayable functions count on legend table page
Created in NX12.0.0.

License requirements : None

Parameters

maxLegendItemCount maxlegenditemcount

The documentation for this class was generated from the following file:

CAE_Xyplot_LegendTableStyle.hxx

Public Member Functions

Detailed Description

Member Function Documentation