public interface Plot extends BaseModel
Modifier and Type | Interface and Description |
---|---|
static class |
Plot.DeviceAndViewIndexData
This class holds the data returned from
getDeviceAndViewIndex() |
static class |
Plot.ViewBoundingBoxData
This class holds the data returned from
getViewBoundingBox() |
NXObject.AttributeInformation, NXObject.AttributeType, NXObject.ComputationalTime, NXObject.DateAndTimeFormat, NXObject.NextUserAttributeData
Modifier and Type | Method and Description |
---|---|
void |
commitRecordsChange()
Accepts record changed and process data to update data model
This method is only to update data model, it needs call
IDisplayableModel.updateDisplay() to update display to reflect data change. |
NoteModel |
createNote(String[] lines,
Point2d textPosition)
Creates a note on the plot
License requirements: None. |
void |
deleteRecord(int recordIndex)
Deletes the nth record.
|
TaggedObject |
find(String journalIdentifier)
Deprecated.
Deprecated in NX12.0.0. Use
INXObject.findObject(java.lang.String)
|
void |
fitAxisLimit()
Update axis limits for an overlaying plot if current displayed axis limits in plot do not fit for all records.
|
void |
fitView()
Fits the display view on a reasonable region.
|
IApplicationData |
getApplicationDataOfRecord(int recordIndex)
Returns application specific data associated to a record.
|
Plot.DeviceAndViewIndexData |
getDeviceAndViewIndex()
Gets the window device and view index of the plot graph.
|
Graph[] |
getGraphs()
Gets all graphs on the plot.
|
LegendTable[] |
getLegendTables()
Gets the legend table models on the plot.
|
BasicModel[] |
getModels(ModelType type)
Gets the models by model type.
|
NoteModel[] |
getNotes()
Gets all notes on the plot
License requirements: None. |
int |
getRecordCount()
Returns the count of plotted records on the plot graph.
|
boolean |
getRecordDisplayVisibility(int recordIndex)
Gets the visibility of specified record.
|
BasicModel[] |
getTitles()
Gets the titles on the plot.
|
Plot.ViewBoundingBoxData |
getViewBoundingBox()
Gets the bounding box of the plot view.
|
PlotGraphTemplate |
plotTemplate()
Returns the plot template
License requirements: None. |
void |
saveRecords(int[] recordIndexes,
String[] recordNames,
String outputFileName,
boolean reportError)
Saves plotted records on a graph to an afu file.
|
void |
saveRecordsToCsv(int[] recordIndex,
String[] recordNames,
String csvFileName,
boolean isWriteHeader)
Saves plotted records on a plot graph to a CSV file.
|
void |
setRecordDisplayVisibility(int recordIndex,
boolean visibility)
Sets the visibility of specified record.
|
int |
subGraphCountInStack()
Returns the sub-graph count in a stacked plot.
|
String |
writeToTemplateFile(String inputTemplateFile)
Writes the template setting of plot to template file.
|
createAttributeIterator, deleteAllAttributesByType, deleteAllAttributesByType, deleteAttributeByTypeAndTitle, deleteAttributeByTypeAndTitle, deleteUserAttribute, deleteUserAttributes, deleteUserAttributes, getAttributeTitlesByType, getBooleanUserAttribute, getComputationalTimeUserAttribute, getIntegerAttribute, getIntegerUserAttribute, getNextUserAttribute, getPdmReferenceAttributeValue, getRealAttribute, getRealUserAttribute, getReferenceAttribute, getStringAttribute, getStringUserAttribute, getTimeAttribute, getTimeUserAttribute, getUserAttribute, getUserAttribute, getUserAttributeAsString, getUserAttributeCount, getUserAttributeCount, getUserAttributeCount, getUserAttributeCount, getUserAttributeLock, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributesAsStrings, getUserAttributeSize, getUserAttributeSourceObjects, hasUserAttribute, hasUserAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setBooleanUserAttribute, setPdmReferenceAttribute, setReferenceAttribute, setReferenceAttribute, setTimeAttribute, setTimeAttribute, setTimeUserAttribute, setTimeUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttributeLock
printTestData, printTestData, tag, tagValue
findObject, isOccurrence, journalIdentifier, name, owningComponent, owningPart, print, prototype, setName
updateDisplay
int getRecordCount() throws NXException, RemoteException
NXException
RemoteException
IApplicationData getApplicationDataOfRecord(int recordIndex) throws NXException, RemoteException
recordIndex
- The record index starts form 0 to record count -1. Get record count from getRecordCount()
NXException
RemoteException
void saveRecords(int[] recordIndexes, String[] recordNames, String outputFileName, boolean reportError) throws NXException, RemoteException
getRecordCount()
.
recordIndexes
- The index of records to be savedrecordNames
- The output record namesoutputFileName
- The destination file with full file name.
The file suffix must be ".afu".reportError
- NXException
RemoteException
Plot.DeviceAndViewIndexData getDeviceAndViewIndex() throws NXException, RemoteException
NXException
RemoteException
Graph[] getGraphs() throws NXException, RemoteException
NXException
RemoteException
int subGraphCountInStack() throws NXException, RemoteException
NXException
RemoteException
PlotGraphTemplate plotTemplate() throws NXException, RemoteException
NXException
RemoteException
void fitAxisLimit() throws NXException, RemoteException
NXException
RemoteException
void saveRecordsToCsv(int[] recordIndex, String[] recordNames, String csvFileName, boolean isWriteHeader) throws NXException, RemoteException
recordIndex
- the indexes of records to be savedrecordNames
- csvFileName
- the destination CSV file nameisWriteHeader
- NXException
RemoteException
NoteModel createNote(String[] lines, Point2d textPosition) throws NXException, RemoteException
lines
- textPosition
- NXException
RemoteException
NoteModel[] getNotes() throws NXException, RemoteException
NXException
RemoteException
BasicModel[] getTitles() throws NXException, RemoteException
NXException
RemoteException
Plot.ViewBoundingBoxData getViewBoundingBox() throws NXException, RemoteException
NXException
RemoteException
String writeToTemplateFile(String inputTemplateFile) throws NXException, RemoteException
inputTemplateFile
- simple name or file name with full pathNXException
RemoteException
boolean getRecordDisplayVisibility(int recordIndex) throws NXException, RemoteException
recordIndex
- the index of specied recordNXException
RemoteException
void setRecordDisplayVisibility(int recordIndex, boolean visibility) throws NXException, RemoteException
recordIndex
- the index of specied recordvisibility
- NXException
RemoteException
BasicModel[] getModels(ModelType type) throws NXException, RemoteException
type
- NXException
RemoteException
void fitView() throws NXException, RemoteException
NXException
RemoteException
void deleteRecord(int recordIndex) throws NXException, RemoteException
getRecordCount()
commitRecordsChange()
to precess record data change and update data modelIDisplayableModel.updateDisplay()
to regenerate display to reflect data changefitView()
to make display fit the view;it is only required when the plot display boundary is changedrecordIndex
- NXException
RemoteException
void commitRecordsChange() throws NXException, RemoteException
IDisplayableModel.updateDisplay()
to update display to reflect data change.
NXException
RemoteException
LegendTable[] getLegendTables() throws NXException, RemoteException
NXException
RemoteException
TaggedObject find(String journalIdentifier) throws NXException, RemoteException
INXObject.findObject(java.lang.String)
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.
journalIdentifier
- Journal identifier of the object
NXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.