BaseGridLayoutStyleSetting Class

class NXOpen.CAE.Xyplot.BaseGridLayoutStyleSetting

Bases: NXOpen.TaggedObject, NXOpen.CAE.Xyplot.IDisplayStyle

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.

New in version NX9.0.0.

Properties

Property	Description
BackgroundColor	Returns or sets the background color
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
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
Owner	Returns the owner style
ShowBackground	Returns or sets a value indicating whether to display the background
Tag	Returns the Tag for this object.
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.

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(bgColor)

Parameters:bgColor (Id) –

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

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(contouringLevel)

Parameters:contouringLevel (int) –

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

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(contouringRange)

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

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

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.

License requirements: None.

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

Setter Method

Signature DenseColor(color)

Parameters:color (Id) –

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

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(dispContouring)

Parameters:dispContouring (bool) –

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

GridColor

BaseGridLayoutStyleSetting.GridColor

Returns or sets the grid line color

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

Getter Method

Signature GridColor()

Returns: Return type:Id

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature GridColor(color)

Parameters:color (Id) –

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

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.

License requirements: None.

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

Setter Method

Signature GridFont(gridFont)

Parameters:gridFont (NXOpen.DisplayableObjectObjectFont) –

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

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.

License requirements: None.

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

Setter Method

Signature GridWidth(gridWidth)

Parameters:gridWidth (NXOpen.DisplayableObjectObjectWidth) –

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

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(showBg)

Parameters:showBg (bool) –

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

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(gridStyle)

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

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

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: nx_ftk (“NX Advanced Graphing”)