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	Returns the NXOpen.VisualReporting.VisualReportCollection belonging to this visual report manager
VisualReportExplorer	Returns the NXOpen.VisualReporting.VisualReportExplorer belonging to this visual report manager

Methods

Method	Description
ActivateCurrentVisualReport	Activates the NXOpen.VisualReporting.VisualReportManager.Current() visual report.
CreateSpecifyDateBuilder	Creates a NXOpen.VisualReporting.SpecifyDateBuilder.
CreateVisualReportBuilder	Creates a NXOpen.VisualReporting.VisualReportBuilder and starts editing a copy of the given NXOpen.VisualReporting.VisualReport.
DeactivateCurrentVisualReport	Deactivates the NXOpen.VisualReporting.VisualReportManager.Current() visual report.
MergeReports	Merges multiple existing NXOpen.VisualReporting.VisualReport into one NXOpen.VisualReporting.VisualReport, but does not set them to be the NXOpen.VisualReporting.VisualReportManager.Current() visual report or activate them, and does not save the merged NXOpen.VisualReporting.VisualReport.
Open	Opens an existing NXOpen.VisualReporting.VisualReport, but does not set it to be the NXOpen.VisualReporting.VisualReportManager.Current() visual report or activate it.
OpenReports	Opens existing NXOpen.VisualReporting.VisualReport, but does not set them to be the NXOpen.VisualReporting.VisualReportManager.Current() visual report or activate them.
RegisterProperty	Registers a string type property.
Unload	Unloads an opened NXOpen.VisualReporting.VisualReport.
UnregisterProperty	Unregisters a property.

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

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 manager

Signature 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 manager

Signature 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 given NXOpen.VisualReporting.VisualReport.

Signature CreateVisualReportBuilder(visualReport)

Parameters:visualReport (NXOpen.VisualReporting.VisualReport) – The VisualReport for which this builder is being created. Can be None Returns: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 one NXOpen.VisualReporting.VisualReport, but does not set them to be the NXOpen.VisualReporting.VisualReportManager.Current() visual report or activate them, and does not save the merged NXOpen.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:

NXOpen.VisualReporting.VisualReport

New in version NX8.0.0.

License requirements: nx_visual_reporting (“Visual Reporting”)

Open

VisualReportManager.Open

Opens an existing NXOpen.VisualReporting.VisualReport, but does not set it to be the NXOpen.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 names

Signature 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 the NXOpen.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:

list of NXOpen.VisualReporting.VisualReport

New in version NX7.5.0.

License requirements: nx_visual_reporting (“Visual Reporting”)

RegisterProperty

VisualReportManager.RegisterProperty

Overloaded method RegisterProperty

• RegisterProperty(propertyKey, propertyName, scopeType, objectTypes, dataType, isValidInNative, isValidInTeamcenter, getStringTypePropertyValue)
• RegisterProperty(propertyKey, propertyName, scopeType, objectTypes, dataType, isValidInNative, isValidInTeamcenter, getIntegerTypePropertyValue)
• RegisterProperty(propertyKey, propertyName, scopeType, objectTypes, dataType, isValidInNative, isValidInTeamcenter, getRealTypePropertyValue)
• RegisterProperty(propertyKey, propertyName, scopeType, objectTypes, dataType, isValidInNative, isValidInTeamcenter, getBooleanTypePropertyValue)
• RegisterProperty(propertyKey, propertyName, scopeType, objectTypes, dataType, isValidInNative, isValidInTeamcenter, getDateTypePropertyValue)

-------------------------------------

Registers a string type property.

The property key and property name should be unique in current session. Parameters ‘isValidInNative’ and ‘isValidInTeamcenter’ shouldn’t be ‘false’ at the same time.

Signature RegisterProperty(propertyKey, propertyName, scopeType, objectTypes, dataType, isValidInNative, isValidInTeamcenter, getStringTypePropertyValue)

Parameters:

• propertyKey (str) – property key
• propertyName (str) – property name
• scopeType (NXOpen.VisualReporting.VisualReportScopeTypeOption) – property scope type
• objectTypes (list of NXOpen.VisualReporting.VisualReportObjectTypeOption) – object types
• dataType (NXOpen.VisualReporting.PropertyDatatypeOption) – property data type
• isValidInNative (bool) – is property valid in native mode
• isValidInTeamcenter (bool) – is property valid in Teamcenter mode
• getStringTypePropertyValue (CallableObject) – callback function that returns a string type property value

New in version NX12.0.0.

License requirements: nx_visual_reporting (“Visual Reporting”)

-------------------------------------

Registers an integer type property.

The property key and property name should be unique in current session. Parameters ‘isValidInNative’ and ‘isValidInTeamcenter’ shouldn’t be ‘false’ at the same time.

Signature RegisterProperty(propertyKey, propertyName, scopeType, objectTypes, dataType, isValidInNative, isValidInTeamcenter, getIntegerTypePropertyValue)

Parameters:

• propertyKey (str) – property key
• propertyName (str) – property name
• scopeType (NXOpen.VisualReporting.VisualReportScopeTypeOption) – property scope type
• objectTypes (list of NXOpen.VisualReporting.VisualReportObjectTypeOption) – object types
• dataType (NXOpen.VisualReporting.PropertyDatatypeOption) – property data type
• isValidInNative (bool) – is property valid in native mode
• isValidInTeamcenter (bool) – is property valid in Teamcenter mode
• getIntegerTypePropertyValue (CallableObject) – callback function that returns a integer type property value

New in version NX12.0.0.

License requirements: nx_visual_reporting (“Visual Reporting”)

-------------------------------------

Registers a double type property.

The property key and property name should be unique in current session. Parameters ‘isValidInNative’ and ‘isValidInTeamcenter’ shouldn’t be ‘false’ at the same time.

Signature RegisterProperty(propertyKey, propertyName, scopeType, objectTypes, dataType, isValidInNative, isValidInTeamcenter, getRealTypePropertyValue)

Parameters:

• propertyKey (str) – property key
• propertyName (str) – property name
• scopeType (NXOpen.VisualReporting.VisualReportScopeTypeOption) – property scope type
• objectTypes (list of NXOpen.VisualReporting.VisualReportObjectTypeOption) – object types
• dataType (NXOpen.VisualReporting.PropertyDatatypeOption) – property data type
• isValidInNative (bool) – is property valid in native mode
• isValidInTeamcenter (bool) – is property valid in Teamcenter mode
• getRealTypePropertyValue (CallableObject) – callback function that returns a double type property value

New in version NX12.0.0.

License requirements: nx_visual_reporting (“Visual Reporting”)

-------------------------------------

Registers a boolean type property.

The property key and property name should be unique in current session. Parameters ‘isValidInNative’ and ‘isValidInTeamcenter’ shouldn’t be ‘false’ at the same time.

Signature RegisterProperty(propertyKey, propertyName, scopeType, objectTypes, dataType, isValidInNative, isValidInTeamcenter, getBooleanTypePropertyValue)

Parameters:

• propertyKey (str) – property key
• propertyName (str) – property name
• scopeType (NXOpen.VisualReporting.VisualReportScopeTypeOption) – property scope type
• objectTypes (list of NXOpen.VisualReporting.VisualReportObjectTypeOption) – object types
• dataType (NXOpen.VisualReporting.PropertyDatatypeOption) – property data type
• isValidInNative (bool) – is property valid in native mode
• isValidInTeamcenter (bool) – is property valid in Teamcenter mode
• getBooleanTypePropertyValue (CallableObject) – callback function that returns a bool property value

New in version NX12.0.0.

License requirements: nx_visual_reporting (“Visual Reporting”)

-------------------------------------

Registers a NXOpen.NXObjectComputationalTime type property.

The property key and property name should be unique in current session. Parameters ‘isValidInNative’ and ‘isValidInTeamcenter’ shouldn’t be ‘false’ at the same time.

Signature RegisterProperty(propertyKey, propertyName, scopeType, objectTypes, dataType, isValidInNative, isValidInTeamcenter, getDateTypePropertyValue)

Parameters:

• propertyKey (str) – property key
• propertyName (str) – property name
• scopeType (NXOpen.VisualReporting.VisualReportScopeTypeOption) – property scope type
• objectTypes (list of NXOpen.VisualReporting.VisualReportObjectTypeOption) – object types
• dataType (NXOpen.VisualReporting.PropertyDatatypeOption) – property data type
• isValidInNative (bool) – is property valid in native mode
• isValidInTeamcenter (bool) – is property valid in Teamcenter mode
• getDateTypePropertyValue (CallableObject) – callback function that returns a NXOpen.NXObjectComputationalTime type property value

New in version NX12.0.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”)

UnregisterProperty

VisualReportManager.UnregisterProperty

Unregisters a property.

When the library which the property resides in is unloaded from NX session, this method should be called to unregister the property.

Signature UnregisterProperty(propertyKey)

Parameters:propertyKey (str) – property key

New in version NX12.0.0.

License requirements: nx_visual_reporting (“Visual Reporting”)