VisualReportBuilder Class

class NXOpen.VisualReporting.VisualReportBuilder

Bases: NXOpen.Builder

A Builder for creating and editing :py:class:`NXOpen.VisualReporting.VisualReport`s.

To create a new instance of this class, use NXOpen.VisualReporting.VisualReportManager.CreateVisualReportBuilder()

New in version NX7.0.0.

Properties

Property Description
BitmapNameOfReport Returns or sets the bitmap name of the NXOpen.VisualReporting.VisualReport.
BitmapNameOfReportingProperty Returns or sets the bitmap name of the reporting NXOpen.VisualReporting.Property in the active NXOpen.VisualReporting.Classifier.
CustomMessageOfReport Returns or sets the custom message of the NXOpen.VisualReporting.VisualReport.
CustomMessageOfReportingProperty Returns or sets the custom message of the reporting NXOpen.VisualReporting.Property in the active NXOpen.VisualReporting.Classifier.
DescriptionOfVisualReport Returns or sets the description of the NXOpen.VisualReporting.VisualReport being built by this builder.
DescriptiveCategoryOfVisualReport Returns or sets the descriptive category of the NXOpen.VisualReporting.VisualReport being built by this builder.
DestinationTeamcenterFolder Returns or sets the destination Teamcenter folder for saving the NXOpen.VisualReporting.VisualReport being built by this builder to Teamcenter database.
FilenameOfVisualReport Returns or sets the file name of the NXOpen.VisualReporting.VisualReport being built by this builder.
KeywordsOfVisualReport Returns or sets the keywords of the NXOpen.VisualReporting.VisualReport being built by this builder.
ReportContextOfVisualReport Returns or sets the NXOpen.VisualReporting.VisualReportReportContextOption of the NXOpen.VisualReporting.VisualReport being built by this builder.
ReportNameOfVisualReport Returns or sets the name of the NXOpen.VisualReporting.VisualReport being built by this builder.
ReportingObjectTypeOfVisualReport Returns or sets the reporting object type of the NXOpen.VisualReporting.VisualReport being built by this builder.
ReportingStyleOfVisualReport Returns or sets the reporting style of the NXOpen.VisualReporting.VisualReport being built by this builder.
SaveDestination Returns or sets the NXOpen.VisualReporting.VisualReportSaveDestinationOption of the NXOpen.VisualReporting.VisualReport being built by this builder.
ScopeTypeOfVisualReport Returns or sets the NXOpen.VisualReporting.VisualReportScopeTypeOption of the NXOpen.VisualReporting.VisualReport being built by this builder.
Tag Returns the Tag for this object.

Methods

Method Description
AddChildToCondition Add a new child NXOpen.VisualReporting.Condition to this condition.
Commit Commits any edits that have been applied to the builder.
CommitAsCopy When Builder.Commit() is called on this builder, it will delete the original NXOpen.VisualReporting.VisualReport whose copy the builder is editing and install the copied NXOpen.VisualReporting.VisualReport to the NXOpen.VisualReporting.VisualReportManager.
CreateAndCondition Creates a new empty NXOpen.VisualReporting.Condition, but does not add it to a NXOpen.VisualReporting.Rule.
CreateBooleanCondition Creates a new empty NXOpen.VisualReporting.Condition whose NXOpen.VisualReporting.Condition.Datatype() is NXOpen.VisualReporting.PropertyDatatypeOption.Boolean, but does not add it to a NXOpen.VisualReporting.Rule.
CreateDateCondition Creates a new empty NXOpen.VisualReporting.Condition whose NXOpen.VisualReporting.Condition.Datatype() is NXOpen.VisualReporting.PropertyDatatypeOption.Date, but does not add it to a NXOpen.VisualReporting.Rule.
CreateGroupLabel Creates a new empty NXOpen.VisualReporting.GroupLabel, and adds it to the given NXOpen.VisualReporting.Rule.
CreateIntegerCondition Creates a new empty NXOpen.VisualReporting.Condition whose NXOpen.VisualReporting.Condition.Datatype() is NXOpen.VisualReporting.PropertyDatatypeOption.Integer, but does not add it to a NXOpen.VisualReporting.Rule.
CreateNotCondition Creates a new empty NXOpen.VisualReporting.Condition, but does not add it to a NXOpen.VisualReporting.Rule.
CreateNullCondition Creates a new empty NXOpen.VisualReporting.Condition whose NXOpen.VisualReporting.Condition.Datatype() is NXOpen.VisualReporting.PropertyDatatypeOption.Null, but does not add it to a NXOpen.VisualReporting.Rule.
CreateOrCondition Creates a new empty NXOpen.VisualReporting.Condition, but does not add it to a NXOpen.VisualReporting.Rule.
CreateProperty Creates a new empty NXOpen.VisualReporting.Property, but does not add it to a NXOpen.VisualReporting.VisualReport.
CreateRealCondition Creates a new empty NXOpen.VisualReporting.Condition whose NXOpen.VisualReporting.Condition.Datatype() is NXOpen.VisualReporting.PropertyDatatypeOption.Real, but does not add it to a NXOpen.VisualReporting.Rule.
CreateStringCondition Creates a new empty NXOpen.VisualReporting.Condition whose NXOpen.VisualReporting.Condition.Datatype() is NXOpen.VisualReporting.PropertyDatatypeOption.String, but does not add it to a NXOpen.VisualReporting.Rule.
CreateVisualReport Creates a new empty NXOpen.VisualReporting.VisualReport and starts editing it.
DeleteChildCondition Deletes a NXOpen.VisualReporting.Condition from its parent condition.
DeleteGroupLabel Deletes the given NXOpen.VisualReporting.GroupLabel from the active NXOpen.VisualReporting.Classifier in this NXOpen.VisualReporting.Rule.
DeleteProperty Delete NXOpen.VisualReporting.Property which has no owner.
Destroy Deletes the builder, and cleans up any objects created by the builder.
EditVisualReport Starts editing a NXOpen.VisualReporting.VisualReport.
EnableUnmatchedGroupOfVisualReport Sets whether use of NXOpen.VisualReporting.VisualReport.UnmatchedGroupLabel() is enabled for the NXOpen.VisualReporting.VisualReport being built by this builder.
GetActiveClassifierOfRule Gets the active NXOpen.VisualReporting.Classifier in this NXOpen.VisualReporting.Rule for a multiple properties report.
GetAllGroupLabelsOfRule Returns the NXOpen.VisualReporting.GroupLabel`s associated with the active :py:class:`NXOpen.VisualReporting.Classifier in this NXOpen.VisualReporting.Rule.
GetBitmapNameOfGroupLabel Gets the bitmap of the given NXOpen.VisualReporting.GroupLabel.
GetChildCondition Returns the specified child NXOpen.VisualReporting.Condition from this NXOpen.VisualReporting.Condition
GetChildConditions Returns all the child NXOpen.VisualReporting.Condition`s in this :py:class:`NXOpen.VisualReporting.Condition
GetClassifierTypeOfRule Gets the reporting NXOpen.VisualReporting.ClassifierTypeOption for the active NXOpen.VisualReporting.Classifier in this NXOpen.VisualReporting.Rule.
GetClassifiersOfRule Returns the NXOpen.VisualReporting.Classifier`s associated with this :py:class:`NXOpen.VisualReporting.Rule.
GetColorOfGroupLabel Gets the NXOpen.VisualReporting.GroupLabel.Color() of the given NXOpen.VisualReporting.GroupLabel.
GetCommittedObjects For builders that create more than one object, this method returns the objects that are created by commit.
GetCustomMessageOfGroupLabel Gets the custom message of the given:py:class:NXOpen.VisualReporting.GroupLabel.
GetDateGroupMethodOfRule Gets the NXOpen.VisualReporting.ClassifierDateGroupMethodOption of the active NXOpen.VisualReporting.Classifier in the given NXOpen.VisualReporting.Rule.
GetDescriptionOfCondition Gets the NXOpen.VisualReporting.Condition.Description() of the specified NXOpen.VisualReporting.Condition.
GetDisplayStyleForGroupLabel Gets the NXOpen.VisualReporting.GroupLabelDisplayStyleOption of the given NXOpen.VisualReporting.GroupLabel
GetErrorLevelOfGroupLabel Gets the error level of the given:py:class:NXOpen.VisualReporting.GroupLabel.
GetFilterConditionOfRule Gets the filter NXOpen.VisualReporting.Condition from this rule.
GetGroupingMethodOfRule Gets the NXOpen.VisualReporting.ClassifierGroupingMethodOption of the active NXOpen.VisualReporting.Classifier in this NXOpen.VisualReporting.Rule.
GetHasUserSpecifiedValueForCondition Gets NXOpen.VisualReporting.Condition.HasUserSpecifiedValue() on the specified NXOpen.VisualReporting.Condition.
GetLowerBoundOfGroupLabel Gets the NXOpen.VisualReporting.GroupLabel.LowerBound() of the given NXOpen.VisualReporting.GroupLabel.
GetManualGroupLabelOfRule Returns the specified NXOpen.VisualReporting.GroupLabel`s associated with the active :py:class:`NXOpen.VisualReporting.Classifier in this NXOpen.VisualReporting.Rule which are manually defined.
GetManualGroupLabelsOfRule Returns the NXOpen.VisualReporting.GroupLabel`s associated with the active :py:class:`NXOpen.VisualReporting.Classifier in this NXOpen.VisualReporting.Rule which are manually defined.
GetManualGroupingForRule Gets whether the NXOpen.VisualReporting.ClassifierGroupingMethodOption of the active NXOpen.VisualReporting.Classifier in this NXOpen.VisualReporting.Rule is NXOpen.VisualReporting.ClassifierGroupingMethodOption.Manual.
GetObject Returns the object currently being edited by this builder.
GetObjectTypesOfVisualReport Gets the NXOpen.VisualReporting.VisualReportObjectTypeOption`s of the :py:class:`NXOpen.VisualReporting.VisualReport being built by this builder.
GetOperatorTypeOfCondition Gets the NXOpen.VisualReporting.ConditionOperatorOption of this condition.
GetParentCondition Gets the parent condition of this NXOpen.VisualReporting.Condition.
GetPropertyForComparison Gets the NXOpen.VisualReporting.Property in the value for comparison of this NXOpen.VisualReporting.Condition.
GetPropertyOfCondition Gets the NXOpen.VisualReporting.Property of this condition.
GetPropertySpecification Gets the property specification of the NXOpen.VisualReporting.Property being built by this builder.
GetRangeMethodOfRule Gets the NXOpen.VisualReporting.ClassifierRangeMethodOption of the active NXOpen.VisualReporting.Classifier in the given NXOpen.VisualReporting.Rule.
GetReferencePropertiesOfReport Gets the message NXOpen.VisualReporting.Property list of the NXOpen.VisualReporting.VisualReport.
GetReferencePropertiesOfReportingProperty Gets the message NXOpen.VisualReporting.Property list of the NXOpen.VisualReporting.Property in the active NXOpen.VisualReporting.Classifier.
GetReportingDatatypeOfRule Gets the NXOpen.VisualReporting.PropertyDatatypeOption of the active NXOpen.VisualReporting.Classifier’s reporting NXOpen.VisualReporting.Property in this NXOpen.VisualReporting.Rule.
GetReportingPropertyOfRule Gets the reporting NXOpen.VisualReporting.Property for the active NXOpen.VisualReporting.Classifier in this NXOpen.VisualReporting.Rule.
GetRule Return the specified NXOpen.VisualReporting.Rule from the NXOpen.VisualReporting.VisualReport being built by this builder.
GetRules Returns all the NXOpen.VisualReporting.Rule`s in the :py:class:`NXOpen.VisualReporting.VisualReport being built by this builder.
GetTagPriorityOfGroupLabel Gets the priority of the given:py:class:NXOpen.VisualReporting.GroupLabel.
GetUpperBoundOfGroupLabel Gets the NXOpen.VisualReporting.GroupLabel.UpperBound() of the given NXOpen.VisualReporting.GroupLabel.
GetUserNameOfGroupLabel Gets the NXOpen.NXObject.Name() of the given NXOpen.VisualReporting.GroupLabel.
GetUserPromptOfCondition Gets the NXOpen.VisualReporting.Condition.UserPrompt() of the specified NXOpen.VisualReporting.Condition.
GetValueOfCondition Gets the value of this NXOpen.VisualReporting.Condition.
GetValueOfGroupLabel Gets the NXOpen.VisualReporting.GroupLabel.Value() of the given NXOpen.VisualReporting.GroupLabel.
IsChildCondition Returns whether the given NXOpen.VisualReporting.Condition is an immediate child of this condition
RemoveChildFromCondition Removes a condition from its parent condition.
RemoveFilterConditionFromRule Removes any existing filter NXOpen.VisualReporting.Condition from this rule.
RemovePropertyFromCondition Removes the current NXOpen.VisualReporting.Property from this condition without deleting it.
Save Saves the NXOpen.VisualReporting.VisualReport to its current NXOpen.VisualReporting.VisualReportBuilder.FilenameOfVisualReport() .
SetActiveClassifierOfRule Sets the active NXOpen.VisualReporting.Classifier in this NXOpen.VisualReporting.Rule for a multiple properties report.
SetBitmapNameOfGroupLabel Sets the bitmap of the given NXOpen.VisualReporting.GroupLabel.
SetClassifierTypeOfRule Sets the reporting NXOpen.VisualReporting.ClassifierTypeOption for the active NXOpen.VisualReporting.Classifier in this NXOpen.VisualReporting.Rule.
SetColorOfGroupLabel Sets the NXOpen.VisualReporting.GroupLabel.Color() of the given NXOpen.VisualReporting.GroupLabel.
SetCustomMessageOfGroupLabel Sets the custom message of the given NXOpen.VisualReporting.GroupLabel.
SetDateGroupMethodOfRule Sets the NXOpen.VisualReporting.ClassifierDateGroupMethodOption of the active NXOpen.VisualReporting.Classifier in the given NXOpen.VisualReporting.Rule.
SetDescriptionOfCondition Sets the NXOpen.VisualReporting.Condition.Description() of the specified NXOpen.VisualReporting.Condition.
SetDisplayStyleForGroupLabel Sets the NXOpen.VisualReporting.GroupLabelDisplayStyleOption of the given NXOpen.VisualReporting.GroupLabel
SetErrorLevelOfGroupLabel Sets the priority of the given:py:class:NXOpen.VisualReporting.GroupLabel.
SetFilterConditionOfRule Sets the filter NXOpen.VisualReporting.Condition from this rule.
SetGroupingMethodOfRule Sets the NXOpen.VisualReporting.ClassifierGroupingMethodOption of the active NXOpen.VisualReporting.Classifier in the given NXOpen.VisualReporting.Rule.
SetHasUserSpecifiedValueForCondition Sets NXOpen.VisualReporting.Condition.HasUserSpecifiedValue() on the specified NXOpen.VisualReporting.Condition.
SetLowerBoundOfGroupLabel Sets the NXOpen.VisualReporting.GroupLabel.LowerBound() of the given NXOpen.VisualReporting.GroupLabel.
SetManualGroupingForRule Sets whether the NXOpen.VisualReporting.ClassifierGroupingMethodOption of the active NXOpen.VisualReporting.Classifier in this NXOpen.VisualReporting.Rule is NXOpen.VisualReporting.ClassifierGroupingMethodOption.Manual.
SetObjectTypesOfVisualReport Sets the NXOpen.VisualReporting.VisualReportObjectTypeOption`s of the :py:class:`NXOpen.VisualReporting.VisualReport being built by this builder.
SetOperatorTypeOfCondition Sets the NXOpen.VisualReporting.ConditionOperatorOption of this condition.
SetPropertyForComparison Sets the NXOpen.VisualReporting.Property in the value for comparison of this NXOpen.VisualReporting.Condition.
SetPropertyOfCondition Sets the NXOpen.VisualReporting.Property of this condition.
SetPropertySpecification Sets the property specification of the NXOpen.VisualReporting.Property being built by this builder.
SetRangeMethodOfRule Sets the NXOpen.VisualReporting.ClassifierRangeMethodOption of the active NXOpen.VisualReporting.Classifier in the given NXOpen.VisualReporting.Rule.
SetReferencePropertiesOfReport Sets the message NXOpen.VisualReporting.Property list of the NXOpen.VisualReporting.VisualReport.
SetReferencePropertiesOfReportingProperty Sets the message NXOpen.VisualReporting.Property list of the NXOpen.VisualReporting.Property in the active NXOpen.VisualReporting.Classifier.
SetReportingDatatypeOfRule Sets the NXOpen.VisualReporting.PropertyDatatypeOption of the active NXOpen.VisualReporting.Classifier’s reporting NXOpen.VisualReporting.Property in this NXOpen.VisualReporting.Rule.
SetReportingPropertyOfRule Sets the reporting NXOpen.VisualReporting.Property for the active NXOpen.VisualReporting.Classifier in this NXOpen.VisualReporting.Rule.
SetTagPriorityOfGroupLabel Sets the priority of the given:py:class:NXOpen.VisualReporting.GroupLabel.
SetUpperBoundOfGroupLabel Sets the NXOpen.VisualReporting.GroupLabel.UpperBound() of the given NXOpen.VisualReporting.GroupLabel.
SetUserNameOfGroupLabel Sets the NXOpen.NXObject.Name() of the given NXOpen.VisualReporting.GroupLabel.
SetUserPromptOfCondition Sets the NXOpen.VisualReporting.Condition.UserPrompt() of the specified NXOpen.VisualReporting.Condition.
SetValueOfCondition Sets the value of this NXOpen.VisualReporting.Condition.
SetValueOfGroupLabel Sets the NXOpen.VisualReporting.GroupLabel.Value() of the given NXOpen.VisualReporting.GroupLabel.
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UnsetUserNameOfGroupLabel Resets the NXOpen.VisualReporting.GroupLabel.IsNameUserSpecified() status of the given NXOpen.VisualReporting.GroupLabel so that the name is now system-generated.
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

VisualReportBuilderPropertyUsageOption Enumeration Represents the usage option of reference NXOpen.VisualReporting.Property

Property Detail

BitmapNameOfReport

VisualReportBuilder.BitmapNameOfReport

Returns or sets the bitmap name of the NXOpen.VisualReporting.VisualReport.

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

Getter Method

Signature BitmapNameOfReport

Returns:The bitmap name
Return type:str

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature BitmapNameOfReport

Parameters:bitmapName (str) – The bitmap name

New in version NX8.0.0.

License requirements: None.

BitmapNameOfReportingProperty

VisualReportBuilder.BitmapNameOfReportingProperty

Returns or sets the bitmap name of the reporting NXOpen.VisualReporting.Property in the active NXOpen.VisualReporting.Classifier.

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

Getter Method

Signature BitmapNameOfReportingProperty

Returns:The bitmap name
Return type:str

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature BitmapNameOfReportingProperty

Parameters:bitmapName (str) – The bitmap name

New in version NX8.0.0.

License requirements: None.

CustomMessageOfReport

VisualReportBuilder.CustomMessageOfReport

Returns or sets the custom message of the NXOpen.VisualReporting.VisualReport.

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

Getter Method

Signature CustomMessageOfReport

Returns:The custom message
Return type:str

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature CustomMessageOfReport

Parameters:customMessage (str) – The custom message

New in version NX8.0.0.

License requirements: None.

CustomMessageOfReportingProperty

VisualReportBuilder.CustomMessageOfReportingProperty

Returns or sets the custom message of the reporting NXOpen.VisualReporting.Property in the active NXOpen.VisualReporting.Classifier.

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

Getter Method

Signature CustomMessageOfReportingProperty

Returns:The custom message
Return type:str

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature CustomMessageOfReportingProperty

Parameters:customMessage (str) – The custom message

New in version NX8.0.0.

License requirements: None.

DescriptionOfVisualReport

VisualReportBuilder.DescriptionOfVisualReport

Returns or sets the description of the NXOpen.VisualReporting.VisualReport being built by this builder.

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

Getter Method

Signature DescriptionOfVisualReport

Returns:The description
Return type:str

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature DescriptionOfVisualReport

Parameters:description (str) – The description

New in version NX8.0.0.

License requirements: None.

DescriptiveCategoryOfVisualReport

VisualReportBuilder.DescriptiveCategoryOfVisualReport

Returns or sets the descriptive category of the NXOpen.VisualReporting.VisualReport being built by this builder.

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

Getter Method

Signature DescriptiveCategoryOfVisualReport

Returns:The category
Return type:str

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature DescriptiveCategoryOfVisualReport

Parameters:category (str) – The category being set

New in version NX7.5.0.

License requirements: None.

DestinationTeamcenterFolder

VisualReportBuilder.DestinationTeamcenterFolder

Returns or sets the destination Teamcenter folder for saving the NXOpen.VisualReporting.VisualReport being built by this builder to Teamcenter database.

Note that this property is only needed when NX is connected to Teamcenter and report is saved as a copy to Teamcenter database. This NXOpen.VisualReporting.VisualReport.DestinationTeamcenterFolder() may return None if you haven’t set a folder name on this property.

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

Getter Method

Signature DestinationTeamcenterFolder

Returns:The Teamcenter folder name
Return type:str

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature DestinationTeamcenterFolder

Parameters:foldername (str) – The Teamcenter folder name

New in version NX8.0.0.

License requirements: None.

FilenameOfVisualReport

VisualReportBuilder.FilenameOfVisualReport

Returns or sets the file name of the NXOpen.VisualReporting.VisualReport being built by this builder.

Note that when NX is connected to Teamcenter, this property is the report dataset identifier from Teamcenter database. If it is a new report, it will be the report dataset name. When the report is save by NXOpen.VisualReporting.VisualReportBuilder.Save(), the report dataset identifier will be saved in this property.

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

Getter Method

Signature FilenameOfVisualReport

Returns:The file name
Return type:str

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature FilenameOfVisualReport

Parameters:filename (str) – The file name

New in version NX8.0.0.

License requirements: None.

KeywordsOfVisualReport

VisualReportBuilder.KeywordsOfVisualReport

Returns or sets the keywords of the NXOpen.VisualReporting.VisualReport being built by this builder.

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

Getter Method

Signature KeywordsOfVisualReport

Returns:A comma separated string of keywords
Return type:str

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature KeywordsOfVisualReport

Parameters:keywords (str) – A comma separated string of keywords

New in version NX8.0.0.

License requirements: None.

ReportContextOfVisualReport

VisualReportBuilder.ReportContextOfVisualReport

Returns or sets the NXOpen.VisualReporting.VisualReportReportContextOption of the NXOpen.VisualReporting.VisualReport being built by this builder.

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

Getter Method

Signature ReportContextOfVisualReport

Returns:The report context
Return type:NXOpen.VisualReporting.VisualReportReportContextOption

New in version NX9.0.0.

Deprecated since version NX9.0.3: Use NXOpen.VisualReporting.VisualReport.ReportContext() instead.

License requirements: None.

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

Setter Method

Signature ReportContextOfVisualReport

Parameters:reportContext (NXOpen.VisualReporting.VisualReportReportContextOption) – The report context being set

New in version NX9.0.0.

Deprecated since version NX9.0.3: Use NXOpen.VisualReporting.VisualReport.ReportContext() instead.

License requirements: None.

ReportNameOfVisualReport

VisualReportBuilder.ReportNameOfVisualReport

Returns or sets the name of the NXOpen.VisualReporting.VisualReport being built by this builder.

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

Getter Method

Signature ReportNameOfVisualReport

Returns:The name of the report
Return type:str

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature ReportNameOfVisualReport

Parameters:reportName (str) – The name of the report

New in version NX8.0.0.

License requirements: None.

ReportingObjectTypeOfVisualReport

VisualReportBuilder.ReportingObjectTypeOfVisualReport

Returns or sets the reporting object type of the NXOpen.VisualReporting.VisualReport being built by this builder.

Only valid if the NXOpen.VisualReporting.VisualReport.ScopeType() of the NXOpen.VisualReporting.VisualReport is NXOpen.VisualReporting.VisualReportScopeTypeOption.Component type.

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

Getter Method

Signature ReportingObjectTypeOfVisualReport

Returns:The reporting object being set
Return type:NXOpen.VisualReporting.VisualReportReportingObjectTypeOption

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature ReportingObjectTypeOfVisualReport

Parameters:reportingObjectType (NXOpen.VisualReporting.VisualReportReportingObjectTypeOption) – The reporting object being set

New in version NX8.0.0.

License requirements: None.

ReportingStyleOfVisualReport

VisualReportBuilder.ReportingStyleOfVisualReport

Returns or sets the reporting style of the NXOpen.VisualReporting.VisualReport being built by this builder.

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

Getter Method

Signature ReportingStyleOfVisualReport

Returns:The reporting style
Return type:NXOpen.VisualReporting.VisualReportReportingStyleOption

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature ReportingStyleOfVisualReport

Parameters:reportingStyle (NXOpen.VisualReporting.VisualReportReportingStyleOption) – The reporting style being set

New in version NX8.0.0.

License requirements: None.

SaveDestination

VisualReportBuilder.SaveDestination

Returns or sets the NXOpen.VisualReporting.VisualReportSaveDestinationOption of the NXOpen.VisualReporting.VisualReport being built by this builder.

Note that this property will always be NXOpen.VisualReporting.VisualReportSaveDestinationOption.Local when NX is not connected to Teamcenter.

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

Getter Method

Signature SaveDestination

Returns:The destination option
Return type:NXOpen.VisualReporting.VisualReportSaveDestinationOption

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature SaveDestination

Parameters:destinationOption (NXOpen.VisualReporting.VisualReportSaveDestinationOption) – The destination option

New in version NX8.0.0.

License requirements: None.

ScopeTypeOfVisualReport

VisualReportBuilder.ScopeTypeOfVisualReport

Returns or sets the NXOpen.VisualReporting.VisualReportScopeTypeOption of the NXOpen.VisualReporting.VisualReport being built by this builder.

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

Getter Method

Signature ScopeTypeOfVisualReport

Returns:
Return type:NXOpen.VisualReporting.VisualReportScopeTypeOption

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature ScopeTypeOfVisualReport

Parameters:scopeType (NXOpen.VisualReporting.VisualReportScopeTypeOption) –

New in version NX9.0.0.

License requirements: None.

Method Detail

AddChildToCondition

VisualReportBuilder.AddChildToCondition

Add a new child NXOpen.VisualReporting.Condition to this condition.

If the child is already a child of another NXOpen.VisualReporting.Condition or NXOpen.VisualReporting.Rule, then it is removed from that other object. The new child must have been created in the same NXOpen.VisualReporting.VisualReport as this parent condition. If this is a NXOpen.VisualReporting.ConditionTypeOption.NotCondition then this replaces the existing child, and the existing child is deleted.

Signature AddChildToCondition(condition, childCondition)

Parameters:

New in version NX7.0.0.

License requirements: None.

CommitAsCopy

VisualReportBuilder.CommitAsCopy

When Builder.Commit() is called on this builder, it will delete the original NXOpen.VisualReporting.VisualReport whose copy the builder is editing and install the copied NXOpen.VisualReporting.VisualReport to the NXOpen.VisualReporting.VisualReportManager.

If it is required not to delete the original NXOpen.VisualReporting.VisualReport, then CommitAsCopy() can be called instead. This behaves just like Builder.Commit() except it does not delete the original NXOpen.VisualReporting.VisualReport.

Signature CommitAsCopy()

Returns:
Return type:NXOpen.VisualReporting.VisualReport

New in version NX7.0.0.

License requirements: None.

CreateAndCondition

VisualReportBuilder.CreateAndCondition

Creates a new empty NXOpen.VisualReporting.Condition, but does not add it to a NXOpen.VisualReporting.Rule.

Signature CreateAndCondition()

Returns:The created condition
Return type:NXOpen.VisualReporting.Condition

New in version NX7.0.0.

License requirements: None.

CreateBooleanCondition

VisualReportBuilder.CreateBooleanCondition

Creates a new empty NXOpen.VisualReporting.Condition whose NXOpen.VisualReporting.Condition.Datatype() is NXOpen.VisualReporting.PropertyDatatypeOption.Boolean, but does not add it to a NXOpen.VisualReporting.Rule.

Signature CreateBooleanCondition(property, value, operatorType)

Parameters:
Returns:

The created condition
Return type:

NXOpen.VisualReporting.Condition

New in version NX7.0.0.

License requirements: None.

CreateDateCondition

VisualReportBuilder.CreateDateCondition

Creates a new empty NXOpen.VisualReporting.Condition whose NXOpen.VisualReporting.Condition.Datatype() is NXOpen.VisualReporting.PropertyDatatypeOption.Date, but does not add it to a NXOpen.VisualReporting.Rule.

Signature CreateDateCondition(property, value, operatorType)

Parameters:
Returns:

The created condition
Return type:

NXOpen.VisualReporting.Condition

New in version NX8.0.0.

License requirements: None.

CreateGroupLabel

VisualReportBuilder.CreateGroupLabel

Creates a new empty NXOpen.VisualReporting.GroupLabel, and adds it to the given NXOpen.VisualReporting.Rule.

This can only be called if the active NXOpen.VisualReporting.Classifier in this rule is using NXOpen.VisualReporting.ClassifierGroupingMethodOption.Manual grouping.

Signature CreateGroupLabel(name, rule, afterGroupLabel)

Parameters:
Returns:

The created group label
Return type:

NXOpen.VisualReporting.GroupLabel

New in version NX7.0.0.

License requirements: None.

CreateIntegerCondition

VisualReportBuilder.CreateIntegerCondition

Creates a new empty NXOpen.VisualReporting.Condition whose NXOpen.VisualReporting.Condition.Datatype() is NXOpen.VisualReporting.PropertyDatatypeOption.Integer, but does not add it to a NXOpen.VisualReporting.Rule.

Signature CreateIntegerCondition(property, value, operatorType)

Parameters:
Returns:

The created condition
Return type:

NXOpen.VisualReporting.Condition

New in version NX7.0.0.

License requirements: None.

CreateNotCondition

VisualReportBuilder.CreateNotCondition

Creates a new empty NXOpen.VisualReporting.Condition, but does not add it to a NXOpen.VisualReporting.Rule.

Signature CreateNotCondition()

Returns:The created condition
Return type:NXOpen.VisualReporting.Condition

New in version NX7.0.0.

License requirements: None.

CreateNullCondition

VisualReportBuilder.CreateNullCondition

Creates a new empty NXOpen.VisualReporting.Condition whose NXOpen.VisualReporting.Condition.Datatype() is NXOpen.VisualReporting.PropertyDatatypeOption.Null, but does not add it to a NXOpen.VisualReporting.Rule.

Signature CreateNullCondition(property, value, operatorType)

Parameters:
Returns:

The created condition
Return type:

NXOpen.VisualReporting.Condition

New in version NX8.0.0.

License requirements: None.

CreateOrCondition

VisualReportBuilder.CreateOrCondition

Creates a new empty NXOpen.VisualReporting.Condition, but does not add it to a NXOpen.VisualReporting.Rule.

Signature CreateOrCondition()

Returns:The created condition
Return type:NXOpen.VisualReporting.Condition

New in version NX7.0.0.

License requirements: None.

CreateProperty

VisualReportBuilder.CreateProperty

Creates a new empty NXOpen.VisualReporting.Property, but does not add it to a NXOpen.VisualReporting.VisualReport.

Signature CreateProperty(propertyType)

Parameters:propertyType (NXOpen.VisualReporting.PropertyTypeOption) – Property Type of the NXOpen.VisualReporting.Property being created
Returns:The created property
Return type:NXOpen.VisualReporting.Property

New in version NX7.0.0.

License requirements: None.

CreateRealCondition

VisualReportBuilder.CreateRealCondition

Creates a new empty NXOpen.VisualReporting.Condition whose NXOpen.VisualReporting.Condition.Datatype() is NXOpen.VisualReporting.PropertyDatatypeOption.Real, but does not add it to a NXOpen.VisualReporting.Rule.

Signature CreateRealCondition(property, value, operatorType, tolerance)

Parameters:
Returns:

The created condition
Return type:

NXOpen.VisualReporting.Condition

New in version NX7.0.0.

License requirements: None.

CreateStringCondition

VisualReportBuilder.CreateStringCondition

Creates a new empty NXOpen.VisualReporting.Condition whose NXOpen.VisualReporting.Condition.Datatype() is NXOpen.VisualReporting.PropertyDatatypeOption.String, but does not add it to a NXOpen.VisualReporting.Rule.

Signature CreateStringCondition(property, value, operatorType)

Parameters:
Returns:

The created condition
Return type:

NXOpen.VisualReporting.Condition

New in version NX7.0.0.

License requirements: None.

CreateVisualReport

VisualReportBuilder.CreateVisualReport

Creates a new empty NXOpen.VisualReporting.VisualReport and starts editing it.

The created NXOpen.VisualReporting.VisualReport will not be added to the NXOpen.VisualReporting.VisualReportManager until Builder.Commit() or NXOpen.VisualReporting.VisualReportBuilder.CommitAsCopy() is called on this builder.

Signature CreateVisualReport()

Returns:
Return type:NXOpen.VisualReporting.VisualReport

New in version NX7.0.0.

License requirements: None.

DeleteChildCondition

VisualReportBuilder.DeleteChildCondition

Deletes a NXOpen.VisualReporting.Condition from its parent condition.

If there are :py:class:`NXOpen.VisualReporting.Property`s associated with this condition, these properties will be deleted. If there are child conditions associated with this condtion, these child conditions will be deleted too.

Signature DeleteChildCondition(condition, childCondition)

Parameters:

New in version NX8.0.0.

License requirements: None.

DeleteGroupLabel

VisualReportBuilder.DeleteGroupLabel

Deletes the given NXOpen.VisualReporting.GroupLabel from the active NXOpen.VisualReporting.Classifier in this NXOpen.VisualReporting.Rule.

Signature DeleteGroupLabel(rule, groupLabel)

Parameters:

New in version NX7.0.0.

License requirements: None.

DeleteProperty

VisualReportBuilder.DeleteProperty

Delete NXOpen.VisualReporting.Property which has no owner.

Before call this function, User must be sure there is no reference to this object

Signature DeleteProperty(property)

Parameters:property (NXOpen.VisualReporting.Property) – The property to be deleted

New in version NX7.0.0.

License requirements: None.

EditVisualReport

VisualReportBuilder.EditVisualReport

Starts editing a NXOpen.VisualReporting.VisualReport.

The builder will create a copy of the given VisualReport and all edits will be applied to that copy. When Builder.Commit() is called on this builder, the supplied VisualReport will be deleted and replaced with the new one. Alternatively if NXOpen.VisualReporting.VisualReportBuilder.CommitAsCopy() is called, the copied NXOpen.VisualReporting.VisualReport will be added to the NXOpen.VisualReporting.VisualReportManager without deleting the one given in this function.

Any current NXOpen.VisualReporting.VisualReport which this builder is currently building will be deleted when this function is called.

Signature EditVisualReport(visualReport)

Parameters:visualReport (NXOpen.VisualReporting.VisualReport) – The visual report

New in version NX7.0.0.

License requirements: None.

EnableUnmatchedGroupOfVisualReport

VisualReportBuilder.EnableUnmatchedGroupOfVisualReport

Sets whether use of NXOpen.VisualReporting.VisualReport.UnmatchedGroupLabel() is enabled for the NXOpen.VisualReporting.VisualReport being built by this builder.

Signature EnableUnmatchedGroupOfVisualReport(enableUnmatchedGroup)

Parameters:enableUnmatchedGroup (bool) – Whether the unmatched group is enabled

New in version NX7.0.0.

License requirements: None.

GetActiveClassifierOfRule

VisualReportBuilder.GetActiveClassifierOfRule

Gets the active NXOpen.VisualReporting.Classifier in this NXOpen.VisualReporting.Rule for a multiple properties report.

Signature GetActiveClassifierOfRule(rule)

Parameters:rule (NXOpen.VisualReporting.Rule) –
Returns:
Return type:NXOpen.VisualReporting.Classifier

New in version NX8.0.0.

License requirements: None.

GetAllGroupLabelsOfRule

VisualReportBuilder.GetAllGroupLabelsOfRule

Returns the NXOpen.VisualReporting.GroupLabel`s associated with the active :py:class:`NXOpen.VisualReporting.Classifier in this NXOpen.VisualReporting.Rule.

Signature GetAllGroupLabelsOfRule(rule)

Parameters:rule (NXOpen.VisualReporting.Rule) – The rule
Returns:The manually defined groups
Return type:list of NXOpen.VisualReporting.GroupLabel

New in version NX8.0.0.

License requirements: None.

GetBitmapNameOfGroupLabel

VisualReportBuilder.GetBitmapNameOfGroupLabel

Gets the bitmap of the given NXOpen.VisualReporting.GroupLabel.

Signature GetBitmapNameOfGroupLabel(groupLabel)

Parameters:groupLabel (NXOpen.VisualReporting.GroupLabel) – The group label
Returns:The bitmap name
Return type:str

New in version NX8.0.0.

License requirements: None.

GetChildCondition

VisualReportBuilder.GetChildCondition

Returns the specified child NXOpen.VisualReporting.Condition from this NXOpen.VisualReporting.Condition

Signature GetChildCondition(condition, index)

Parameters:
Returns:
Return type:

NXOpen.VisualReporting.Condition

New in version NX8.0.0.

License requirements: None.

GetChildConditions

VisualReportBuilder.GetChildConditions

Returns all the child NXOpen.VisualReporting.Condition`s in this :py:class:`NXOpen.VisualReporting.Condition

Signature GetChildConditions(condition)

Parameters:condition (NXOpen.VisualReporting.Condition) –
Returns:
Return type:list of NXOpen.VisualReporting.Condition

New in version NX8.0.0.

License requirements: None.

GetClassifierTypeOfRule

VisualReportBuilder.GetClassifierTypeOfRule

Gets the reporting NXOpen.VisualReporting.ClassifierTypeOption for the active NXOpen.VisualReporting.Classifier in this NXOpen.VisualReporting.Rule.

Signature GetClassifierTypeOfRule(rule)

Parameters:rule (NXOpen.VisualReporting.Rule) – The rule
Returns:The classifier type
Return type:NXOpen.VisualReporting.ClassifierTypeOption

New in version NX8.0.0.

License requirements: None.

GetClassifiersOfRule

VisualReportBuilder.GetClassifiersOfRule

Returns the NXOpen.VisualReporting.Classifier`s associated with this :py:class:`NXOpen.VisualReporting.Rule.

Signature GetClassifiersOfRule(rule)

Parameters:rule (NXOpen.VisualReporting.Rule) –
Returns:
Return type:list of NXOpen.VisualReporting.Classifier

New in version NX8.0.0.

License requirements: None.

GetColorOfGroupLabel

VisualReportBuilder.GetColorOfGroupLabel

Gets the NXOpen.VisualReporting.GroupLabel.Color() of the given NXOpen.VisualReporting.GroupLabel.

Signature GetColorOfGroupLabel(groupLabel)

Parameters:groupLabel (NXOpen.VisualReporting.GroupLabel) – The group label
Returns:The color
Return type:NXOpen.NXColorRgb_Struct

New in version NX8.0.0.

License requirements: None.

GetCustomMessageOfGroupLabel

VisualReportBuilder.GetCustomMessageOfGroupLabel

Gets the custom message of the given:py:class:NXOpen.VisualReporting.GroupLabel.

Signature GetCustomMessageOfGroupLabel(groupLabel)

Parameters:groupLabel (NXOpen.VisualReporting.GroupLabel) – The group label
Returns:The bitmap name
Return type:str

New in version NX8.0.0.

License requirements: None.

GetDateGroupMethodOfRule

VisualReportBuilder.GetDateGroupMethodOfRule

Gets the NXOpen.VisualReporting.ClassifierDateGroupMethodOption of the active NXOpen.VisualReporting.Classifier in the given NXOpen.VisualReporting.Rule.

Only valid if the active NXOpen.VisualReporting.Classifier in the rule is NXOpen.VisualReporting.ClassifierTypeOption.Range type.

Signature GetDateGroupMethodOfRule(rule)

Parameters:rule (NXOpen.VisualReporting.Rule) – The rule
Returns:The range method
Return type:NXOpen.VisualReporting.ClassifierDateGroupMethodOption

New in version NX8.0.1.

License requirements: None.

GetDescriptionOfCondition

VisualReportBuilder.GetDescriptionOfCondition

Gets the NXOpen.VisualReporting.Condition.Description() of the specified NXOpen.VisualReporting.Condition.

Only valid for a NXOpen.VisualReporting.Condition whose NXOpen.VisualReporting.Condition.Type() is NXOpen.VisualReporting.ConditionTypeOption.ValueCondition

Signature GetDescriptionOfCondition(condition)

Parameters:condition (NXOpen.VisualReporting.Condition) – The condition
Returns:The description
Return type:str

New in version NX8.0.0.

License requirements: None.

GetDisplayStyleForGroupLabel

VisualReportBuilder.GetDisplayStyleForGroupLabel

Gets the NXOpen.VisualReporting.GroupLabelDisplayStyleOption of the given NXOpen.VisualReporting.GroupLabel

Signature GetDisplayStyleForGroupLabel(groupLabel)

Parameters:groupLabel (NXOpen.VisualReporting.GroupLabel) – The group label
Returns:The display style
Return type:NXOpen.VisualReporting.GroupLabelDisplayStyleOption

New in version NX8.0.0.

License requirements: None.

GetErrorLevelOfGroupLabel

VisualReportBuilder.GetErrorLevelOfGroupLabel

Gets the error level of the given:py:class:NXOpen.VisualReporting.GroupLabel.

Signature GetErrorLevelOfGroupLabel(groupLabel)

Parameters:groupLabel (NXOpen.VisualReporting.GroupLabel) – The group label
Returns:The error level
Return type:NXOpen.ValidationResult

New in version NX12.0.0.

License requirements: None.

GetFilterConditionOfRule

VisualReportBuilder.GetFilterConditionOfRule

Gets the filter NXOpen.VisualReporting.Condition from this rule.

Signature GetFilterConditionOfRule(rule)

Parameters:rule (NXOpen.VisualReporting.Rule) – The rule
Returns:The filter condition
Return type:NXOpen.VisualReporting.Condition

New in version NX8.0.0.

License requirements: None.

GetGroupingMethodOfRule

VisualReportBuilder.GetGroupingMethodOfRule

Gets the NXOpen.VisualReporting.ClassifierGroupingMethodOption of the active NXOpen.VisualReporting.Classifier in this NXOpen.VisualReporting.Rule.

Signature GetGroupingMethodOfRule(rule)

Parameters:rule (NXOpen.VisualReporting.Rule) – The rule
Returns:The grouping method
Return type:NXOpen.VisualReporting.ClassifierGroupingMethodOption

New in version NX8.0.0.

License requirements: None.

GetHasUserSpecifiedValueForCondition

VisualReportBuilder.GetHasUserSpecifiedValueForCondition

Gets NXOpen.VisualReporting.Condition.HasUserSpecifiedValue() on the specified NXOpen.VisualReporting.Condition.

Only valid for a NXOpen.VisualReporting.Condition whose NXOpen.VisualReporting.Condition.Type() is NXOpen.VisualReporting.ConditionTypeOption.ValueCondition

Signature GetHasUserSpecifiedValueForCondition(condition)

Parameters:condition (NXOpen.VisualReporting.Condition) – The condition
Returns:Whether the condition’s value should be user-specified
Return type:bool

New in version NX8.0.0.

License requirements: None.

GetLowerBoundOfGroupLabel

VisualReportBuilder.GetLowerBoundOfGroupLabel

Gets the NXOpen.VisualReporting.GroupLabel.LowerBound() of the given NXOpen.VisualReporting.GroupLabel.

Signature GetLowerBoundOfGroupLabel(groupLabel)

Parameters:groupLabel (NXOpen.VisualReporting.GroupLabel) – The group label
Returns:The lower bound
Return type:str

New in version NX8.0.0.

License requirements: None.

GetManualGroupLabelOfRule

VisualReportBuilder.GetManualGroupLabelOfRule

Returns the specified NXOpen.VisualReporting.GroupLabel`s associated with the active :py:class:`NXOpen.VisualReporting.Classifier in this NXOpen.VisualReporting.Rule which are manually defined.

Signature GetManualGroupLabelOfRule(rule, index)

Parameters:
Returns:

The specified manually defined group
Return type:

NXOpen.VisualReporting.GroupLabel

New in version NX8.0.0.

License requirements: None.

GetManualGroupLabelsOfRule

VisualReportBuilder.GetManualGroupLabelsOfRule

Returns the NXOpen.VisualReporting.GroupLabel`s associated with the active :py:class:`NXOpen.VisualReporting.Classifier in this NXOpen.VisualReporting.Rule which are manually defined.

Signature GetManualGroupLabelsOfRule(rule)

Parameters:rule (NXOpen.VisualReporting.Rule) – The rule
Returns:The manually defined groups
Return type:list of NXOpen.VisualReporting.GroupLabel

New in version NX8.0.0.

License requirements: None.

GetManualGroupingForRule

VisualReportBuilder.GetManualGroupingForRule

Gets whether the NXOpen.VisualReporting.ClassifierGroupingMethodOption of the active NXOpen.VisualReporting.Classifier in this NXOpen.VisualReporting.Rule is NXOpen.VisualReporting.ClassifierGroupingMethodOption.Manual.

Signature GetManualGroupingForRule(rule)

Parameters:rule (NXOpen.VisualReporting.Rule) – The rule
Returns:Whether manual grouping should be used
Return type:bool

New in version NX8.0.0.

License requirements: None.

GetObjectTypesOfVisualReport

VisualReportBuilder.GetObjectTypesOfVisualReport

Gets the NXOpen.VisualReporting.VisualReportObjectTypeOption`s of the :py:class:`NXOpen.VisualReporting.VisualReport being built by this builder.

Only valid if the NXOpen.VisualReporting.VisualReport.ScopeType() of the NXOpen.VisualReporting.VisualReport is NXOpen.VisualReporting.VisualReportScopeTypeOption.SubPart type.

Signature GetObjectTypesOfVisualReport()

Returns:The object types
Return type:list of NXOpen.VisualReporting.VisualReportObjectTypeOption

New in version NX9.0.0.

License requirements: None.

GetOperatorTypeOfCondition

VisualReportBuilder.GetOperatorTypeOfCondition

Gets the NXOpen.VisualReporting.ConditionOperatorOption of this condition.

Only valid if NXOpen.VisualReporting.ConditionTypeOption is NXOpen.VisualReporting.ConditionTypeOption.ValueCondition

Signature GetOperatorTypeOfCondition(condition)

Parameters:condition (NXOpen.VisualReporting.Condition) – The condition
Returns:The operator type being set
Return type:NXOpen.VisualReporting.ConditionOperatorOption

New in version NX8.0.0.

License requirements: None.

GetParentCondition

VisualReportBuilder.GetParentCondition

Gets the parent condition of this NXOpen.VisualReporting.Condition.

If this condition has no parent or if the parent isn’t a condition then this returns None.

Signature GetParentCondition(condition)

Parameters:condition (NXOpen.VisualReporting.Condition) –
Returns:
Return type:NXOpen.VisualReporting.Condition

New in version NX8.0.0.

License requirements: None.

GetPropertyForComparison

VisualReportBuilder.GetPropertyForComparison

Gets the NXOpen.VisualReporting.Property in the value for comparison of this NXOpen.VisualReporting.Condition.

Signature GetPropertyForComparison(condition)

Parameters:condition (NXOpen.VisualReporting.Condition) – The condition
Returns:The property
Return type:NXOpen.VisualReporting.Property

New in version NX8.0.0.

License requirements: None.

GetPropertyOfCondition

VisualReportBuilder.GetPropertyOfCondition

Gets the NXOpen.VisualReporting.Property of this condition.

Only valid for a NXOpen.VisualReporting.Condition whose NXOpen.VisualReporting.Condition.Type() is NXOpen.VisualReporting.ConditionTypeOption.ValueCondition

Signature GetPropertyOfCondition(condition)

Parameters:condition (NXOpen.VisualReporting.Condition) – The condition
Returns:The property
Return type:NXOpen.VisualReporting.Property

New in version NX8.0.0.

License requirements: None.

GetPropertySpecification

VisualReportBuilder.GetPropertySpecification

Gets the property specification of the NXOpen.VisualReporting.Property being built by this builder.

Signature GetPropertySpecification(property)

Parameters:property (NXOpen.VisualReporting.Property) – The property being ask
Returns:a tuple
Return type:A tuple consisting of (propertyType, key, name). propertyType is a NXOpen.VisualReporting.PropertyTypeOption. Property Type of the NXOpen.VisualReporting.Property key is a str. property key name is a str. property name

New in version NX8.0.0.

License requirements: None.

GetRangeMethodOfRule

VisualReportBuilder.GetRangeMethodOfRule

Gets the NXOpen.VisualReporting.ClassifierRangeMethodOption of the active NXOpen.VisualReporting.Classifier in the given NXOpen.VisualReporting.Rule.

Only valid if the active NXOpen.VisualReporting.Classifier in the rule is NXOpen.VisualReporting.ClassifierTypeOption.Range type.

Signature GetRangeMethodOfRule(rule)

Parameters:rule (NXOpen.VisualReporting.Rule) – The rule
Returns:The range method
Return type:NXOpen.VisualReporting.ClassifierRangeMethodOption

New in version NX8.0.0.

License requirements: None.

GetReferencePropertiesOfReport

VisualReportBuilder.GetReferencePropertiesOfReport

Gets the message NXOpen.VisualReporting.Property list of the NXOpen.VisualReporting.VisualReport.

Signature GetReferencePropertiesOfReport()

Returns:a tuple
Return type:A tuple consisting of (properties, usages, notUsed). properties is a list of NXOpen.VisualReporting.Property. The reference properties of reportusages is a list of NXOpen.VisualReporting.VisualReportBuilderPropertyUsageOption. The usages of reportnotUsed is a int.

New in version NX8.0.0.

License requirements: None.

GetReferencePropertiesOfReportingProperty

VisualReportBuilder.GetReferencePropertiesOfReportingProperty

Gets the message NXOpen.VisualReporting.Property list of the NXOpen.VisualReporting.Property in the active NXOpen.VisualReporting.Classifier.

Signature GetReferencePropertiesOfReportingProperty()

Returns:a tuple
Return type:A tuple consisting of (properties, usages). properties is a list of NXOpen.VisualReporting.Property. The reference properties of propertyusages is a list of NXOpen.VisualReporting.VisualReportBuilderPropertyUsageOption. The usages

New in version NX8.0.0.

License requirements: None.

GetReportingDatatypeOfRule

VisualReportBuilder.GetReportingDatatypeOfRule

Gets the NXOpen.VisualReporting.PropertyDatatypeOption of the active NXOpen.VisualReporting.Classifier’s reporting NXOpen.VisualReporting.Property in this NXOpen.VisualReporting.Rule.

Signature GetReportingDatatypeOfRule(rule)

Parameters:rule (NXOpen.VisualReporting.Rule) – The rule
Returns:The datatype
Return type:NXOpen.VisualReporting.PropertyDatatypeOption

New in version NX8.0.0.

License requirements: None.

GetReportingPropertyOfRule

VisualReportBuilder.GetReportingPropertyOfRule

Gets the reporting NXOpen.VisualReporting.Property for the active NXOpen.VisualReporting.Classifier in this NXOpen.VisualReporting.Rule.

Signature GetReportingPropertyOfRule(rule)

Parameters:rule (NXOpen.VisualReporting.Rule) – The rule
Returns:The property
Return type:NXOpen.VisualReporting.Property

New in version NX8.0.0.

License requirements: None.

GetRule

VisualReportBuilder.GetRule

Return the specified NXOpen.VisualReporting.Rule from the NXOpen.VisualReporting.VisualReport being built by this builder.

Signature GetRule(index)

Parameters:index (int) – The index of the returned NXOpen.VisualReporting.Rule.
Returns:
Return type:NXOpen.VisualReporting.Rule

New in version NX8.0.0.

License requirements: None.

GetRules

VisualReportBuilder.GetRules

Returns all the NXOpen.VisualReporting.Rule`s in the :py:class:`NXOpen.VisualReporting.VisualReport being built by this builder.

Signature GetRules()

Returns:
Return type:list of NXOpen.VisualReporting.Rule

New in version NX8.0.0.

License requirements: None.

GetTagPriorityOfGroupLabel

VisualReportBuilder.GetTagPriorityOfGroupLabel

Gets the priority of the given:py:class:NXOpen.VisualReporting.GroupLabel.

Signature GetTagPriorityOfGroupLabel(groupLabel)

Parameters:groupLabel (NXOpen.VisualReporting.GroupLabel) – The group label
Returns:The priority
Return type:NXOpen.VisualReporting.GroupLabelTagPriorityOption

New in version NX8.0.0.

License requirements: None.

GetUpperBoundOfGroupLabel

VisualReportBuilder.GetUpperBoundOfGroupLabel

Gets the NXOpen.VisualReporting.GroupLabel.UpperBound() of the given NXOpen.VisualReporting.GroupLabel.

Signature GetUpperBoundOfGroupLabel(groupLabel)

Parameters:groupLabel (NXOpen.VisualReporting.GroupLabel) – The group label
Returns:The upper bound
Return type:str

New in version NX8.0.0.

License requirements: None.

GetUserNameOfGroupLabel

VisualReportBuilder.GetUserNameOfGroupLabel

Gets the NXOpen.NXObject.Name() of the given NXOpen.VisualReporting.GroupLabel.

Signature GetUserNameOfGroupLabel(groupLabel)

Parameters:groupLabel (NXOpen.VisualReporting.GroupLabel) – The group label
Returns:The name
Return type:str

New in version NX8.0.0.

License requirements: None.

GetUserPromptOfCondition

VisualReportBuilder.GetUserPromptOfCondition

Gets the NXOpen.VisualReporting.Condition.UserPrompt() of the specified NXOpen.VisualReporting.Condition.

Only valid for a NXOpen.VisualReporting.Condition whose NXOpen.VisualReporting.Condition.Type() is NXOpen.VisualReporting.ConditionTypeOption.ValueCondition

Signature GetUserPromptOfCondition(condition)

Parameters:condition (NXOpen.VisualReporting.Condition) – The condition
Returns:The user-prompt
Return type:str

New in version NX8.0.0.

License requirements: None.

GetValueOfCondition

VisualReportBuilder.GetValueOfCondition

Gets the value of this NXOpen.VisualReporting.Condition.

Only valid for a NXOpen.VisualReporting.Condition whose NXOpen.VisualReporting.Condition.Type() is NXOpen.VisualReporting.ConditionTypeOption.ValueCondition

Signature GetValueOfCondition(condition)

Parameters:condition (NXOpen.VisualReporting.Condition) –
Returns:
Return type:str

New in version NX8.0.0.

License requirements: None.

GetValueOfGroupLabel

VisualReportBuilder.GetValueOfGroupLabel

Gets the NXOpen.VisualReporting.GroupLabel.Value() of the given NXOpen.VisualReporting.GroupLabel.

Signature GetValueOfGroupLabel(groupLabel)

Parameters:groupLabel (NXOpen.VisualReporting.GroupLabel) – The group label
Returns:The value
Return type:str

New in version NX8.0.0.

License requirements: None.

IsChildCondition

VisualReportBuilder.IsChildCondition

Returns whether the given NXOpen.VisualReporting.Condition is an immediate child of this condition

Signature IsChildCondition(condition, childCondition)

Parameters:
Returns:
Return type:

bool

New in version NX8.0.0.

License requirements: None.

RemoveChildFromCondition

VisualReportBuilder.RemoveChildFromCondition

Removes a condition from its parent condition.

If the condition has an associated NXOpen.VisualReporting.Property that will be deleted too. If the condition has any child conditions, those will all be deleted too.

Signature RemoveChildFromCondition(condition, childCondition)

Parameters:

New in version NX7.0.0.

License requirements: None.

RemoveFilterConditionFromRule

VisualReportBuilder.RemoveFilterConditionFromRule

Removes any existing filter NXOpen.VisualReporting.Condition from this rule.

This will not delete the condition.

Signature RemoveFilterConditionFromRule(rule)

Parameters:rule (NXOpen.VisualReporting.Rule) – The rule

New in version NX7.0.0.

License requirements: None.

RemovePropertyFromCondition

VisualReportBuilder.RemovePropertyFromCondition

Removes the current NXOpen.VisualReporting.Property from this condition without deleting it.

Signature RemovePropertyFromCondition(condition)

Parameters:condition (NXOpen.VisualReporting.Condition) – The condition

New in version NX7.0.0.

License requirements: None.

Save

VisualReportBuilder.Save

Saves the NXOpen.VisualReporting.VisualReport to its current NXOpen.VisualReporting.VisualReportBuilder.FilenameOfVisualReport() .

Note that when NX is connected to Teamcenter, the NXOpen.VisualReporting.VisualReportBuilder.FilenameOfVisualReport() will be updated to the report dataset identifier after the report is saved to Teamcenter database.

Signature Save()

New in version NX8.0.0.

License requirements: None.

SetActiveClassifierOfRule

VisualReportBuilder.SetActiveClassifierOfRule

Sets the active NXOpen.VisualReporting.Classifier in this NXOpen.VisualReporting.Rule for a multiple properties report.

Signature SetActiveClassifierOfRule(rule, activeClassifier)

Parameters:

New in version NX8.0.0.

License requirements: None.

SetBitmapNameOfGroupLabel

VisualReportBuilder.SetBitmapNameOfGroupLabel

Sets the bitmap of the given NXOpen.VisualReporting.GroupLabel.

Signature SetBitmapNameOfGroupLabel(groupLabel, bitmapName)

Parameters:

New in version NX8.0.0.

License requirements: None.

SetClassifierTypeOfRule

VisualReportBuilder.SetClassifierTypeOfRule

Sets the reporting NXOpen.VisualReporting.ClassifierTypeOption for the active NXOpen.VisualReporting.Classifier in this NXOpen.VisualReporting.Rule.

Note that the old NXOpen.VisualReporting.Classifier in this NXOpen.VisualReporting.Rule will be deleted and a new NXOpen.VisualReporting.Classifier will be created and set as the active NXOpen.VisualReporting.Classifier in this NXOpen.VisualReporting.Rule.

Signature SetClassifierTypeOfRule(rule, classifierType)

Parameters:
Returns:

The new active classifier
Return type:

NXOpen.VisualReporting.Classifier

New in version NX8.0.0.

License requirements: None.

SetColorOfGroupLabel

VisualReportBuilder.SetColorOfGroupLabel

Sets the NXOpen.VisualReporting.GroupLabel.Color() of the given NXOpen.VisualReporting.GroupLabel.

This also changes NXOpen.VisualReporting.GroupLabel.DisplayStyle() to NXOpen.VisualReporting.GroupLabelDisplayStyleOption.SpecifiedColor.

Signature SetColorOfGroupLabel(groupLabel, color)

Parameters:

New in version NX7.0.0.

License requirements: None.

SetCustomMessageOfGroupLabel

VisualReportBuilder.SetCustomMessageOfGroupLabel

Sets the custom message of the given NXOpen.VisualReporting.GroupLabel.

Signature SetCustomMessageOfGroupLabel(groupLabel, customMessage)

Parameters:

New in version NX8.0.0.

License requirements: None.

SetDateGroupMethodOfRule

VisualReportBuilder.SetDateGroupMethodOfRule

Sets the NXOpen.VisualReporting.ClassifierDateGroupMethodOption of the active NXOpen.VisualReporting.Classifier in the given NXOpen.VisualReporting.Rule.

Only valid if the active NXOpen.VisualReporting.Classifier in the rule is NXOpen.VisualReporting.ClassifierTypeOption.Range type.

Signature SetDateGroupMethodOfRule(rule, dateGroupMethod)

Parameters:

New in version NX8.0.1.

License requirements: None.

SetDescriptionOfCondition

VisualReportBuilder.SetDescriptionOfCondition

Sets the NXOpen.VisualReporting.Condition.Description() of the specified NXOpen.VisualReporting.Condition.

Only valid for a NXOpen.VisualReporting.Condition whose NXOpen.VisualReporting.Condition.Type() is NXOpen.VisualReporting.ConditionTypeOption.ValueCondition

Signature SetDescriptionOfCondition(condition, description)

Parameters:

New in version NX7.0.0.

License requirements: None.

SetDisplayStyleForGroupLabel

VisualReportBuilder.SetDisplayStyleForGroupLabel

Sets the NXOpen.VisualReporting.GroupLabelDisplayStyleOption of the given NXOpen.VisualReporting.GroupLabel

Signature SetDisplayStyleForGroupLabel(groupLabel, displayStyle)

Parameters:

New in version NX8.0.0.

License requirements: None.

SetErrorLevelOfGroupLabel

VisualReportBuilder.SetErrorLevelOfGroupLabel

Sets the priority of the given:py:class:NXOpen.VisualReporting.GroupLabel.

Signature SetErrorLevelOfGroupLabel(groupLabel, errorLevel)

Parameters:

New in version NX12.0.0.

License requirements: None.

SetFilterConditionOfRule

VisualReportBuilder.SetFilterConditionOfRule

Sets the filter NXOpen.VisualReporting.Condition from this rule.

Setting this will delete any existing NXOpen.VisualReporting.Rule.FilterCondition() and all of its children (except it won’t delete the replacement NXOpen.VisualReporting.Condition being set by this call).

Signature SetFilterConditionOfRule(rule, filterCondition)

Parameters:

New in version NX7.0.0.

License requirements: None.

SetGroupingMethodOfRule

VisualReportBuilder.SetGroupingMethodOfRule

Sets the NXOpen.VisualReporting.ClassifierGroupingMethodOption of the active NXOpen.VisualReporting.Classifier in the given NXOpen.VisualReporting.Rule.

If the active NXOpen.VisualReporting.Classifier uses manual grouping then no NXOpen.VisualReporting.GroupLabel`s will be automatically generated, and they should instead be added using :py:meth:`NXOpen.VisualReporting.VisualReportBuilder.CreateGroupLabel.

Signature SetGroupingMethodOfRule(rule, groupingMethod)

Parameters:

New in version NX8.0.0.

License requirements: None.

SetHasUserSpecifiedValueForCondition

VisualReportBuilder.SetHasUserSpecifiedValueForCondition

Sets NXOpen.VisualReporting.Condition.HasUserSpecifiedValue() on the specified NXOpen.VisualReporting.Condition.

Only valid for a NXOpen.VisualReporting.Condition whose NXOpen.VisualReporting.Condition.Type() is NXOpen.VisualReporting.ConditionTypeOption.ValueCondition

Signature SetHasUserSpecifiedValueForCondition(condition, isUserSpecified)

Parameters:

New in version NX7.0.0.

License requirements: None.

SetLowerBoundOfGroupLabel

VisualReportBuilder.SetLowerBoundOfGroupLabel

Sets the NXOpen.VisualReporting.GroupLabel.LowerBound() of the given NXOpen.VisualReporting.GroupLabel.

Signature SetLowerBoundOfGroupLabel(groupLabel, lowerBound)

Parameters:

New in version NX8.0.0.

License requirements: None.

SetManualGroupingForRule

VisualReportBuilder.SetManualGroupingForRule

Sets whether the NXOpen.VisualReporting.ClassifierGroupingMethodOption of the active NXOpen.VisualReporting.Classifier in this NXOpen.VisualReporting.Rule is NXOpen.VisualReporting.ClassifierGroupingMethodOption.Manual.

If it uses NXOpen.VisualReporting.ClassifierGroupingMethodOption.Manual, then no NXOpen.VisualReporting.GroupLabel`s will be automatically generated, and they should instead be added manually as required using :py:meth:`NXOpen.VisualReporting.VisualReportBuilder.CreateGroupLabel.

Signature SetManualGroupingForRule(rule, isManualGrouping)

Parameters:

New in version NX7.0.0.

License requirements: None.

SetObjectTypesOfVisualReport

VisualReportBuilder.SetObjectTypesOfVisualReport

Sets the NXOpen.VisualReporting.VisualReportObjectTypeOption`s of the :py:class:`NXOpen.VisualReporting.VisualReport being built by this builder.

Only valid if the NXOpen.VisualReporting.VisualReport.ScopeType() of the NXOpen.VisualReporting.VisualReport is NXOpen.VisualReporting.VisualReportScopeTypeOption.SubPart type.

Signature SetObjectTypesOfVisualReport(objectTypes)

Parameters:objectTypes (list of NXOpen.VisualReporting.VisualReportObjectTypeOption) – The object types being set

New in version NX9.0.0.

License requirements: None.

SetOperatorTypeOfCondition

VisualReportBuilder.SetOperatorTypeOfCondition

Sets the NXOpen.VisualReporting.ConditionOperatorOption of this condition.

Only valid if NXOpen.VisualReporting.ConditionTypeOption is NXOpen.VisualReporting.ConditionTypeOption.ValueCondition

Signature SetOperatorTypeOfCondition(condition, operatorType)

Parameters:

New in version NX7.0.0.

License requirements: None.

SetPropertyForComparison

VisualReportBuilder.SetPropertyForComparison

Sets the NXOpen.VisualReporting.Property in the value for comparison of this NXOpen.VisualReporting.Condition.

If the NXOpen.VisualReporting.Property is set to None, then it is deleted.

Signature SetPropertyForComparison(condition, property)

Parameters:

New in version NX8.0.0.

License requirements: None.

SetPropertyOfCondition

VisualReportBuilder.SetPropertyOfCondition

Sets the NXOpen.VisualReporting.Property of this condition.

If the NXOpen.VisualReporting.Property is set to None, then it is deleted. Only valid for a NXOpen.VisualReporting.Condition whose NXOpen.VisualReporting.Condition.Type() is NXOpen.VisualReporting.ConditionTypeOption.ValueCondition

Signature SetPropertyOfCondition(condition, property)

Parameters:

New in version NX7.0.0.

License requirements: None.

SetPropertySpecification

VisualReportBuilder.SetPropertySpecification

Overloaded method SetPropertySpecification

  • SetPropertySpecification(property, key)
  • SetPropertySpecification(property, key, name)

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

Sets the property specification of the NXOpen.VisualReporting.Property being built by this builder.

Signature SetPropertySpecification(property, key)

Parameters:

New in version NX8.0.0.

License requirements: None.

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

Sets the property specification of the NXOpen.VisualReporting.Property being built by this builder.

Signature SetPropertySpecification(property, key, name)

Parameters:

New in version NX8.0.0.

License requirements: None.

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

SetRangeMethodOfRule

VisualReportBuilder.SetRangeMethodOfRule

Sets the NXOpen.VisualReporting.ClassifierRangeMethodOption of the active NXOpen.VisualReporting.Classifier in the given NXOpen.VisualReporting.Rule.

Only valid if the active NXOpen.VisualReporting.Classifier in the rule is NXOpen.VisualReporting.ClassifierTypeOption.Range type.

Signature SetRangeMethodOfRule(rule, rangeMethod)

Parameters:

New in version NX8.0.0.

License requirements: None.

SetReferencePropertiesOfReport

VisualReportBuilder.SetReferencePropertiesOfReport

Sets the message NXOpen.VisualReporting.Property list of the NXOpen.VisualReporting.VisualReport.

Signature SetReferencePropertiesOfReport(properties, usages)

Parameters:

New in version NX8.0.0.

License requirements: None.

SetReferencePropertiesOfReportingProperty

VisualReportBuilder.SetReferencePropertiesOfReportingProperty

Sets the message NXOpen.VisualReporting.Property list of the NXOpen.VisualReporting.Property in the active NXOpen.VisualReporting.Classifier.

Signature SetReferencePropertiesOfReportingProperty(properties, usages)

Parameters:

New in version NX8.0.0.

License requirements: None.

SetReportingDatatypeOfRule

VisualReportBuilder.SetReportingDatatypeOfRule

Sets the NXOpen.VisualReporting.PropertyDatatypeOption of the active NXOpen.VisualReporting.Classifier’s reporting NXOpen.VisualReporting.Property in this NXOpen.VisualReporting.Rule.

However datatype must not be NXOpen.VisualReporting.PropertyDatatypeOption.Unknown.

Signature SetReportingDatatypeOfRule(rule, datatype)

Parameters:

New in version NX7.0.0.

License requirements: None.

SetReportingPropertyOfRule

VisualReportBuilder.SetReportingPropertyOfRule

Sets the reporting NXOpen.VisualReporting.Property for the active NXOpen.VisualReporting.Classifier in this NXOpen.VisualReporting.Rule.

If the reporting NXOpen.VisualReporting.Property of the rule is set to None, then it is deleted.

Only valid for a NXOpen.VisualReporting.Classifier in this NXOpen.VisualReporting.Rule whose NXOpen.VisualReporting.ClassifierTypeOption is NXOpen.VisualReporting.ClassifierTypeOption.Value or NXOpen.VisualReporting.ClassifierTypeOption.Range.

Signature SetReportingPropertyOfRule(rule, reportingProperty)

Parameters:

New in version NX7.0.0.

License requirements: None.

SetTagPriorityOfGroupLabel

VisualReportBuilder.SetTagPriorityOfGroupLabel

Sets the priority of the given:py:class:NXOpen.VisualReporting.GroupLabel.

Signature SetTagPriorityOfGroupLabel(groupLabel, tagPriority)

Parameters:

New in version NX8.0.0.

License requirements: None.

SetUpperBoundOfGroupLabel

VisualReportBuilder.SetUpperBoundOfGroupLabel

Sets the NXOpen.VisualReporting.GroupLabel.UpperBound() of the given NXOpen.VisualReporting.GroupLabel.

Signature SetUpperBoundOfGroupLabel(groupLabel, upperBound)

Parameters:

New in version NX8.0.0.

License requirements: None.

SetUserNameOfGroupLabel

VisualReportBuilder.SetUserNameOfGroupLabel

Sets the NXOpen.NXObject.Name() of the given NXOpen.VisualReporting.GroupLabel.

Calling this function will cause NXOpen.VisualReporting.GroupLabel.IsNameUserSpecified() to return true.

Signature SetUserNameOfGroupLabel(groupLabel, name)

Parameters:

New in version NX7.0.0.

License requirements: None.

SetUserPromptOfCondition

VisualReportBuilder.SetUserPromptOfCondition

Sets the NXOpen.VisualReporting.Condition.UserPrompt() of the specified NXOpen.VisualReporting.Condition.

Only valid for a NXOpen.VisualReporting.Condition whose NXOpen.VisualReporting.Condition.Type() is NXOpen.VisualReporting.ConditionTypeOption.ValueCondition

Signature SetUserPromptOfCondition(condition, userPrompt)

Parameters:

New in version NX7.0.0.

License requirements: None.

SetValueOfCondition

VisualReportBuilder.SetValueOfCondition

Sets the value of this NXOpen.VisualReporting.Condition.

Only valid for a NXOpen.VisualReporting.Condition whose NXOpen.VisualReporting.Condition.Type() is NXOpen.VisualReporting.ConditionTypeOption.ValueCondition

Signature SetValueOfCondition(condition, value)

Parameters:

New in version NX8.0.0.

License requirements: None.

SetValueOfGroupLabel

VisualReportBuilder.SetValueOfGroupLabel

Sets the NXOpen.VisualReporting.GroupLabel.Value() of the given NXOpen.VisualReporting.GroupLabel.

Signature SetValueOfGroupLabel(groupLabel, value)

Parameters:

New in version NX7.0.0.

License requirements: None.

UnsetUserNameOfGroupLabel

VisualReportBuilder.UnsetUserNameOfGroupLabel

Resets the NXOpen.VisualReporting.GroupLabel.IsNameUserSpecified() status of the given NXOpen.VisualReporting.GroupLabel so that the name is now system-generated.

Signature UnsetUserNameOfGroupLabel(groupLabel)

Parameters:groupLabel (NXOpen.VisualReporting.GroupLabel) – The group label

New in version NX7.0.0.

License requirements: None.

Validate

VisualReportBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful
Return type:bool

New in version NX3.0.1.

License requirements: None.