BaseGridLayoutStyleSetting Class

class NXOpen.CAE.Xyplot.BaseGridLayoutStyleSetting

Bases: NXOpen.CAE.Xyplot.BaseDisplayStyleSetting

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.

New in version NX9.0.0.

Properties

Property	Description
BackgroundColor	Returns or sets the background color
ColorOfBackgroundPlane	Returns or sets the color of grid background plane
ContouringLevel	Returns or sets the contouring level.
ContouringRange	Returns or sets the option to show contour range either on the border or the faces of the grid.
DenseColor	Returns or sets the grid dense line color
DenseGridDisplayStyleSettings	Returns the dense grid display style
DisplayContouring	Returns or sets a value indicating whether to display contouring
GridColor	Returns or sets the grid line color
GridFont	Returns or sets the grid line font
GridWidth	Returns or sets the grid line width
JournalIdentifier	Returns the identifier that would be recorded in a journal for this object.
MajorGridDisplayStyleSettings	Returns the major grid display style
Owner	Returns the owner style
ShowBackground	Returns or sets a value indicating whether to display the background
ShowBackgroundPlane	Returns or sets a value indicating whether to display the grid background plane
Tag	Returns the Tag for this object.
TicksDisplayStyleSettings	Returns the ticks display style
XyGridStyle	Returns or sets the grid style of XY plane

Methods

Method	Description
CommitChange	Commits any edits that have been applied to the display style.
Find	Finds the NXOpen.TaggedObject with the given identifier as recorded in a journal.

Property Detail

BackgroundColor

BaseGridLayoutStyleSetting.BackgroundColor

Returns or sets the background color

-------------------------------------

Getter Method

Signature BackgroundColor

Returns: Return type:Id

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature BackgroundColor

Parameters:bgColor (Id) –

New in version NX9.0.0.

License requirements: None.

ColorOfBackgroundPlane

BaseGridLayoutStyleSetting.ColorOfBackgroundPlane

Returns or sets the color of grid background plane

-------------------------------------

Getter Method

Signature ColorOfBackgroundPlane

Returns: Return type:Id

New in version NX12.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ColorOfBackgroundPlane

Parameters:bgColor (Id) –

New in version NX12.0.0.

License requirements: None.

ContouringLevel

BaseGridLayoutStyleSetting.ContouringLevel

Returns or sets the contouring level.

The value is greater than 0.

-------------------------------------

Getter Method

Signature ContouringLevel

Returns: Return type:int

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ContouringLevel

Parameters:contouringLevel (int) –

New in version NX9.0.0.

License requirements: None.

ContouringRange

BaseGridLayoutStyleSetting.ContouringRange

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

-------------------------------------

Getter Method

Signature ContouringRange

Returns: Return type:NXOpen.CAE.Xyplot.ContouringRange

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ContouringRange

Parameters:contouringRange (NXOpen.CAE.Xyplot.ContouringRange) –

New in version NX9.0.0.

License requirements: None.

DenseColor

BaseGridLayoutStyleSetting.DenseColor

Returns or sets the grid dense line color

-------------------------------------

Getter Method

Signature DenseColor

Returns: Return type:Id

New in version NX9.0.0.

Deprecated since version NX12.0.0: Use NXOpen.CAE.Xyplot.CurveDisplaySettings.Color() instead.

License requirements: None.

-------------------------------------

Setter Method

Signature DenseColor

Parameters:color (Id) –

New in version NX9.0.0.

Deprecated since version NX12.0.0: Use NXOpen.CAE.Xyplot.CurveDisplaySettings.Color() instead.

License requirements: None.

DenseGridDisplayStyleSettings

BaseGridLayoutStyleSetting.DenseGridDisplayStyleSettings

Returns the dense grid display style

-------------------------------------

Getter Method

Signature DenseGridDisplayStyleSettings

Returns: Return type:NXOpen.CAE.Xyplot.CurveDisplaySettings

New in version NX12.0.0.

License requirements: None.

DisplayContouring

BaseGridLayoutStyleSetting.DisplayContouring

Returns or sets a value indicating whether to display contouring

-------------------------------------

Getter Method

Signature DisplayContouring

Returns: Return type:bool

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DisplayContouring

Parameters:dispContouring (bool) –

New in version NX9.0.0.

License requirements: None.

GridColor

BaseGridLayoutStyleSetting.GridColor

Returns or sets the grid line color

-------------------------------------

Getter Method

Signature GridColor

Returns: Return type:Id

New in version NX9.0.0.

Deprecated since version NX12.0.0: Use NXOpen.CAE.Xyplot.CurveDisplaySettings.Color() instead.

License requirements: None.

-------------------------------------

Setter Method

Signature GridColor

Parameters:color (Id) –

New in version NX9.0.0.

Deprecated since version NX12.0.0: Use NXOpen.CAE.Xyplot.CurveDisplaySettings.Color() instead.

License requirements: None.

GridFont

BaseGridLayoutStyleSetting.GridFont

Returns or sets the grid line font

-------------------------------------

Getter Method

Signature GridFont

Returns: Return type:NXOpen.DisplayableObjectObjectFont

New in version NX9.0.0.

Deprecated since version NX12.0.0: Use NXOpen.CAE.Xyplot.CurveDisplaySettings.Font() instead.

License requirements: None.

-------------------------------------

Setter Method

Signature GridFont

Parameters:gridFont (NXOpen.DisplayableObjectObjectFont) –

New in version NX9.0.0.

Deprecated since version NX12.0.0: Use NXOpen.CAE.Xyplot.CurveDisplaySettings.Font() instead.

License requirements: None.

GridWidth

BaseGridLayoutStyleSetting.GridWidth

Returns or sets the grid line width

-------------------------------------

Getter Method

Signature GridWidth

Returns: Return type:NXOpen.DisplayableObjectObjectWidth

New in version NX9.0.0.

Deprecated since version NX12.0.0: Use NXOpen.CAE.Xyplot.CurveDisplaySettings.Width() instead.

License requirements: None.

-------------------------------------

Setter Method

Signature GridWidth

Parameters:gridWidth (NXOpen.DisplayableObjectObjectWidth) –

New in version NX9.0.0.

Deprecated since version NX12.0.0: Use NXOpen.CAE.Xyplot.CurveDisplaySettings.Width() instead.

License requirements: None.

MajorGridDisplayStyleSettings

BaseGridLayoutStyleSetting.MajorGridDisplayStyleSettings

Returns the major grid display style

-------------------------------------

Getter Method

Signature MajorGridDisplayStyleSettings

Returns: Return type:NXOpen.CAE.Xyplot.CurveDisplaySettings

New in version NX12.0.0.

License requirements: None.

Owner

BaseGridLayoutStyleSetting.Owner

Returns the owner style

-------------------------------------

Getter Method

Signature Owner

Returns: Return type:NXOpen.CAE.Xyplot.IDisplayStyle

New in version NX10.0.0.

License requirements: None.

ShowBackground

BaseGridLayoutStyleSetting.ShowBackground

Returns or sets a value indicating whether to display the background

-------------------------------------

Getter Method

Signature ShowBackground

Returns: Return type:bool

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ShowBackground

Parameters:showBg (bool) –

New in version NX9.0.0.

License requirements: None.

ShowBackgroundPlane

BaseGridLayoutStyleSetting.ShowBackgroundPlane

Returns or sets a value indicating whether to display the grid background plane

-------------------------------------

Getter Method

Signature ShowBackgroundPlane

Returns: Return type:bool

New in version NX12.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ShowBackgroundPlane

Parameters:showBg (bool) –

New in version NX12.0.0.

License requirements: None.

TicksDisplayStyleSettings

BaseGridLayoutStyleSetting.TicksDisplayStyleSettings

Returns the ticks display style

-------------------------------------

Getter Method

Signature TicksDisplayStyleSettings

Returns: Return type:NXOpen.CAE.Xyplot.CurveDisplaySettings

New in version NX12.0.0.

License requirements: None.

XyGridStyle

BaseGridLayoutStyleSetting.XyGridStyle

Returns or sets the grid style of XY plane

-------------------------------------

Getter Method

Signature XyGridStyle

Returns: Return type:NXOpen.CAE.Xyplot.GridStyle

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature XyGridStyle

Parameters:gridStyle (NXOpen.CAE.Xyplot.GridStyle) –

New in version NX9.0.0.

License requirements: None.

Method Detail

CommitChange

BaseGridLayoutStyleSetting.CommitChange

Commits any edits that have been applied to the display style.

Triggers the corresponding plot to update graph.

Signature CommitChange()

New in version NX9.0.0.

License requirements: None.