Plot Class¶

class NXOpen.CAE.Xyplot.Plot¶

Bases: NXOpen.CAE.Xyplot.BaseModel

Manages the plot template

Not support KF.

New in version NX7.5.0.

Properties¶

Property	Description
IsOccurrence	Returns whether this object is an occurrence or not.
JournalIdentifier	Returns the identifier that would be recorded in a journal for this object.
Name	Returns the custom name of the object.
OwningComponent	Returns the owning component, if this object is an occurrence.
OwningPart	Returns the owning part of this object
PlotTemplate	Returns the plot template
Prototype	Returns the prototype of this object if it is an occurrence.
SubGraphCountInStack	Returns the sub-graph count in a stacked plot.
Tag	Returns the Tag for this object.

Methods¶

Method	Description
CommitRecordsChange	Accepts record changed and process data to update data model
CreateAttributeIterator	Create an attribute iterator
CreateNote	Creates a note on the plot
DeleteAllAttributesByType	Deletes all attributes of a specific type.
DeleteAttributeByTypeAndTitle	Deletes an attribute by type and title.
DeleteRecord	Deletes the nth record.
DeleteUserAttribute	Deletes the first attribute encountered with the given Type, Title.
DeleteUserAttributes	Deletes the attributes on the object, if any, that satisfy the given iterator
Find	Finds the `NXObject` with the given identifier as recorded in a journal.
FindObject	Finds the `NXOpen.NXObject` with the given identifier as recorded in a journal.
FitAxisLimit	Update axis limits for an overlaying plot if current displayed axis limits in plot do not fit for all records.
FitView	Fits the display view on a reasonable region.
GetApplicationDataOfRecord	Returns application specific data associated to a record.
GetAttributeTitlesByType	Gets all the attribute titles of a specific type.
GetBooleanUserAttribute	Gets a boolean attribute by Title and array Index.
GetComputationalTimeUserAttribute	Gets a time attribute by Title and array Index.
GetDeviceAndViewIndex	Gets the window device and view index of the plot graph.
GetGraphs	Gets all graphs on the plot.
GetIntegerAttribute	Gets an integer attribute by title.
GetIntegerUserAttribute	Gets an integer attribute by Title and array Index.
GetLegendTables	Gets the legend table models on the plot.
GetModels	Gets the models by model type.
GetNextUserAttribute	Gets the next attribute encountered on the object, if any, that satisfies the given iterator.
GetNotes	Gets all notes on the plot
GetPdmReferenceAttributeValue	Gets the value of PDM Reference attribute for given object.
GetRealAttribute	Gets a real attribute by title.
GetRealUserAttribute	Gets a real attribute by Title and array Index.
GetRecordCount	Returns the count of plotted records on the plot graph.
GetRecordDisplayVisibility	Gets the visibility of specified record.
GetReferenceAttribute	Gets the reference string (not the calculated value) of a string attribute that uses a reference string.
GetStringAttribute	Gets a string attribute value by title.
GetStringUserAttribute	Gets a string attribute by Title and array Index.
GetTimeAttribute	Gets a time attribute by title.
GetTimeUserAttribute	Gets a time attribute by Title and array Index.
GetTitles	Gets the titles on the plot.
GetUserAttribute	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.
GetUserAttributeAsString	Gets the first attribute encountered on the object, if any, with a given title, type and array index.
GetUserAttributeCount	Gets the count of set attributes on the object, if any, that satisfy the given iterator.
GetUserAttributeLock	Determine the lock of the given attribute.
GetUserAttributeSize	Gets the size of the first attribute encountered on the object, if any, with a given Title and Type.
GetUserAttributeSourceObjects	Returns an array of objects from which this object presents attributes.
GetUserAttributes	Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator.
GetUserAttributesAsStrings	Gets all the attributes that have been set on the given object.
GetViewBoundingBox	Gets the bounding box of the plot view.
HasUserAttribute	Determines if an attribute exists on the object, that satisfies the given iterator
Print	Prints a representation of this object to the system log file.
SaveRecords	Saves plotted records on a graph to an afu file.
SaveRecordsToCsv	Saves plotted records on a plot graph to a CSV file.
SetAttribute	Creates or modifies an integer attribute.
SetBooleanUserAttribute	Creates or modifies a boolean attribute with the option to update or not.
SetName	Sets the custom name of the object.
SetPdmReferenceAttribute	Sets the value of PDM Reference attribute on the object.
SetRecordDisplayVisibility	Sets the visibility of specified record.
SetReferenceAttribute	Creates or modifies a string attribute which uses a reference string.
SetTimeAttribute	Creates or modifies a time attribute.
SetTimeUserAttribute	Creates or modifies a time attribute with the option to update or not.
SetUserAttribute	Creates or modifies an attribute with the option to update or not.
SetUserAttributeLock	Lock or unlock the given attribute.
UpdateDisplay	Updates model display
WriteToTemplateFile	Writes the template setting of plot to template file.

Property Detail¶

IsOccurrence¶

Plot.IsOccurrence¶

Returns whether this object is an occurrence or not.

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

Getter Method

Signature IsOccurrence

Returns:	This object is an occurrence
Return type:	bool

New in version NX3.0.0.

License requirements: None.

JournalIdentifier¶

Plot.JournalIdentifier¶

Returns the identifier that would be recorded in a journal for this object.

This may not be the same across different releases of the software.

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

Getter Method

Signature JournalIdentifier

Returns:
Return type:	str

New in version NX3.0.0.

License requirements: None.

Name¶

Plot.Name¶

Returns the custom name of the object.

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

Getter Method

Signature Name

Returns:
Return type:	str

New in version NX3.0.0.

License requirements: None.

OwningComponent¶

Plot.OwningComponent¶

Returns the owning component, if this object is an occurrence.

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

Getter Method

Signature OwningComponent

Returns:
Return type:	`NXOpen.Assemblies.Component`

New in version NX3.0.0.

License requirements: None.

OwningPart¶

Plot.OwningPart¶

Returns the owning part of this object

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

Getter Method

Signature OwningPart

Returns:	The owning part of this object or null if it does not have an owner
Return type:	`NXOpen.BasePart`

New in version NX3.0.0.

License requirements: None.

PlotTemplate¶

Plot.PlotTemplate¶

Returns the plot template

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

Getter Method

Signature PlotTemplate

Returns:	Plot template
Return type:	`NXOpen.CAE.Xyplot.PlotGraphTemplate`

New in version NX10.0.0.

License requirements: None.

Prototype¶

Plot.Prototype¶

Returns the prototype of this object if it is an occurrence.

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

Getter Method

Signature Prototype

Returns:	The prototype of this object or null if this object is not an occurrence
Return type:	`NXOpen.INXObject`

New in version NX3.0.0.

License requirements: None.

SubGraphCountInStack¶

Plot.SubGraphCountInStack¶

Returns the sub-graph count in a stacked plot.

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

Getter Method

Signature SubGraphCountInStack

Returns:	Sub-graph count
Return type:	int

New in version NX10.0.0.

License requirements: None.

Method Detail¶

CommitRecordsChange¶

Plot.CommitRecordsChange¶

Accepts record changed and process data to update data model

This method is only to update data model, it needs call CAE.Xyplot.BaseModel.UpdateDisplay() to update display to reflect data change.

Signature CommitRecordsChange()

New in version NX12.0.0.

License requirements: None.

CreateNote¶

Plot.CreateNote¶

Creates a note on the plot

Signature CreateNote(lines, textPosition)

Parameters:	lines (list of str) – textPosition (`NXOpen.Point2d`) –
Returns:
Return type:	`NXOpen.CAE.Xyplot.NoteModel`

New in version NX11.0.0.

License requirements: None.

DeleteRecord¶

Plot.DeleteRecord¶

Deletes the nth record.

The record index must be greater or equal to 0, and less than CAE.Xyplot.Plot.GetRecordCount()

** Procedure of deleting records from plot fully:</b>

Call this method to delete record data from plot

Call CAE.Xyplot.Plot.CommitRecordsChange() to precess record data change and update data model

Call CAE.Xyplot.BaseModel.UpdateDisplay() to regenerate display to reflect data change

Optionally call CAE.Xyplot.Plot.FitView() to make display fit the view;it is only required when the plot display boundary is changed

Signature DeleteRecord(recordIndex)

Parameters:	recordIndex (int) –

New in version NX12.0.0.

License requirements: None.

Find¶

Plot.Find¶

Finds the NXObject with the given identifier as recorded in a journal. An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Signature Find(journalIdentifier)

Parameters:	journalIdentifier (str) – Journal identifier of the object
Returns:
Return type:	`NXOpen.TaggedObject`

New in version NX10.0.0.

Deprecated since version NX12.0.0: Use NXOpen.INXObject.FindObject()

License requirements: None.

FindObject¶

Plot.FindObject¶

Finds the NXOpen.NXObject with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Signature FindObject(journalIdentifier)

Parameters:	journalIdentifier (str) – Journal identifier of the object
Returns:
Return type:	`NXOpen.INXObject`

New in version NX3.0.0.

License requirements: None.

FitAxisLimit¶

Plot.FitAxisLimit¶

Update axis limits for an overlaying plot if current displayed axis limits in plot do not fit for all records.

Signature FitAxisLimit()

New in version NX10.0.0.

License requirements: None.

FitView¶

Plot.FitView¶

Fits the display view on a reasonable region.

Signature FitView()

New in version NX12.0.0.

License requirements: None.

GetApplicationDataOfRecord¶

Plot.GetApplicationDataOfRecord¶

Returns application specific data associated to a record.

Signature GetApplicationDataOfRecord(recordIndex)

Parameters:	recordIndex (int) – The record index starts form 0 to record count -1. Get record count from `Plot.GetRecordCount()`
Returns:
Return type:	`NXOpen.CAE.FTK.IApplicationData`

New in version NX12.0.0.

License requirements: None.

GetDeviceAndViewIndex¶

Plot.GetDeviceAndViewIndex¶

Gets the window device and view index of the plot graph.

Signature GetDeviceAndViewIndex()

Returns:	a tuple
Return type:	A tuple consisting of (windowDevice, viewIndex) windowDevice is a int. the device of window viewIndex is a int. the index of view

New in version NX9.0.0.

License requirements: None.

GetGraphs¶

Plot.GetGraphs¶

Gets all graphs on the plot.

Signature GetGraphs()

Returns:	Graph objects
Return type:	list of `NXOpen.CAE.Xyplot.Graph`

New in version NX10.0.0.

License requirements: None.

GetLegendTables¶

Plot.GetLegendTables¶

Gets the legend table models on the plot.

Signature GetLegendTables()

Returns:	Legend Table Objects
Return type:	list of `NXOpen.CAE.Xyplot.LegendTable`

New in version NX12.0.0.

License requirements: None.

GetModels¶

Plot.GetModels¶

Gets the models by model type.

Signature GetModels(type)

Parameters:	type (`NXOpen.CAE.Xyplot.ModelType`) –
Returns:
Return type:	list of `NXOpen.CAE.Xyplot.BasicModel`

New in version NX12.0.0.

License requirements: None.

GetNotes¶

Plot.GetNotes¶

Gets all notes on the plot

Signature GetNotes()

Returns:
Return type:	list of `NXOpen.CAE.Xyplot.NoteModel`

New in version NX11.0.0.

License requirements: None.

GetRecordCount¶

Plot.GetRecordCount¶

Returns the count of plotted records on the plot graph.

Signature GetRecordCount()

Returns:	Record count
Return type:	int

New in version NX9.0.0.

License requirements: None.

GetRecordDisplayVisibility¶

Plot.GetRecordDisplayVisibility¶

Gets the visibility of specified record.

Signature GetRecordDisplayVisibility(recordIndex)

Parameters:	recordIndex (int) – the index of specied record
Returns:
Return type:	bool

New in version NX12.0.0.

License requirements: None.

GetTitles¶

Plot.GetTitles¶

Gets the titles on the plot.

Signature GetTitles()

Returns:
Return type:	list of `NXOpen.CAE.Xyplot.BasicModel`

New in version NX11.0.0.

License requirements: None.

GetViewBoundingBox¶

Plot.GetViewBoundingBox¶

Gets the bounding box of the plot view.

Signature GetViewBoundingBox()

Returns:	a tuple
Return type:	A tuple consisting of (leftBottom, rightTop). leftBottom is a `NXOpen.Point3d`. rightTop is a `NXOpen.Point3d`.

New in version NX11.0.0.

License requirements: None.

Print¶

Plot.Print¶

Prints a representation of this object to the system log file.

Signature Print()

New in version NX3.0.0.

License requirements: None.

SaveRecords¶

Plot.SaveRecords¶

Saves plotted records on a graph to an afu file.

The record index is between 0 and the value returned from NXOpen.CAE.Xyplot.Plot.GetRecordCount().

Signature SaveRecords(recordIndexes, recordNames, outputFileName, reportError)

Parameters:	recordIndexes (list of int) – The index of records to be saved recordNames (list of str) – The output record names outputFileName (str) – The destination file with full file name. The file suffix must be “.afu”. reportError (bool) –

New in version NX10.0.0.

License requirements: None.

SaveRecordsToCsv¶

Plot.SaveRecordsToCsv¶

Saves plotted records on a plot graph to a CSV file.

Signature SaveRecordsToCsv(recordIndex, recordNames, csvFileName, isWriteHeader)

Parameters:	recordIndex (list of int) – the indexes of records to be saved recordNames (list of str) – csvFileName (str) – the destination CSV file name isWriteHeader (bool) –

New in version NX10.0.0.

License requirements: None.

SetName¶

Plot.SetName¶

Sets the custom name of the object.

NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Signature SetName(name)

Parameters:	name (str) –

New in version NX3.0.0.

License requirements: None.

SetRecordDisplayVisibility¶

Plot.SetRecordDisplayVisibility¶

Sets the visibility of specified record.

Signature SetRecordDisplayVisibility(recordIndex, visibility)

Parameters:	recordIndex (int) – the index of specied record visibility (bool) –

New in version NX12.0.0.

License requirements: None.

UpdateDisplay¶

Plot.UpdateDisplay¶

Updates model display

Signature UpdateDisplay()

New in version NX11.0.0.

License requirements: None.

WriteToTemplateFile¶

Plot.WriteToTemplateFile¶

Writes the template setting of plot to template file.

If input file is a simple file:

If environment variable of UGII_USER_DIR is not set, it will be written into file under user environment directory.

If environment variable of UGII_USER_DIR is not set, it will write to write the template setting.

If input file is a file with full path, the template settings will be written into the file.

Signature WriteToTemplateFile(inputTemplateFile)

Parameters:	inputTemplateFile (str) – simple name or file name with full path
Returns:	the file name with full path
Return type:	str

New in version NX12.0.0.

License requirements: None.

Plot Class¶

Properties¶

Methods¶

Property Detail¶

IsOccurrence¶

JournalIdentifier¶

Name¶

OwningComponent¶

OwningPart¶

PlotTemplate¶

Prototype¶

SubGraphCountInStack¶

Method Detail¶

CommitRecordsChange¶

CreateNote¶

DeleteRecord¶

Find¶

FindObject¶

FitAxisLimit¶

FitView¶

GetApplicationDataOfRecord¶

GetDeviceAndViewIndex¶

GetGraphs¶

GetLegendTables¶

GetModels¶

GetNotes¶

GetRecordCount¶

GetRecordDisplayVisibility¶

GetTitles¶

GetViewBoundingBox¶

Print¶

SaveRecords¶

SaveRecordsToCsv¶

SetName¶

SetRecordDisplayVisibility¶

UpdateDisplay¶

WriteToTemplateFile¶

NXOpen Python API Reference

Navigation

Related Topics