VisualReportExplorer Class¶
-
class
NXOpen.VisualReporting.
VisualReportExplorer
¶ Bases:
object
The Explorer of the results of a visual report.
The Visual Report Explorer enables a report to focus on specified objects or on a particular group in the visual report.
To obtain an instance of this class, refer to
NXOpen.VisualReporting.VisualReportManager
New in version NX7.5.0.
Properties¶
Property | Description |
---|---|
ExploreReport | Returns or sets the Explore Report setting |
Methods¶
Method | Description |
---|---|
ClearReportObjects | Remove all objects from the visual report. |
GetExploringGroup | Gets the exploring NXOpen.VisualReporting.GroupLabel @return The exploring group |
RemoveReportObjects | Remove objects from report. |
ReportDown | Report down the assembly, starting from the NXOpen.Assemblies.ComponentAssembly.RootComponent . |
ReportOnChildren | Report on the children of nxObjects. |
ReportOnObjects | Set objects to report upon. |
ReportOnParents | Report on the parents of the nxObjects. |
ResetReportObjects | Resets the objects to report upon. |
SetGroupToExplore | Sets the NXOpen.VisualReporting.GroupLabel to explore. |
Enumerations¶
VisualReportExplorerExploreReportOption Enumeration | Represents whether Explore Report mode is on or off. |
VisualReportExplorerReportDownStatus Enumeration | Status reported by NXOpen.VisualReporting.VisualReportExplorer.ReportDown . |
VisualReportExplorerReportOnObjectsOption Enumeration | When the set of objects to report upon is changed, should the contents of the set be replaced or extended. |
Property Detail¶
ExploreReport¶
-
VisualReportExplorer.
ExploreReport
¶ Returns or sets the Explore Report setting
-------------------------------------
Getter Method
Signature
ExploreReport()
Returns: Return type: NXOpen.VisualReporting.VisualReportExplorerExploreReportOption
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ExploreReport(exploreReportOption)
Parameters: exploreReportOption ( NXOpen.VisualReporting.VisualReportExplorerExploreReportOption
) –New in version NX7.5.0.
License requirements: None.
Method Detail¶
ClearReportObjects¶
-
VisualReportExplorer.
ClearReportObjects
¶ Remove all objects from the visual report.
Signature
ClearReportObjects()
New in version NX7.5.0.
License requirements: None.
GetExploringGroup¶
-
VisualReportExplorer.
GetExploringGroup
¶ Gets the exploring
NXOpen.VisualReporting.GroupLabel
Signature
GetExploringGroup()
Returns: The exploring group Return type: NXOpen.VisualReporting.GroupLabel
New in version NX8.0.0.
License requirements: None.
RemoveReportObjects¶
-
VisualReportExplorer.
RemoveReportObjects
¶ Remove objects from report.
Signature
RemoveReportObjects(nxObjects)
Parameters: nxObjects (list of NXOpen.NXObject
) – Objects to remove from reportNew in version NX7.5.0.
License requirements: None.
ReportDown¶
-
VisualReportExplorer.
ReportDown
¶ Overloaded method ReportDown
ReportDown(reportOnObjectsOption)
ReportDown(nxObjects, reportOnObjectsOption)
-------------------------------------
Report down the assembly, starting from the
NXOpen.Assemblies.ComponentAssembly.RootComponent
. A group to explore should have been specified for this method to have any effect. The first time this method is called the operation will start fromNXOpen.Assemblies.ComponentAssembly.RootComponent
. On subsequent calls, the set of objects currently reported upon will be used as the starting point.Signature
ReportDown(reportOnObjectsOption)
Parameters: reportOnObjectsOption ( NXOpen.VisualReporting.VisualReportExplorerReportOnObjectsOption
) – Add to or replace objects in reportReturns: Status from the report down operation Return type: NXOpen.VisualReporting.VisualReportExplorerReportDownStatus
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Report down from a starting array of objects. A group to explore should have been specified for this method to have any effect. On subsequent calls to
NXOpen.VisualReporting.VisualReportExplorer.ReportDown
, with no nxObjects array, the set of objects currently reported upon will be used as the starting point.Signature
ReportDown(nxObjects, reportOnObjectsOption)
Parameters: - nxObjects (list of
NXOpen.NXObject
) – Objects from which to start report down operation - reportOnObjectsOption (
NXOpen.VisualReporting.VisualReportExplorerReportOnObjectsOption
) – Add to or replace objects in report
Returns: Status from the report down operation
Return type: New in version NX7.5.0.
License requirements: None.
-------------------------------------
ReportOnChildren¶
-
VisualReportExplorer.
ReportOnChildren
¶ Report on the children of nxObjects.
The children will either replace the existing contents of the report or be added to the report. This operation is intended for
NXOpen.Assemblies.Component`s and will report on direct children of the components. If an object is not an instance of :py:class:`NXOpen.Assemblies.Component
or if it has no children then nothing will be changed.Signature
ReportOnChildren(nxObjects, reportOnObjectsOption)
Parameters: - nxObjects (list of
NXOpen.NXObject
) – Objects whose children will be reported upon - reportOnObjectsOption (
NXOpen.VisualReporting.VisualReportExplorerReportOnObjectsOption
) – Add to or replace objects in report
New in version NX7.5.0.
License requirements: None.
- nxObjects (list of
ReportOnObjects¶
-
VisualReportExplorer.
ReportOnObjects
¶ Set objects to report upon.
Signature
ReportOnObjects(nxObjects, reportOnObjectsOption)
Parameters: - nxObjects (list of
NXOpen.NXObject
) – Objects to report upon - reportOnObjectsOption (
NXOpen.VisualReporting.VisualReportExplorerReportOnObjectsOption
) – Add to or replace objects in report
New in version NX7.5.0.
License requirements: None.
- nxObjects (list of
ReportOnParents¶
-
VisualReportExplorer.
ReportOnParents
¶ Report on the parents of the nxObjects.
The parents will either replace the existing contents of the report or be added to the report. This operation is intended for
NXOpen.Assemblies.Component`s and will report on the parent of the component. If the object is not an instance of :py:class:`NXOpen.Assemblies.Component
or if it has no parent then nothing will be changed.Signature
ReportOnParents(nxObjects, reportOnObjectsOption)
Parameters: - nxObjects (list of
NXOpen.NXObject
) – Objects whose parents will be reported upon - reportOnObjectsOption (
NXOpen.VisualReporting.VisualReportExplorerReportOnObjectsOption
) – Add to or replace objects in report
New in version NX7.5.0.
License requirements: None.
- nxObjects (list of
ResetReportObjects¶
-
VisualReportExplorer.
ResetReportObjects
¶ Resets the objects to report upon.
If there is no group to explore set, then all leaf nodes of the assembly will be included in the report. If a group to explore is set, then elements of that group will be reported upon. Where there are two elements of the group on the same branch of the assembly, the lowest will be reported upon.
Signature
ResetReportObjects()
New in version NX7.5.0.
License requirements: None.
SetGroupToExplore¶
-
VisualReportExplorer.
SetGroupToExplore
¶ Sets the
NXOpen.VisualReporting.GroupLabel
to explore.The
NXOpen.VisualReporting.GroupLabel
to explore can be set to None. If there is no active visual report, then nothing will happen. Note that theNXOpen.VisualReporting.GroupLabel
should belong to the active visual report otherwise the call will fail. This method will also cause the objects reported upon to be reset in the same way as a call toResetReportObjects
.Signature
SetGroupToExplore(groupLabel)
Parameters: groupLabel ( NXOpen.VisualReporting.GroupLabel
) – The group to exploreNew in version NX7.5.0.
License requirements: None.