Plot2D Class

class NXOpen.CAE.Xyplot.Plot2D

Bases: NXOpen.CAE.Xyplot.Plot, NXOpen.CAE.Xyplot.I2DDataPlot

Manages the display of 2D plot.

Call CAE.Xyplot.I2DDataPlot.EditRecord() to edit data for this class.

Not support KF.

New in version NX12.0.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
EditRecord Edits nth record of plot.
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

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

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

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

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

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

Prototype

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

Method Detail

EditRecord

Plot2D.EditRecord

Edits nth record of plot.

** Procedure of editing records of plot fully:</b>

  1. Call this method to edit record data
  2. Call CAE.Xyplot.Plot.CommitRecordsChange() to precess record data change and update data model
  3. Call CAE.Xyplot.BaseModel.UpdateDisplay() to regenerate display to reflect data change
  4. Optionally call CAE.Xyplot.Plot.FitView() to make display fit the view;it is only required when the plot display boundary is changed

Signature EditRecord(nthRecordIdx, record)

Parameters:

New in version NX12.0.0.

License requirements: None.

FindObject

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

Print

Plot2D.Print

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

Signature Print()

New in version NX3.0.0.

License requirements: None.

SetName

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

UpdateDisplay

Plot2D.UpdateDisplay

Updates model display

Signature UpdateDisplay()

New in version NX11.0.0.

License requirements: None.