NXOpen .NET Reference Guide
|
Manages the plot template More...
Public Member Functions | |
unsafe void | CommitRecordsChange () |
Accepts record changed and process data to update data model More... | |
unsafe NXOpen.CAE.Xyplot.NoteModel | CreateNote (string[] lines, NXOpen.Point2d textPosition) |
Creates a note on the plot More... | |
unsafe void | DeleteRecord (int recordIndex) |
Deletes the nth record. More... | |
unsafe NXOpen.TaggedObject | Find (string journalIdentifier) |
Finds the NXObject with the given identifier as recorded in a journal. More... | |
unsafe void | FitAxisLimit () |
Update axis limits for an overlaying plot if current displayed axis limits in plot do not fit for all records. More... | |
unsafe void | FitView () |
Fits the display view on a reasonable region. More... | |
unsafe NXOpen.CAE.FTK.IApplicationData | GetApplicationDataOfRecord (int recordIndex) |
Returns application specific data associated to a record. More... | |
unsafe int | GetDeviceAndViewIndex (out int viewIndex) |
Gets the window device and view index of the plot graph. More... | |
unsafe void | GetGraphs (out NXOpen.CAE.Xyplot.Graph[] graphs) |
Gets all graphs on the plot. More... | |
unsafe NXOpen.CAE.Xyplot.LegendTable[] | GetLegendTables () |
Gets the legend table models on the plot. More... | |
unsafe NXOpen.CAE.Xyplot.BasicModel[] | GetModels (NXOpen.CAE.Xyplot.ModelType type) |
Gets the models by model type. More... | |
unsafe NXOpen.CAE.Xyplot.NoteModel[] | GetNotes () |
Gets all notes on the plot More... | |
unsafe NXOpen.TaggedObject | GetPostEnvironmentSettings () |
Gets the post environment settings in the plot. More... | |
unsafe int | GetRecordCount () |
Returns the count of plotted records on the plot graph. More... | |
unsafe bool | GetRecordDisplayVisibility (int recordIndex) |
Gets the visibility of specified record. More... | |
unsafe NXOpen.CAE.Xyplot.BasicModel[] | GetTitles () |
Gets the titles on the plot. More... | |
unsafe void | GetViewBoundingBox (out NXOpen.Point3d leftBottom, out NXOpen.Point3d rightTop) |
Gets the bounding box of the plot view. More... | |
unsafe void | SaveRecords (int[] recordIndexes, string[] recordNames, string outputFileName, bool reportError) |
Saves plotted records on a graph to an afu file. More... | |
unsafe void | SaveRecordsToCsv (int[] recordIndex, string[] recordNames, string csvFileName, bool isWriteHeader) |
Saves plotted records on a plot graph to a CSV file. More... | |
unsafe void | SetRecordDisplayVisibility (int recordIndex, bool visibility) |
Sets the visibility of specified record. More... | |
unsafe string | WriteToTemplateFile (string inputTemplateFile) |
Writes the template setting of plot to template file. More... | |
Public Member Functions inherited from NXOpen.CAE.Xyplot.BaseModel | |
unsafe void | UpdateDisplay () |
Updates model display More... | |
Public Member Functions inherited from NXOpen.NXObject | |
unsafe NXOpen.AttributeIterator | CreateAttributeIterator () |
Create an attribute iterator More... | |
unsafe void | DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type) |
Deletes all attributes of a specific type. More... | |
unsafe void | DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option) |
Deletes all attributes of a specific type with the option to update or not. More... | |
unsafe void | DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title) |
Deletes an attribute by type and title. More... | |
unsafe void | DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title, NXOpen.Update.Option option) |
Deletes an attribute by type and title with the option to update or not. More... | |
unsafe void | DeleteUserAttribute (NXOpen.NXObject.AttributeType type, string title, bool deleteEntireArray, NXOpen.Update.Option option) |
Deletes the first attribute encountered with the given Type, Title. More... | |
unsafe void | DeleteUserAttributes (NXOpen.AttributeIterator iterator, NXOpen.Update.Option option) |
Deletes the attributes on the object, if any, that satisfy the given iterator More... | |
unsafe void | DeleteUserAttributes (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option) |
Deletes the attributes encountered with the given Type with option to update or not. More... | |
unsafe NXOpen.INXObject | FindObject (string journalIdentifier) |
Finds the NXOpen.NXObject with the given identifier as recorded in a journal. More... | |
unsafe NXOpen.NXObject.AttributeInformation[] | GetAttributeTitlesByType (NXOpen.NXObject.AttributeType type) |
Gets all the attribute titles of a specific type. More... | |
unsafe bool | GetBooleanUserAttribute (string title, int index) |
Gets a boolean attribute by Title and array Index. More... | |
unsafe NXOpen.NXObject.ComputationalTime | GetComputationalTimeUserAttribute (string title, int index) |
Gets a time attribute by Title and array Index. More... | |
unsafe int | GetIntegerAttribute (string title) |
Gets an integer attribute by title. More... | |
unsafe int | GetIntegerUserAttribute (string title, int index) |
Gets an integer attribute by Title and array Index. More... | |
unsafe bool | GetNextUserAttribute (NXOpen.AttributeIterator iterator, out NXOpen.NXObject.AttributeInformation info) |
Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More... | |
unsafe string | GetPdmReferenceAttributeValue (string attributeTitle) |
Gets the value of PDM Reference attribute for given object. More... | |
unsafe double | GetRealAttribute (string title) |
Gets a real attribute by title. More... | |
unsafe double | GetRealUserAttribute (string title, int index) |
Gets a real attribute by Title and array Index. More... | |
unsafe string | GetReferenceAttribute (string title) |
Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More... | |
unsafe string | GetStringAttribute (string title) |
Gets a string attribute value by title. More... | |
unsafe string | GetStringUserAttribute (string title, int index) |
Gets a string attribute by Title and array Index. More... | |
unsafe string | GetTimeAttribute (NXOpen.NXObject.DateAndTimeFormat format, string title) |
Gets a time attribute by title. More... | |
unsafe string | GetTimeUserAttribute (string title, int index) |
Gets a time attribute by Title and array Index. More... | |
unsafe NXOpen.NXObject.AttributeInformation | GetUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index) |
Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More... | |
unsafe NXOpen.NXObject.AttributeInformation[] | GetUserAttribute (string title, bool includeUnset, bool addStringValues, NXOpen.NXObject.AttributeType type) |
Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More... | |
unsafe string | GetUserAttributeAsString (string title, NXOpen.NXObject.AttributeType type, int index) |
Gets the first attribute encountered on the object, if any, with a given title, type and array index. More... | |
unsafe int | GetUserAttributeCount (NXOpen.AttributeIterator iterator) |
Gets the count of set attributes on the object, if any, that satisfy the given iterator. More... | |
unsafe int | GetUserAttributeCount (NXOpen.AttributeIterator iterator, bool countArrayAsOneAttribute) |
Gets the count of set attributes on the object, if any, that satisfy the given iterator. More... | |
unsafe int | GetUserAttributeCount (NXOpen.NXObject.AttributeType type) |
Gets the count of set attributes on the object, if any, of the given type. More... | |
unsafe int | GetUserAttributeCount (NXOpen.NXObject.AttributeType type, bool includeUnset, bool countArrayAsOneAttribute) |
Gets the count of attributes on the object, if any, of the given type. More... | |
unsafe bool | GetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type) |
Determine the lock of the given attribute. More... | |
unsafe NXOpen.NXObject.AttributeInformation[] | GetUserAttributes (NXOpen.AttributeIterator iterator) |
Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. More... | |
unsafe NXOpen.NXObject.AttributeInformation[] | GetUserAttributes () |
Gets all the attributes that have been set on the given object. More... | |
unsafe NXOpen.NXObject.AttributeInformation[] | GetUserAttributes (bool includeUnset) |
Gets all the attributes of the given object. More... | |
unsafe NXOpen.NXObject.AttributeInformation[] | GetUserAttributes (bool includeUnset, bool addStringValues) |
Gets all the attributes of the given object. More... | |
unsafe string[] | GetUserAttributesAsStrings () |
Gets all the attributes that have been set on the given object. More... | |
unsafe int | GetUserAttributeSize (string title, NXOpen.NXObject.AttributeType type) |
Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More... | |
unsafe NXOpen.NXObject[] | GetUserAttributeSourceObjects () |
Returns an array of objects from which this object presents attributes. More... | |
unsafe bool | HasUserAttribute (NXOpen.AttributeIterator iterator) |
Determines if an attribute exists on the object, that satisfies the given iterator More... | |
unsafe bool | HasUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index) |
Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More... | |
unsafe void | Print () |
Prints a representation of this object to the system log file. More... | |
unsafe void | SetAttribute (string title, int value) |
Creates or modifies an integer attribute. More... | |
unsafe void | SetAttribute (string title, int value, NXOpen.Update.Option option) |
Creates or modifies an integer attribute with the option to update or not. More... | |
unsafe void | SetAttribute (string title, double value) |
Creates or modifies a real attribute. More... | |
unsafe void | SetAttribute (string title, double value, NXOpen.Update.Option option) |
Creates or modifies a real attribute with the option to update or not. More... | |
unsafe void | SetAttribute (string title, string value) |
Creates or modifies a string attribute. More... | |
unsafe void | SetAttribute (string title, string value, NXOpen.Update.Option option) |
Creates or modifies a string attribute with the option to update or not. More... | |
unsafe void | SetAttribute (string title) |
Creates or modifies a null attribute which is an attribute with a title and no value. More... | |
unsafe void | SetAttribute (string title, NXOpen.Update.Option option) |
Creates or modifies a null attribute with the option to update or not. More... | |
unsafe void | SetBooleanUserAttribute (string title, int index, bool value, NXOpen.Update.Option option) |
Creates or modifies a boolean attribute with the option to update or not. More... | |
unsafe void | SetName (string name) |
Sets the custom name of the object. More... | |
unsafe void | SetPdmReferenceAttribute (string attributeTitle, string attributeValue) |
Sets the value of PDM Reference attribute on the object. More... | |
unsafe void | SetReferenceAttribute (string title, string value) |
Creates or modifies a string attribute which uses a reference string. More... | |
unsafe void | SetReferenceAttribute (string title, string value, NXOpen.Update.Option option) |
Creates or modifies a string attribute which uses a reference string, with the option to update or not. More... | |
unsafe void | SetTimeAttribute (string title, string value) |
Creates or modifies a time attribute. More... | |
unsafe void | SetTimeAttribute (string title, string value, NXOpen.Update.Option option) |
Creates or modifies a time attribute with the option to update or not. More... | |
unsafe void | SetTimeUserAttribute (string title, int index, string value, NXOpen.Update.Option option) |
Creates or modifies a time attribute with the option to update or not. More... | |
unsafe void | SetTimeUserAttribute (string title, int index, NXOpen.NXObject.ComputationalTime value, NXOpen.Update.Option option) |
Creates or modifies a time attribute with the option to update or not. More... | |
unsafe void | SetUserAttribute (NXOpen.NXObject.AttributeInformation info, NXOpen.Update.Option option) |
Creates or modifies an attribute with the option to update or not. More... | |
unsafe void | SetUserAttribute (string title, int index, int value, NXOpen.Update.Option option) |
Creates or modifies an integer attribute with the option to update or not. More... | |
unsafe void | SetUserAttribute (string title, int index, double value, NXOpen.Update.Option option) |
Creates or modifies a real attribute with the option to update or not. More... | |
unsafe void | SetUserAttribute (string title, int index, string value, NXOpen.Update.Option option) |
Creates or modifies a string attribute with the option to update or not. More... | |
unsafe void | SetUserAttribute (string title, int index, NXOpen.Update.Option option) |
Creates or modifies a null attribute with the option to update or not. More... | |
unsafe void | SetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type, bool @lock) |
Lock or unlock the given attribute. More... | |
Public Member Functions inherited from NXOpen.TaggedObject | |
void | PrintTestData (String variableName) |
<exclude> More... | |
void | PrintTestData (String variableName, int lineNumber) |
<exclude> More... | |
override string | ToString () |
Returns a String that represents the current Object. More... | |
Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject | |
IMessageCtrl | AsyncProcessMessage (IMessage msg, IMessageSink replySink) |
Asynchronously processes the given message. More... | |
IMessage | SyncProcessMessage (IMessage msg) |
Synchronously processes the given message. More... | |
Properties | |
unsafe NXOpen.CAE.Xyplot.PlotGraphTemplate | PlotTemplate [get] |
Returns the plot template More... | |
unsafe int | SubGraphCountInStack [get] |
Returns the sub-graph count in a stacked plot. More... | |
Properties inherited from NXOpen.CAE.Xyplot.BaseModel | |
unsafe NXOpen.CAE.Xyplot.BaseDisplayStyleSetting | StyleSetting [get] |
Returns the style setting associated to the model More... | |
Properties inherited from NXOpen.NXObject | |
unsafe bool | IsOccurrence [get] |
Returns whether this object is an occurrence or not. More... | |
unsafe string | JournalIdentifier [get] |
Returns the identifier that would be recorded in a journal for this object. More... | |
unsafe string | Name [get] |
Returns the custom name of the object. More... | |
unsafe NXOpen.Assemblies.Component | OwningComponent [get] |
Returns the owning component, if this object is an occurrence. More... | |
unsafe NXOpen.BasePart | OwningPart [get] |
Returns the owning part of this object More... | |
unsafe NXOpen.INXObject | Prototype [get] |
Returns the prototype of this object if it is an occurrence. More... | |
Properties inherited from NXOpen.TaggedObject | |
Tag | Tag [get] |
Returns the tag of this object. More... | |
Properties inherited from NXOpen.Utilities.NXRemotableObject | |
IMessageSink | NextSink [get] |
Gets the next message sink in the sink chain. More... | |
Properties inherited from NXOpen.INXObject | |
bool | IsOccurrence [get] |
Returns whether this object is an occurrence or not. More... | |
string | JournalIdentifier [get] |
Returns the identifier that would be recorded in a journal for this object. More... | |
string | Name [get] |
Returns the custom name of the object. More... | |
NXOpen.Assemblies.Component | OwningComponent [get] |
Returns the owning component, if this object is an occurrence. More... | |
NXOpen.BasePart | OwningPart [get] |
Returns the owning part of this object More... | |
NXOpen.INXObject | Prototype [get] |
Returns the prototype of this object if it is an occurrence. More... | |
Additional Inherited Members | |
Public Types inherited from NXOpen.NXObject | |
enum | AttributeType { Invalid, Null, Boolean, Integer, Real, String, Time, Reference, Any = 100 } |
Specifies attribute type. More... | |
enum | DateAndTimeFormat { Numeric, Textual } |
Specifies the format of the date and time attribute. More... | |
Protected Member Functions inherited from NXOpen.TaggedObject | |
new void | initialize () |
<exclude> More... | |
Manages the plot template
Not support KF.
Created in NX7.5.0
|
inline |
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.
Created in NX12.0.0
License requirements: None.
|
inline |
Creates a note on the plot
Created in NX11.0.0
License requirements: None.
lines | |
textPosition |
|
inline |
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:
Created in NX12.0.0
License requirements: None.
recordIndex |
|
inline |
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.
Created in NX10.0.0
Deprecated in NX12.0.0. Use NXOpen.INXObject.FindObject
License requirements: None.
journalIdentifier | Journal identifier of the object |
|
inline |
Update axis limits for an overlaying plot if current displayed axis limits in plot do not fit for all records.
Created in NX10.0.0
Deprecated in NX1847.0.0. This functionality is no longer supported.
License requirements: None.
|
inline |
Fits the display view on a reasonable region.
Created in NX12.0.0
License requirements: None.
|
inline |
Returns application specific data associated to a record.
Created in NX12.0.0
License requirements: None.
recordIndex | The record index starts form 0 to record count -1. Get record count from Plot.GetRecordCount |
|
inline |
Gets the window device and view index of the plot graph.
Created in NX9.0.0
License requirements: None.
viewIndex | the index of view |
|
inline |
Gets all graphs on the plot.
Created in NX10.0.0
License requirements: None.
graphs | Graph objects |
|
inline |
Gets the legend table models on the plot.
Created in NX12.0.0
License requirements: None.
|
inline |
Gets the models by model type.
Created in NX12.0.0
License requirements: None.
type |
|
inline |
Gets all notes on the plot
Created in NX11.0.0
License requirements: None.
|
inline |
Gets the post environment settings in the plot.
Created in NX1847.0.0
License requirements: None.
|
inline |
Returns the count of plotted records on the plot graph.
Created in NX9.0.0
License requirements: None.
|
inline |
Gets the visibility of specified record.
Created in NX12.0.0
License requirements: None.
recordIndex | the index of specied record |
|
inline |
Gets the titles on the plot.
Created in NX11.0.0
License requirements: None.
|
inline |
Gets the bounding box of the plot view.
Created in NX11.0.0
License requirements: None.
leftBottom | |
rightTop |
|
inline |
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 .
Created in NX10.0.0
License requirements: None.
recordIndexes | The index of records to be saved |
recordNames | The output record names |
outputFileName | The destination file with full file name. The file suffix must be ".afu". |
reportError |
|
inline |
Saves plotted records on a plot graph to a CSV file.
Created in NX10.0.0
License requirements: None.
recordIndex | the indexes of records to be saved |
recordNames | |
csvFileName | the destination CSV file name |
isWriteHeader |
|
inline |
Sets the visibility of specified record.
Created in NX12.0.0
License requirements: None.
recordIndex | the index of specied record |
visibility |
|
inline |
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.
Created in NX12.0.0
License requirements: None.
inputTemplateFile | simple name or file name with full path |
|
get |
Returns the plot template
Created in NX10.0.0
License requirements: None.
|
get |
Returns the sub-graph count in a stacked plot.
Created in NX10.0.0
License requirements: None.