BaseTemplate Class

class NXOpen.CAE.Xyplot.BaseTemplate

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

Manages the display style

Not support KF.

New in version NX7.5.0.

Properties

Property Description
GridLayoutStyleSetting Returns the grid layout display style
Owner Returns the owner style
Tag Returns the Tag for this object.

Methods

Method Description
CommitChange Commits any edits that have been applied to the display style.
ExportTemplate Exports current graph template setting to a template xml file, it will override the template file if it is existing.
GetAxisStyleSetting Gets the axis display style @return Axis style
GetBarStyleSetting Gets the bar display style @return Bar style
GetGraphStyle Gets the graph style @return Graph style
GetLineStyleSetting Gets the line display style @return Line style
GetPlateStyleSetting Gets the plate display style @return Plate style
GetScatterStyleSetting Gets the scatter display style @return Scatter style
GetTextStyleSetting Gets the text style @return Text display style
ImportTemplate Updates current graph template setting from a template xml file
ResetToDefault Resets the graph template to default values
SetGraphStyle Sets the graph style

Property Detail

GridLayoutStyleSetting

BaseTemplate.GridLayoutStyleSetting

Returns the grid layout display style

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

Getter Method

Signature GridLayoutStyleSetting()

Returns:Grid layout style
Return type:NXOpen.CAE.Xyplot.BaseGridLayoutStyleSetting

New in version NX9.0.0.

Deprecated since version NX10.0.0: Use CAE.Xyplot.WallDisplayStyles.GridLayoutStyleSetting instead.

License requirements: None.

Owner

BaseTemplate.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.

Method Detail

CommitChange

BaseTemplate.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”)

ExportTemplate

BaseTemplate.ExportTemplate

Exports current graph template setting to a template xml file, it will override the template file if it is existing.

Signature ExportTemplate(strXmlFile)

Parameters:strXmlFile (str) – the template xml file name NOTE: The full Unicode character set is not supported for this parameter.

New in version NX9.0.0.

Deprecated since version NX10.0.0: Use CAE.Xyplot.PlotGraphTemplate.ExportTemplate instead.

License requirements: nx_ftk (“NX Advanced Graphing”)

GetAxisStyleSetting

BaseTemplate.GetAxisStyleSetting

Gets the axis display style

Signature GetAxisStyleSetting(axisDirection)

Parameters:axisDirection (NXOpen.CAE.Xyplot.AxisDirection) – Axis direction
Returns:Axis style
Return type:NXOpen.CAE.Xyplot.AxisStyleSetting

New in version NX9.0.0.

Deprecated since version NX10.0.0: Use CAE.Xyplot.WallDisplayStyles.GetAxisStyleSetting instead.

License requirements: None.

GetBarStyleSetting

BaseTemplate.GetBarStyleSetting

Gets the bar display style

Signature GetBarStyleSetting(styleIndex)

Parameters:styleIndex (int) – Style index, from 0 to 19
Returns:Bar style
Return type:NXOpen.CAE.Xyplot.BaseBarStyleSetting

New in version NX9.0.0.

Deprecated since version NX10.0.0: Use CAE.Xyplot.DiagramDisplayStyles.GetBarStyleSetting instead.

License requirements: None.

GetGraphStyle

BaseTemplate.GetGraphStyle

Gets the graph style

Signature GetGraphStyle(styleIndex)

Parameters:styleIndex (int) – Style index
Returns:Graph style
Return type:NXOpen.CAE.Xyplot.GraphStyle

New in version NX7.5.0.

Deprecated since version NX10.0.0: Use CAE.Xyplot.DiagramDisplayStyles.GetGraphStyle instead.

License requirements: nx_ftk (“NX Advanced Graphing”)

GetLineStyleSetting

BaseTemplate.GetLineStyleSetting

Gets the line display style

Signature GetLineStyleSetting(styleIndex)

Parameters:styleIndex (int) – Style index, from 0 to 19
Returns:Line style
Return type:NXOpen.CAE.Xyplot.BaseLineStyleSetting

New in version NX9.0.0.

Deprecated since version NX10.0.0: Use CAE.Xyplot.DiagramDisplayStyles.GetLineStyleSetting instead.

License requirements: None.

GetPlateStyleSetting

BaseTemplate.GetPlateStyleSetting

Gets the plate display style

Signature GetPlateStyleSetting(styleIndex)

Parameters:styleIndex (int) – Style index, from 0 to 19
Returns:Plate style
Return type:NXOpen.CAE.Xyplot.BasePlateStyleSetting

New in version NX9.0.0.

Deprecated since version NX10.0.0: Use CAE.Xyplot.DiagramDisplayStyles.GetPlateStyleSetting instead.

License requirements: None.

GetScatterStyleSetting

BaseTemplate.GetScatterStyleSetting

Gets the scatter display style

Signature GetScatterStyleSetting(styleIndex)

Parameters:styleIndex (int) – Style index, from 0 to 19
Returns:Scatter style
Return type:NXOpen.CAE.Xyplot.ScatterStyleSetting

New in version NX9.0.0.

Deprecated since version NX10.0.0: Use CAE.Xyplot.DiagramDisplayStyles.GetScatterStyleSetting instead.

License requirements: None.

GetTextStyleSetting

BaseTemplate.GetTextStyleSetting

Gets the text style

Signature GetTextStyleSetting(textType)

Parameters:textType (NXOpen.CAE.Xyplot.TextType) – Text type
Returns:Text display style
Return type:NXOpen.CAE.Xyplot.TextStyleSetting

New in version NX9.0.0.

Deprecated since version NX10.0.0: Use CAE.Xyplot.WallDisplayStyles.GetTextStyleSetting instead.

License requirements: None.

ImportTemplate

BaseTemplate.ImportTemplate

Updates current graph template setting from a template xml file

Signature ImportTemplate(strXmlFile)

Parameters:strXmlFile (str) – the template xml file name NOTE: The full Unicode character set is not supported for this parameter.

New in version NX9.0.0.

Deprecated since version NX10.0.0: Use CAE.Xyplot.PlotGraphTemplate.ImportTemplate instead.

License requirements: nx_ftk (“NX Advanced Graphing”)

ResetToDefault

BaseTemplate.ResetToDefault

Resets the graph template to default values

Signature ResetToDefault()

New in version NX9.0.0.

Deprecated since version NX10.0.0: Use CAE.Xyplot.PlotGraphTemplate.ResetToDefault instead.

License requirements: nx_ftk (“NX Advanced Graphing”)

SetGraphStyle

BaseTemplate.SetGraphStyle

Sets the graph style

Signature SetGraphStyle(styleIndex, graphStyle)

Parameters:

New in version NX7.5.0.

Deprecated since version NX10.0.0: Use CAE.Xyplot.DiagramDisplayStyles.SetGraphStyle instead.

License requirements: nx_ftk (“NX Advanced Graphing”)