VisualReportManager Class¶
-
class
NXOpen.VisualReporting.
VisualReportManager
¶ Bases:
object
A manager for load, creation and activation of visual reports.
To obtain an instance of this class, refer to
NXOpen.Session
New in version NX7.0.0.
Properties¶
Property | Description |
---|---|
Current | Returns or sets the current NXOpen.VisualReporting.VisualReport . |
VisualReports |
|
VisualReportExplorer |
|
Methods¶
Property Detail¶
Current¶
-
VisualReportManager.
Current
¶ Returns or sets the current
NXOpen.VisualReporting.VisualReport
.-------------------------------------
Getter Method
Signature
Current()
Returns: Return type: NXOpen.VisualReporting.VisualReport
New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Current(visualReport)
Parameters: visualReport ( NXOpen.VisualReporting.VisualReport
) –New in version NX7.0.0.
License requirements: None.
VisualReports¶
-
VisualReportManager.
VisualReports
¶ Returns the
NXOpen.VisualReporting.VisualReportCollection
belonging to this visual report managerSignature
VisualReports()
New in version NX7.0.0.
Returns: Return type: NXOpen.VisualReporting.VisualReportCollection
VisualReportExplorer¶
-
VisualReportManager.
VisualReportExplorer
¶ Returns the
NXOpen.VisualReporting.VisualReportExplorer
belonging to this visual report managerSignature
VisualReportExplorer()
New in version NX7.5.0.
Returns: Return type: NXOpen.VisualReporting.VisualReportExplorer
Method Detail¶
ActivateCurrentVisualReport¶
-
VisualReportManager.
ActivateCurrentVisualReport
¶ Activates the
NXOpen.VisualReporting.VisualReportManager.Current()
visual report.Signature
ActivateCurrentVisualReport()
New in version NX7.0.0.
License requirements: None.
CreateSpecifyDateBuilder¶
-
VisualReportManager.
CreateSpecifyDateBuilder
¶ Creates a
NXOpen.VisualReporting.SpecifyDateBuilder
.Signature
CreateSpecifyDateBuilder()
Returns: The created builder Return type: NXOpen.VisualReporting.SpecifyDateBuilder
New in version NX8.0.0.
License requirements: None.
CreateVisualReportBuilder¶
-
VisualReportManager.
CreateVisualReportBuilder
¶ Creates a
NXOpen.VisualReporting.VisualReportBuilder
and starts editing a copy of the givenNXOpen.VisualReporting.VisualReport
.Signature
CreateVisualReportBuilder(visualReport)
Parameters: visualReport ( NXOpen.VisualReporting.VisualReport
) – The VisualReport for which this builder is being created. Can be NoneReturns: The created builder Return type: NXOpen.VisualReporting.VisualReportBuilder
New in version NX7.0.0.
License requirements: nx_visual_reporting (“Visual Reporting”)
DeactivateCurrentVisualReport¶
-
VisualReportManager.
DeactivateCurrentVisualReport
¶ Deactivates the
NXOpen.VisualReporting.VisualReportManager.Current()
visual report.Signature
DeactivateCurrentVisualReport()
New in version NX7.0.0.
License requirements: None.
MergeReports¶
-
VisualReportManager.
MergeReports
¶ Merges multiple existing
NXOpen.VisualReporting.VisualReport
into oneNXOpen.VisualReporting.VisualReport
, but does not set them to be theNXOpen.VisualReporting.VisualReportManager.Current()
visual report or activate them, and does not save the mergedNXOpen.VisualReporting.VisualReport
.Signature
MergeReports(visualReports, mergedReportName, mergedReportDescription)
Parameters: - visualReports (list of
NXOpen.VisualReporting.VisualReport
) – array of existing reports - mergedReportName (str) – name of the merged report
- mergedReportDescription (str) – description of the merged report
Returns: merged report
Return type: New in version NX8.0.0.
License requirements: nx_visual_reporting (“Visual Reporting”)
- visualReports (list of
Open¶
-
VisualReportManager.
Open
¶ Opens an existing
NXOpen.VisualReporting.VisualReport
, but does not set it to be theNXOpen.VisualReporting.VisualReportManager.Current()
visual report or activate it.If the visual report file cannot be opened, or if there is a problem parsing the file, then an exception will be raised.
If opening a managed report then it is recommended to use
NXOpen.VisualReporting.VisualReportManager.OpenReports()
which can take a container path and list of dataset namesSignature
Open(filename)
Parameters: filename (str) – The filename of the visual report to open Returns: Return type: NXOpen.VisualReporting.VisualReport
New in version NX7.0.0.
License requirements: nx_visual_reporting (“Visual Reporting”)
OpenReports¶
-
VisualReportManager.
OpenReports
¶ Opens existing
NXOpen.VisualReporting.VisualReport
, but does not set them to be theNXOpen.VisualReporting.VisualReportManager.Current()
visual report or activate them.If the visual report file cannot be opened, or if there is a problem parsing the file, then an exception will be raised.
This can be used in native mode by sending in a folder path and filenames, or in managed mode using a container path and dataset names.
Signature
OpenReports(folders, names)
Parameters: - folders (list of str) – array of folders to be searched
- names (list of str) – array of report names
Returns: array of opened reports
Return type: New in version NX7.5.0.
License requirements: nx_visual_reporting (“Visual Reporting”)
Unload¶
-
VisualReportManager.
Unload
¶ Unloads an opened
NXOpen.VisualReporting.VisualReport
.Signature
Unload(visualReport)
Parameters: visualReport ( NXOpen.VisualReporting.VisualReport
) –New in version NX8.0.0.
License requirements: nx_visual_reporting (“Visual Reporting”)