Graph Class

class NXOpen.CAE.Xyplot.Graph

Bases: NXOpen.CAE.Xyplot.BaseModel

Manages the display graph.

Each graph has its owner axis and graph name. Not support KF.

New in version NX10.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
Prototype Returns the prototype of this object if it is an occurrence.
RecordCount Returns the record count of the graph.
Tag Returns the Tag for this object.

Methods

Method Description
CreateAssociativeMarker Creates an associative marker.
CreateAttributeIterator Create an attribute iterator
CreateMarker Creates a marker in the position of a source point.
DeleteAllAttributesByType Deletes all attributes of a specific type.
DeleteAttributeByTypeAndTitle Deletes an attribute by type and title.
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.
GetAbscissaAxis Gets the abscissa axis.
GetAnchorPointOfRecord Gets anchor point of 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.
GetGridBoundingBox Gets the bounding box of the grid.
GetIntegerAttribute Gets an integer attribute by title.
GetIntegerUserAttribute Gets an integer attribute by Title and array Index.
GetMarkers Gets all markers on the graph.
GetNextUserAttribute Gets the next attribute encountered on the object, if any, that satisfies the given iterator.
GetOrdinateAxes Gets the ordinate axes.
GetPdmReferenceAttributeValue Gets the value of PDM Reference attribute for given object.
GetPointCount Gets the point count of specified record.
GetRealAttribute Gets a real attribute by title.
GetRealUserAttribute Gets a real attribute by Title and array Index.
GetRecordName Gets record name.
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.
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.
GetZAxis Gets the Z axis.
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.
SetAttribute Creates or modifies an integer attribute.
SetBooleanUserAttribute Creates or modifies a boolean attribute with the option to update or not.
SetDisplayStyleOfRecord Sets the display style index for a plotted record.
SetName Sets the custom name of the object.
SetPdmReferenceAttribute Sets the value of PDM Reference attribute on the object.
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.
Unzoom Removes the zoom state for the graph and returns the display to the original state.
UpdateDisplay Updates model display
ZoomAlongX Zooms the graph along X direction by a scale range basing on current X axis display range.
ZoomAlongXY Zooms the graph along both X and Y direction by scale ranges basing on current X and Y axis display range. It is only available to 2D plot.
ZoomAlongY Zooms the graph along Y direction by a scale range basing on current Y axis display range.
ZoomAlongZ Zooms the graph along Z direction by a scale range basing on current Z axis display range. It is only available to 3D plot.

Property Detail

IsOccurrence

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

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

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

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

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

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

RecordCount

Graph.RecordCount

Returns the record count of the graph.

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

Getter Method

Signature RecordCount

Returns:Record count
Return type:int

New in version NX10.0.0.

License requirements: None.

Method Detail

CreateAssociativeMarker

Graph.CreateAssociativeMarker

Creates an associative marker.

The record index is between 0 and CAE.Xyplot.Graph.RecordCount(), 0 is inclusive.

Signature CreateAssociativeMarker(recordIndex, attachType, absPercentage)

Parameters:
  • recordIndex (int) – Record index
  • attachType (NXOpen.CAE.Xyplot.AnchorType) – Attachment Type
  • absPercentage (float) – When attachment type is CAE.XyplotAnchorType.AbsPercentage, a valid abscissa percentage(between 0 and 1, both 0 and 1 are inclusive) should be given.
Returns:

Marker model
Return type:

NXOpen.CAE.Xyplot.MarkerModel

New in version NX12.0.0.

License requirements: None.

CreateMarker

Graph.CreateMarker

Creates a marker in the position of a source point.

The record index is between 0 and CAE.Xyplot.Graph.RecordCount(), 0 is inclusive. The point index is between 0 and CAE.Xyplot.Graph.GetPointCount(), 0 is inclusive.

Signature CreateMarker(recordIndex, pointIndex)

Parameters:
  • recordIndex (int) – Record index
  • pointIndex (int) – Point index
Returns:

Marker model
Return type:

NXOpen.CAE.Xyplot.MarkerModel

New in version NX10.0.0.

License requirements: None.

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

<summary> Creates a marker in the linear interpolation position between two source points. </summary>

The record index is between 0 and CAE.Xyplot.Graph.RecordCount(), 0 is inclusive. The previous point index is between 0 and CAE.Xyplot.Graph.GetPointCount(), 0 is inclusive. The next point index is between 0 and CAE.Xyplot.Graph.GetPointCount(), 0 is inclusive. The linear interpolation scale is between 0 and 1, both 0 and 1 are inclusive.

Signature CreateMarker(recordIndex, prePointIndex, nextPointIndex, linearInterpoScale)

Parameters:
  • recordIndex (int) – Record index
  • prePointIndex (int) – Previous Point index
  • nextPointIndex (int) – Next Point index
  • linearInterpoScale (float) – Interpolation Scale
Returns:

Marker model
Return type:

NXOpen.CAE.Xyplot.MarkerModel

New in version NX12.0.0.

License requirements: None.

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

Find

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

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

GetAbscissaAxis

Graph.GetAbscissaAxis

Gets the abscissa axis.

Signature GetAbscissaAxis()

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

New in version NX11.0.0.

License requirements: None.

GetAnchorPointOfRecord

Graph.GetAnchorPointOfRecord

Gets anchor point of a record.

Signature GetAnchorPointOfRecord(recordIndex, anchorType)

Parameters:
Returns:

a tuple
Return type:

A tuple consisting of (hasAnchorPoint, anchorPoint). hasAnchorPoint is a bool. anchorPoint is a NXOpen.Point3d.

New in version NX11.0.0.

License requirements: None.

GetGridBoundingBox

Graph.GetGridBoundingBox

Gets the bounding box of the grid.

Signature GetGridBoundingBox()

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.

GetMarkers

Graph.GetMarkers

Gets all markers on the graph.

Signature GetMarkers()

Returns:Marker models
Return type:list of NXOpen.CAE.Xyplot.MarkerModel

New in version NX10.0.0.

License requirements: None.

GetOrdinateAxes

Graph.GetOrdinateAxes

Gets the ordinate axes.

Signature GetOrdinateAxes()

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

New in version NX11.0.0.

License requirements: None.

GetPointCount

Graph.GetPointCount

Gets the point count of specified record.

Signature GetPointCount(recordIndex)

Parameters:recordIndex (int) – Record index
Returns:Point count
Return type:int

New in version NX10.0.0.

License requirements: None.

GetRecordName

Graph.GetRecordName

Gets record name.

Signature GetRecordName(recordIndex)

Parameters:recordIndex (int) –
Returns:
Return type:str

New in version NX11.0.0.

License requirements: None.

GetZAxis

Graph.GetZAxis

Gets the Z axis.

Signature GetZAxis()

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

New in version NX11.0.0.

License requirements: None.

Print

Graph.Print

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

Signature Print()

New in version NX3.0.0.

License requirements: None.

SetDisplayStyleOfRecord

Graph.SetDisplayStyleOfRecord

Sets the display style index for a plotted record.

The display style index is limitted from 0 to 19.

Signature SetDisplayStyleOfRecord(recordIndex, displayStyleIndex)

Parameters:
  • recordIndex (int) –
  • displayStyleIndex (int) –

New in version NX11.0.0.

License requirements: None.

SetName

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

Unzoom

Graph.Unzoom

Removes the zoom state for the graph and returns the display to the original state.

The function just updates the model data. To make the display update to reflect the model change, please call CAE.Xyplot.BaseModel.UpdateDisplay() for an instance of CAE.Xyplot.Plot or CAE.Xyplot.Graph

Signature Unzoom()

New in version NX12.0.0.

License requirements: None.

UpdateDisplay

Graph.UpdateDisplay

Updates model display

Signature UpdateDisplay()

New in version NX11.0.0.

License requirements: None.

ZoomAlongX

Graph.ZoomAlongX

Zooms the graph along X direction by a scale range basing on current X axis display range.

The function just updates the model data. To make the display update to reflect the model change, please call CAE.Xyplot.BaseModel.UpdateDisplay() for an instance of CAE.Xyplot.Plot or CAE.Xyplot.Graph.

The scale range could be calculated from CAE.Xyplot.AxisModel.CalculateZoomScale()

Signature ZoomAlongX(startScale, endScale)

Parameters:
  • startScale (float) – the value must be between 0 and 1
  • endScale (float) – the value must be between 0 and 1

New in version NX12.0.0.

License requirements: None.

ZoomAlongXY

Graph.ZoomAlongXY

Zooms the graph along both X and Y direction by scale ranges basing on current X and Y axis display range. It is only available to 2D plot.

The function just updates the model data. To make the display update to reflect the model change, please call CAE.Xyplot.BaseModel.UpdateDisplay() for an instance of CAE.Xyplot.Plot or CAE.Xyplot.Graph.

The scale range could be calculated from CAE.Xyplot.AxisModel.CalculateZoomScale()

Signature ZoomAlongXY(xStartScale, xEndScale, yStartScale, yEndScale)

Parameters:
  • xStartScale (float) – the value must be between 0 and 1
  • xEndScale (float) – the value must be between 0 and 1
  • yStartScale (float) – the value must be between 0 and 1
  • yEndScale (float) – the value must be between 0 and 1

New in version NX12.0.0.

License requirements: None.

ZoomAlongY

Graph.ZoomAlongY

Zooms the graph along Y direction by a scale range basing on current Y axis display range.

The function just updates the model data. To make the display update to reflect the model change, please call CAE.Xyplot.BaseModel.UpdateDisplay() for an instance of CAE.Xyplot.Plot or CAE.Xyplot.Graph.

The scale range could be calculated from CAE.Xyplot.AxisModel.CalculateZoomScale()

Signature ZoomAlongY(startScale, endScale)

Parameters:
  • startScale (float) – the value must be between 0 and 1
  • endScale (float) – the value must be between 0 and 1

New in version NX12.0.0.

License requirements: None.

ZoomAlongZ

Graph.ZoomAlongZ

Zooms the graph along Z direction by a scale range basing on current Z axis display range. It is only available to 3D plot.

The function just updates the model data. To make the display update to reflect the model change, please call CAE.Xyplot.BaseModel.UpdateDisplay() for an instance of CAE.Xyplot.Plot or CAE.Xyplot.Graph.

The scale range could be calculated from CAE.Xyplot.AxisModel.CalculateZoomScale()

Signature ZoomAlongZ(startScale, endScale)

Parameters:
  • startScale (float) – the value must be between 0 and 1
  • endScale (float) – the value must be between 0 and 1

New in version NX12.0.0.

License requirements: None.