NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | List of all members
NXOpen.CAE.Xyplot.BarChartPlot Class Reference

Manages the display of bar chart plot. More...

Inheritance diagram for NXOpen.CAE.Xyplot.BarChartPlot:
NXOpen.CAE.Xyplot.Plot NXOpen.CAE.Xyplot.I2DDataPlot NXOpen.CAE.Xyplot.BaseModel NXOpen.NXObject NXOpen.CAE.Xyplot.IDisplayableModel NXOpen.TaggedObject NXOpen.INXObject NXOpen.Utilities.NXRemotableObject IMessageSink

Public Member Functions

unsafe void EditRecord (int nthRecordIdx, NXOpen.CAE.FTK.BaseRecord record)
 Edits nth record of plot. More...
 
- Public Member Functions inherited from NXOpen.CAE.Xyplot.Plot
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
NXOpen.CAE.Xyplot.LegendTable[] 
GetCalculationLegendTables ()
 Gets calculation legend table models on the plot. 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...
 

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...
 
- Properties inherited from NXOpen.CAE.Xyplot.Plot
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...
 

Detailed Description

Manages the display of bar chart plot.

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

Not support KF.

Created in NX12.0.0

Member Function Documentation

unsafe void NXOpen.CAE.Xyplot.BarChartPlot.EditRecord ( int  nthRecordIdx,
NXOpen.CAE.FTK.BaseRecord  record 
)
inline

Edits nth record of plot.

Procedure of editing records of plot fully:

  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

Created in NX12.0.0

License requirements: None.

Parameters
nthRecordIdx
record

Implements NXOpen.CAE.Xyplot.I2DDataPlot.


The documentation for this class was generated from the following file:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.