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¶
Methods¶
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 activeNXOpen.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 activeNXOpen.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 theNXOpen.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 setNew 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 theNXOpen.VisualReporting.VisualReport
isNXOpen.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 setNew 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 setNew in version NX8.0.0.
License requirements: None.
SaveDestination¶
-
VisualReportBuilder.
SaveDestination
¶ Returns or sets the
NXOpen.VisualReporting.VisualReportSaveDestinationOption
of theNXOpen.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 optionNew in version NX8.0.0.
License requirements: None.
ScopeTypeOfVisualReport¶
-
VisualReportBuilder.
ScopeTypeOfVisualReport
¶ Returns or sets the
NXOpen.VisualReporting.VisualReportScopeTypeOption
of theNXOpen.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
orNXOpen.VisualReporting.Rule
, then it is removed from that other object. The new child must have been created in the sameNXOpen.VisualReporting.VisualReport
as this parent condition. If this is aNXOpen.VisualReporting.ConditionTypeOption.NotCondition
then this replaces the existing child, and the existing child is deleted.Signature
AddChildToCondition(condition, childCondition)
Parameters: - condition (
NXOpen.VisualReporting.Condition
) – The condition - childCondition (
NXOpen.VisualReporting.Condition
) – The child condition being added
New in version NX7.0.0.
License requirements: None.
- condition (
CommitAsCopy¶
-
VisualReportBuilder.
CommitAsCopy
¶ When
Builder.Commit()
is called on this builder, it will delete the originalNXOpen.VisualReporting.VisualReport
whose copy the builder is editing and install the copiedNXOpen.VisualReporting.VisualReport
to theNXOpen.VisualReporting.VisualReportManager
.If it is required not to delete the original
NXOpen.VisualReporting.VisualReport
, thenCommitAsCopy()
can be called instead. This behaves just likeBuilder.Commit()
except it does not delete the originalNXOpen.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 aNXOpen.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
whoseNXOpen.VisualReporting.Condition.Datatype()
isNXOpen.VisualReporting.PropertyDatatypeOption.Boolean
, but does not add it to aNXOpen.VisualReporting.Rule
.Signature
CreateBooleanCondition(property, value, operatorType)
Parameters: - property (
NXOpen.VisualReporting.Property
) – TheNXOpen.VisualReporting.Property
to which this condition will be applied - value (bool) – The initial value
- operatorType (
NXOpen.VisualReporting.ConditionOperatorOption
) – The initial operator
Returns: The created condition
Return type: New in version NX7.0.0.
License requirements: None.
- property (
CreateDateCondition¶
-
VisualReportBuilder.
CreateDateCondition
¶ Creates a new empty
NXOpen.VisualReporting.Condition
whoseNXOpen.VisualReporting.Condition.Datatype()
isNXOpen.VisualReporting.PropertyDatatypeOption.Date
, but does not add it to aNXOpen.VisualReporting.Rule
.Signature
CreateDateCondition(property, value, operatorType)
Parameters: - property (
NXOpen.VisualReporting.Property
) – TheNXOpen.VisualReporting.Property
to which this condition will be applied - value (str) – The initial value
- operatorType (
NXOpen.VisualReporting.ConditionOperatorOption
) – The initial operator
Returns: The created condition
Return type: New in version NX8.0.0.
License requirements: None.
- property (
CreateGroupLabel¶
-
VisualReportBuilder.
CreateGroupLabel
¶ Creates a new empty
NXOpen.VisualReporting.GroupLabel
, and adds it to the givenNXOpen.VisualReporting.Rule
.This can only be called if the active
NXOpen.VisualReporting.Classifier
in this rule is usingNXOpen.VisualReporting.ClassifierGroupingMethodOption.Manual
grouping.Signature
CreateGroupLabel(name, rule, afterGroupLabel)
Parameters: - name (str) – The initial name. If this name is empty then a system-generated name will be assigned when the owning
NXOpen.VisualReporting.VisualReport
is next activated - rule (
NXOpen.VisualReporting.Rule
) – The rule to which to add it - afterGroupLabel (
NXOpen.VisualReporting.GroupLabel
) – The group label after which to add it. If None then it is inserted at the beginning before any existing group labels
Returns: The created group label
Return type: New in version NX7.0.0.
License requirements: None.
- name (str) – The initial name. If this name is empty then a system-generated name will be assigned when the owning
CreateIntegerCondition¶
-
VisualReportBuilder.
CreateIntegerCondition
¶ Creates a new empty
NXOpen.VisualReporting.Condition
whoseNXOpen.VisualReporting.Condition.Datatype()
isNXOpen.VisualReporting.PropertyDatatypeOption.Integer
, but does not add it to aNXOpen.VisualReporting.Rule
.Signature
CreateIntegerCondition(property, value, operatorType)
Parameters: - property (
NXOpen.VisualReporting.Property
) – TheNXOpen.VisualReporting.Property
to which this condition will be applied - value (int) – The initial value
- operatorType (
NXOpen.VisualReporting.ConditionOperatorOption
) – The initial operator
Returns: The created condition
Return type: New in version NX7.0.0.
License requirements: None.
- property (
CreateNotCondition¶
-
VisualReportBuilder.
CreateNotCondition
¶ Creates a new empty
NXOpen.VisualReporting.Condition
, but does not add it to aNXOpen.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
whoseNXOpen.VisualReporting.Condition.Datatype()
isNXOpen.VisualReporting.PropertyDatatypeOption.Null
, but does not add it to aNXOpen.VisualReporting.Rule
.Signature
CreateNullCondition(property, value, operatorType)
Parameters: - property (
NXOpen.VisualReporting.Property
) – TheNXOpen.VisualReporting.Property
to which this condition will be applied - value (bool) – The initial value
- operatorType (
NXOpen.VisualReporting.ConditionOperatorOption
) – The initial operator
Returns: The created condition
Return type: New in version NX8.0.0.
License requirements: None.
- property (
CreateOrCondition¶
-
VisualReportBuilder.
CreateOrCondition
¶ Creates a new empty
NXOpen.VisualReporting.Condition
, but does not add it to aNXOpen.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 aNXOpen.VisualReporting.VisualReport
.Signature
CreateProperty(propertyType)
Parameters: propertyType ( NXOpen.VisualReporting.PropertyTypeOption
) – Property Type of theNXOpen.VisualReporting.Property
being createdReturns: 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
whoseNXOpen.VisualReporting.Condition.Datatype()
isNXOpen.VisualReporting.PropertyDatatypeOption.Real
, but does not add it to aNXOpen.VisualReporting.Rule
.Signature
CreateRealCondition(property, value, operatorType, tolerance)
Parameters: - property (
NXOpen.VisualReporting.Property
) – TheNXOpen.VisualReporting.Property
to which this condition will be applied - value (float) – The initial value
- operatorType (
NXOpen.VisualReporting.ConditionOperatorOption
) – The initial operator - tolerance (float) – The tolerance used in comparisons
Returns: The created condition
Return type: New in version NX7.0.0.
License requirements: None.
- property (
CreateStringCondition¶
-
VisualReportBuilder.
CreateStringCondition
¶ Creates a new empty
NXOpen.VisualReporting.Condition
whoseNXOpen.VisualReporting.Condition.Datatype()
isNXOpen.VisualReporting.PropertyDatatypeOption.String
, but does not add it to aNXOpen.VisualReporting.Rule
.Signature
CreateStringCondition(property, value, operatorType)
Parameters: - property (
NXOpen.VisualReporting.Property
) – TheNXOpen.VisualReporting.Property
to which this condition will be applied - value (str) – The initial value
- operatorType (
NXOpen.VisualReporting.ConditionOperatorOption
) – The initial operator
Returns: The created condition
Return type: New in version NX7.0.0.
License requirements: None.
- property (
CreateVisualReport¶
-
VisualReportBuilder.
CreateVisualReport
¶ Creates a new empty
NXOpen.VisualReporting.VisualReport
and starts editing it.The created
NXOpen.VisualReporting.VisualReport
will not be added to theNXOpen.VisualReporting.VisualReportManager
untilBuilder.Commit()
orNXOpen.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: - condition (
NXOpen.VisualReporting.Condition
) – The condition - childCondition (
NXOpen.VisualReporting.Condition
) – The child condition being removed
New in version NX8.0.0.
License requirements: None.
- condition (
DeleteGroupLabel¶
-
VisualReportBuilder.
DeleteGroupLabel
¶ Deletes the given
NXOpen.VisualReporting.GroupLabel
from the activeNXOpen.VisualReporting.Classifier
in thisNXOpen.VisualReporting.Rule
.Signature
DeleteGroupLabel(rule, groupLabel)
Parameters: - rule (
NXOpen.VisualReporting.Rule
) – The rule containing the group label - groupLabel (
NXOpen.VisualReporting.GroupLabel
) – The group label
New in version NX7.0.0.
License requirements: None.
- rule (
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 deletedNew 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 ifNXOpen.VisualReporting.VisualReportBuilder.CommitAsCopy()
is called, the copiedNXOpen.VisualReporting.VisualReport
will be added to theNXOpen.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 reportNew in version NX7.0.0.
License requirements: None.
EnableUnmatchedGroupOfVisualReport¶
-
VisualReportBuilder.
EnableUnmatchedGroupOfVisualReport
¶ Sets whether use of
NXOpen.VisualReporting.VisualReport.UnmatchedGroupLabel()
is enabled for theNXOpen.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 thisNXOpen.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 thisNXOpen.VisualReporting.Rule
.Signature
GetAllGroupLabelsOfRule(rule)
Parameters: rule ( NXOpen.VisualReporting.Rule
) – The ruleReturns: 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 labelReturns: 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 thisNXOpen.VisualReporting.Condition
Signature
GetChildCondition(condition, index)
Parameters: - condition (
NXOpen.VisualReporting.Condition
) – - index (int) – The index of the returned Condition.
Returns: Return type: New in version NX8.0.0.
License requirements: None.
- condition (
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 activeNXOpen.VisualReporting.Classifier
in thisNXOpen.VisualReporting.Rule
.Signature
GetClassifierTypeOfRule(rule)
Parameters: rule ( NXOpen.VisualReporting.Rule
) – The ruleReturns: 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 givenNXOpen.VisualReporting.GroupLabel
.Signature
GetColorOfGroupLabel(groupLabel)
Parameters: groupLabel ( NXOpen.VisualReporting.GroupLabel
) – The group labelReturns: 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 labelReturns: 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 activeNXOpen.VisualReporting.Classifier
in the givenNXOpen.VisualReporting.Rule
.Only valid if the active
NXOpen.VisualReporting.Classifier
in the rule isNXOpen.VisualReporting.ClassifierTypeOption.Range
type.Signature
GetDateGroupMethodOfRule(rule)
Parameters: rule ( NXOpen.VisualReporting.Rule
) – The ruleReturns: 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 specifiedNXOpen.VisualReporting.Condition
.Only valid for a
NXOpen.VisualReporting.Condition
whoseNXOpen.VisualReporting.Condition.Type()
isNXOpen.VisualReporting.ConditionTypeOption.ValueCondition
Signature
GetDescriptionOfCondition(condition)
Parameters: condition ( NXOpen.VisualReporting.Condition
) – The conditionReturns: The description Return type: str New in version NX8.0.0.
License requirements: None.
GetDisplayStyleForGroupLabel¶
-
VisualReportBuilder.
GetDisplayStyleForGroupLabel
¶ Gets the
NXOpen.VisualReporting.GroupLabelDisplayStyleOption
of the givenNXOpen.VisualReporting.GroupLabel
Signature
GetDisplayStyleForGroupLabel(groupLabel)
Parameters: groupLabel ( NXOpen.VisualReporting.GroupLabel
) – The group labelReturns: 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 labelReturns: 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 ruleReturns: 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 activeNXOpen.VisualReporting.Classifier
in thisNXOpen.VisualReporting.Rule
.Signature
GetGroupingMethodOfRule(rule)
Parameters: rule ( NXOpen.VisualReporting.Rule
) – The ruleReturns: 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 specifiedNXOpen.VisualReporting.Condition
.Only valid for a
NXOpen.VisualReporting.Condition
whoseNXOpen.VisualReporting.Condition.Type()
isNXOpen.VisualReporting.ConditionTypeOption.ValueCondition
Signature
GetHasUserSpecifiedValueForCondition(condition)
Parameters: condition ( NXOpen.VisualReporting.Condition
) – The conditionReturns: 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 givenNXOpen.VisualReporting.GroupLabel
.Signature
GetLowerBoundOfGroupLabel(groupLabel)
Parameters: groupLabel ( NXOpen.VisualReporting.GroupLabel
) – The group labelReturns: 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 thisNXOpen.VisualReporting.Rule
which are manually defined.Signature
GetManualGroupLabelOfRule(rule, index)
Parameters: - rule (
NXOpen.VisualReporting.Rule
) – The rule - index (int) –
Returns: The specified manually defined group
Return type: New in version NX8.0.0.
License requirements: None.
- rule (
GetManualGroupLabelsOfRule¶
-
VisualReportBuilder.
GetManualGroupLabelsOfRule
¶ Returns the
NXOpen.VisualReporting.GroupLabel`s associated with the active :py:class:`NXOpen.VisualReporting.Classifier
in thisNXOpen.VisualReporting.Rule
which are manually defined.Signature
GetManualGroupLabelsOfRule(rule)
Parameters: rule ( NXOpen.VisualReporting.Rule
) – The ruleReturns: 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 activeNXOpen.VisualReporting.Classifier
in thisNXOpen.VisualReporting.Rule
isNXOpen.VisualReporting.ClassifierGroupingMethodOption.Manual
.Signature
GetManualGroupingForRule(rule)
Parameters: rule ( NXOpen.VisualReporting.Rule
) – The ruleReturns: 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 theNXOpen.VisualReporting.VisualReport
isNXOpen.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
isNXOpen.VisualReporting.ConditionTypeOption.ValueCondition
Signature
GetOperatorTypeOfCondition(condition)
Parameters: condition ( NXOpen.VisualReporting.Condition
) – The conditionReturns: 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 thisNXOpen.VisualReporting.Condition
.Signature
GetPropertyForComparison(condition)
Parameters: condition ( NXOpen.VisualReporting.Condition
) – The conditionReturns: 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
whoseNXOpen.VisualReporting.Condition.Type()
isNXOpen.VisualReporting.ConditionTypeOption.ValueCondition
Signature
GetPropertyOfCondition(condition)
Parameters: condition ( NXOpen.VisualReporting.Condition
) – The conditionReturns: 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 askReturns: a tuple Return type: A tuple consisting of (propertyType, key, name). propertyType is a NXOpen.VisualReporting.PropertyTypeOption
. Property Type of theNXOpen.VisualReporting.Property
key is a str. property key name is a str. property nameNew in version NX8.0.0.
License requirements: None.
GetRangeMethodOfRule¶
-
VisualReportBuilder.
GetRangeMethodOfRule
¶ Gets the
NXOpen.VisualReporting.ClassifierRangeMethodOption
of the activeNXOpen.VisualReporting.Classifier
in the givenNXOpen.VisualReporting.Rule
.Only valid if the active
NXOpen.VisualReporting.Classifier
in the rule isNXOpen.VisualReporting.ClassifierTypeOption.Range
type.Signature
GetRangeMethodOfRule(rule)
Parameters: rule ( NXOpen.VisualReporting.Rule
) – The ruleReturns: 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 theNXOpen.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 ofNXOpen.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 theNXOpen.VisualReporting.Property
in the activeNXOpen.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 ofNXOpen.VisualReporting.VisualReportBuilderPropertyUsageOption
. The usagesNew in version NX8.0.0.
License requirements: None.
GetReportingDatatypeOfRule¶
-
VisualReportBuilder.
GetReportingDatatypeOfRule
¶ Gets the
NXOpen.VisualReporting.PropertyDatatypeOption
of the activeNXOpen.VisualReporting.Classifier
’s reportingNXOpen.VisualReporting.Property
in thisNXOpen.VisualReporting.Rule
.Signature
GetReportingDatatypeOfRule(rule)
Parameters: rule ( NXOpen.VisualReporting.Rule
) – The ruleReturns: 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 activeNXOpen.VisualReporting.Classifier
in thisNXOpen.VisualReporting.Rule
.Signature
GetReportingPropertyOfRule(rule)
Parameters: rule ( NXOpen.VisualReporting.Rule
) – The ruleReturns: 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 theNXOpen.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 labelReturns: 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 givenNXOpen.VisualReporting.GroupLabel
.Signature
GetUpperBoundOfGroupLabel(groupLabel)
Parameters: groupLabel ( NXOpen.VisualReporting.GroupLabel
) – The group labelReturns: 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 givenNXOpen.VisualReporting.GroupLabel
.Signature
GetUserNameOfGroupLabel(groupLabel)
Parameters: groupLabel ( NXOpen.VisualReporting.GroupLabel
) – The group labelReturns: 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 specifiedNXOpen.VisualReporting.Condition
.Only valid for a
NXOpen.VisualReporting.Condition
whoseNXOpen.VisualReporting.Condition.Type()
isNXOpen.VisualReporting.ConditionTypeOption.ValueCondition
Signature
GetUserPromptOfCondition(condition)
Parameters: condition ( NXOpen.VisualReporting.Condition
) – The conditionReturns: 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
whoseNXOpen.VisualReporting.Condition.Type()
isNXOpen.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 givenNXOpen.VisualReporting.GroupLabel
.Signature
GetValueOfGroupLabel(groupLabel)
Parameters: groupLabel ( NXOpen.VisualReporting.GroupLabel
) – The group labelReturns: 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 conditionSignature
IsChildCondition(condition, childCondition)
Parameters: - condition (
NXOpen.VisualReporting.Condition
) – - childCondition (
NXOpen.VisualReporting.Condition
) – The possible child Condition
Returns: Return type: bool
New in version NX8.0.0.
License requirements: None.
- condition (
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: - condition (
NXOpen.VisualReporting.Condition
) – The condition - childCondition (
NXOpen.VisualReporting.Condition
) – The child condition being removed
New in version NX7.0.0.
License requirements: None.
- condition (
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 ruleNew 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 conditionNew in version NX7.0.0.
License requirements: None.
Save¶
-
VisualReportBuilder.
Save
¶ Saves the
NXOpen.VisualReporting.VisualReport
to its currentNXOpen.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 thisNXOpen.VisualReporting.Rule
for a multiple properties report.Signature
SetActiveClassifierOfRule(rule, activeClassifier)
Parameters: - rule (
NXOpen.VisualReporting.Rule
) – - activeClassifier (
NXOpen.VisualReporting.Classifier
) –
New in version NX8.0.0.
License requirements: None.
- rule (
SetBitmapNameOfGroupLabel¶
-
VisualReportBuilder.
SetBitmapNameOfGroupLabel
¶ Sets the bitmap of the given
NXOpen.VisualReporting.GroupLabel
.Signature
SetBitmapNameOfGroupLabel(groupLabel, bitmapName)
Parameters: - groupLabel (
NXOpen.VisualReporting.GroupLabel
) – The group label - bitmapName (str) – The bitmap name
New in version NX8.0.0.
License requirements: None.
- groupLabel (
SetClassifierTypeOfRule¶
-
VisualReportBuilder.
SetClassifierTypeOfRule
¶ Sets the reporting
NXOpen.VisualReporting.ClassifierTypeOption
for the activeNXOpen.VisualReporting.Classifier
in thisNXOpen.VisualReporting.Rule
.Note that the old
NXOpen.VisualReporting.Classifier
in thisNXOpen.VisualReporting.Rule
will be deleted and a newNXOpen.VisualReporting.Classifier
will be created and set as the activeNXOpen.VisualReporting.Classifier
in thisNXOpen.VisualReporting.Rule
.Signature
SetClassifierTypeOfRule(rule, classifierType)
Parameters: - rule (
NXOpen.VisualReporting.Rule
) – The rule - classifierType (
NXOpen.VisualReporting.ClassifierTypeOption
) – The classifier type being set
Returns: The new active classifier
Return type: New in version NX8.0.0.
License requirements: None.
- rule (
SetColorOfGroupLabel¶
-
VisualReportBuilder.
SetColorOfGroupLabel
¶ Sets the
NXOpen.VisualReporting.GroupLabel.Color()
of the givenNXOpen.VisualReporting.GroupLabel
.This also changes
NXOpen.VisualReporting.GroupLabel.DisplayStyle()
toNXOpen.VisualReporting.GroupLabelDisplayStyleOption.SpecifiedColor
.Signature
SetColorOfGroupLabel(groupLabel, color)
Parameters: - groupLabel (
NXOpen.VisualReporting.GroupLabel
) – The group label - color (
NXOpen.NXColorRgb_Struct
) – The color
New in version NX7.0.0.
License requirements: None.
- groupLabel (
SetCustomMessageOfGroupLabel¶
-
VisualReportBuilder.
SetCustomMessageOfGroupLabel
¶ Sets the custom message of the given
NXOpen.VisualReporting.GroupLabel
.Signature
SetCustomMessageOfGroupLabel(groupLabel, customMessage)
Parameters: - groupLabel (
NXOpen.VisualReporting.GroupLabel
) – The group label - customMessage (str) – The bitmap name
New in version NX8.0.0.
License requirements: None.
- groupLabel (
SetDateGroupMethodOfRule¶
-
VisualReportBuilder.
SetDateGroupMethodOfRule
¶ Sets the
NXOpen.VisualReporting.ClassifierDateGroupMethodOption
of the activeNXOpen.VisualReporting.Classifier
in the givenNXOpen.VisualReporting.Rule
.Only valid if the active
NXOpen.VisualReporting.Classifier
in the rule isNXOpen.VisualReporting.ClassifierTypeOption.Range
type.Signature
SetDateGroupMethodOfRule(rule, dateGroupMethod)
Parameters: - rule (
NXOpen.VisualReporting.Rule
) – The rule - dateGroupMethod (
NXOpen.VisualReporting.ClassifierDateGroupMethodOption
) – The range method
New in version NX8.0.1.
License requirements: None.
- rule (
SetDescriptionOfCondition¶
-
VisualReportBuilder.
SetDescriptionOfCondition
¶ Sets the
NXOpen.VisualReporting.Condition.Description()
of the specifiedNXOpen.VisualReporting.Condition
.Only valid for a
NXOpen.VisualReporting.Condition
whoseNXOpen.VisualReporting.Condition.Type()
isNXOpen.VisualReporting.ConditionTypeOption.ValueCondition
Signature
SetDescriptionOfCondition(condition, description)
Parameters: - condition (
NXOpen.VisualReporting.Condition
) – The condition - description (str) – The description
New in version NX7.0.0.
License requirements: None.
- condition (
SetDisplayStyleForGroupLabel¶
-
VisualReportBuilder.
SetDisplayStyleForGroupLabel
¶ Sets the
NXOpen.VisualReporting.GroupLabelDisplayStyleOption
of the givenNXOpen.VisualReporting.GroupLabel
Signature
SetDisplayStyleForGroupLabel(groupLabel, displayStyle)
Parameters: - groupLabel (
NXOpen.VisualReporting.GroupLabel
) – The group label - displayStyle (
NXOpen.VisualReporting.GroupLabelDisplayStyleOption
) – The display style
New in version NX8.0.0.
License requirements: None.
- groupLabel (
SetErrorLevelOfGroupLabel¶
-
VisualReportBuilder.
SetErrorLevelOfGroupLabel
¶ Sets the priority of the given:py:class:NXOpen.VisualReporting.GroupLabel.
Signature
SetErrorLevelOfGroupLabel(groupLabel, errorLevel)
Parameters: - groupLabel (
NXOpen.VisualReporting.GroupLabel
) – The group label - errorLevel (
NXOpen.ValidationResult
) – The error level
New in version NX12.0.0.
License requirements: None.
- groupLabel (
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 replacementNXOpen.VisualReporting.Condition
being set by this call).Signature
SetFilterConditionOfRule(rule, filterCondition)
Parameters: - rule (
NXOpen.VisualReporting.Rule
) – The rule - filterCondition (
NXOpen.VisualReporting.Condition
) – The filter condition being set
New in version NX7.0.0.
License requirements: None.
- rule (
SetGroupingMethodOfRule¶
-
VisualReportBuilder.
SetGroupingMethodOfRule
¶ Sets the
NXOpen.VisualReporting.ClassifierGroupingMethodOption
of the activeNXOpen.VisualReporting.Classifier
in the givenNXOpen.VisualReporting.Rule
.If the active
NXOpen.VisualReporting.Classifier
uses manual grouping then noNXOpen.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: - rule (
NXOpen.VisualReporting.Rule
) – The rule - groupingMethod (
NXOpen.VisualReporting.ClassifierGroupingMethodOption
) – The grouping method
New in version NX8.0.0.
License requirements: None.
- rule (
SetHasUserSpecifiedValueForCondition¶
-
VisualReportBuilder.
SetHasUserSpecifiedValueForCondition
¶ Sets
NXOpen.VisualReporting.Condition.HasUserSpecifiedValue()
on the specifiedNXOpen.VisualReporting.Condition
.Only valid for a
NXOpen.VisualReporting.Condition
whoseNXOpen.VisualReporting.Condition.Type()
isNXOpen.VisualReporting.ConditionTypeOption.ValueCondition
Signature
SetHasUserSpecifiedValueForCondition(condition, isUserSpecified)
Parameters: - condition (
NXOpen.VisualReporting.Condition
) – The condition - isUserSpecified (bool) – Whether the condition’s value should be user-specified
New in version NX7.0.0.
License requirements: None.
- condition (
SetLowerBoundOfGroupLabel¶
-
VisualReportBuilder.
SetLowerBoundOfGroupLabel
¶ Sets the
NXOpen.VisualReporting.GroupLabel.LowerBound()
of the givenNXOpen.VisualReporting.GroupLabel
.Signature
SetLowerBoundOfGroupLabel(groupLabel, lowerBound)
Parameters: - groupLabel (
NXOpen.VisualReporting.GroupLabel
) – The group label - lowerBound (str) – The lower bound
New in version NX8.0.0.
License requirements: None.
- groupLabel (
SetManualGroupingForRule¶
-
VisualReportBuilder.
SetManualGroupingForRule
¶ Sets whether the
NXOpen.VisualReporting.ClassifierGroupingMethodOption
of the activeNXOpen.VisualReporting.Classifier
in thisNXOpen.VisualReporting.Rule
isNXOpen.VisualReporting.ClassifierGroupingMethodOption.Manual
.If it uses
NXOpen.VisualReporting.ClassifierGroupingMethodOption.Manual
, then noNXOpen.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: - rule (
NXOpen.VisualReporting.Rule
) – The rule - isManualGrouping (bool) – Whether manual grouping should be used
New in version NX7.0.0.
License requirements: None.
- rule (
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 theNXOpen.VisualReporting.VisualReport
isNXOpen.VisualReporting.VisualReportScopeTypeOption.SubPart
type.Signature
SetObjectTypesOfVisualReport(objectTypes)
Parameters: objectTypes (list of NXOpen.VisualReporting.VisualReportObjectTypeOption
) – The object types being setNew 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
isNXOpen.VisualReporting.ConditionTypeOption.ValueCondition
Signature
SetOperatorTypeOfCondition(condition, operatorType)
Parameters: - condition (
NXOpen.VisualReporting.Condition
) – The condition - operatorType (
NXOpen.VisualReporting.ConditionOperatorOption
) – The operator type being set
New in version NX7.0.0.
License requirements: None.
- condition (
SetPropertyForComparison¶
-
VisualReportBuilder.
SetPropertyForComparison
¶ Sets the
NXOpen.VisualReporting.Property
in the value for comparison of thisNXOpen.VisualReporting.Condition
.If the
NXOpen.VisualReporting.Property
is set to None, then it is deleted.Signature
SetPropertyForComparison(condition, property)
Parameters: - condition (
NXOpen.VisualReporting.Condition
) – The condition - property (
NXOpen.VisualReporting.Property
) – The property being set
New in version NX8.0.0.
License requirements: None.
- condition (
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 aNXOpen.VisualReporting.Condition
whoseNXOpen.VisualReporting.Condition.Type()
isNXOpen.VisualReporting.ConditionTypeOption.ValueCondition
Signature
SetPropertyOfCondition(condition, property)
Parameters: - condition (
NXOpen.VisualReporting.Condition
) – The condition - property (
NXOpen.VisualReporting.Property
) – The property being set
New in version NX7.0.0.
License requirements: None.
- condition (
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: - property (
NXOpen.VisualReporting.Property
) – The property being set - key (str) – property key
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: - property (
NXOpen.VisualReporting.Property
) – The property being set - key (str) – property key
- name (str) – property name
New in version NX8.0.0.
License requirements: None.
-------------------------------------
SetRangeMethodOfRule¶
-
VisualReportBuilder.
SetRangeMethodOfRule
¶ Sets the
NXOpen.VisualReporting.ClassifierRangeMethodOption
of the activeNXOpen.VisualReporting.Classifier
in the givenNXOpen.VisualReporting.Rule
.Only valid if the active
NXOpen.VisualReporting.Classifier
in the rule isNXOpen.VisualReporting.ClassifierTypeOption.Range
type.Signature
SetRangeMethodOfRule(rule, rangeMethod)
Parameters: - rule (
NXOpen.VisualReporting.Rule
) – The rule - rangeMethod (
NXOpen.VisualReporting.ClassifierRangeMethodOption
) – The range method
New in version NX8.0.0.
License requirements: None.
- rule (
SetReferencePropertiesOfReport¶
-
VisualReportBuilder.
SetReferencePropertiesOfReport
¶ Sets the message
NXOpen.VisualReporting.Property
list of theNXOpen.VisualReporting.VisualReport
.Signature
SetReferencePropertiesOfReport(properties, usages)
Parameters: - properties (list of
NXOpen.VisualReporting.Property
) – The reference properties of report - usages (list of
NXOpen.VisualReporting.VisualReportBuilderPropertyUsageOption
) – The usages of report
New in version NX8.0.0.
License requirements: None.
- properties (list of
SetReferencePropertiesOfReportingProperty¶
-
VisualReportBuilder.
SetReferencePropertiesOfReportingProperty
¶ Sets the message
NXOpen.VisualReporting.Property
list of theNXOpen.VisualReporting.Property
in the activeNXOpen.VisualReporting.Classifier
.Signature
SetReferencePropertiesOfReportingProperty(properties, usages)
Parameters: - properties (list of
NXOpen.VisualReporting.Property
) – The reference properties of property - usages (list of
NXOpen.VisualReporting.VisualReportBuilderPropertyUsageOption
) – The usages
New in version NX8.0.0.
License requirements: None.
- properties (list of
SetReportingDatatypeOfRule¶
-
VisualReportBuilder.
SetReportingDatatypeOfRule
¶ Sets the
NXOpen.VisualReporting.PropertyDatatypeOption
of the activeNXOpen.VisualReporting.Classifier
’s reportingNXOpen.VisualReporting.Property
in thisNXOpen.VisualReporting.Rule
.However datatype must not be
NXOpen.VisualReporting.PropertyDatatypeOption.Unknown
.Signature
SetReportingDatatypeOfRule(rule, datatype)
Parameters: - rule (
NXOpen.VisualReporting.Rule
) – The rule - datatype (
NXOpen.VisualReporting.PropertyDatatypeOption
) – The datatype being set
New in version NX7.0.0.
License requirements: None.
- rule (
SetReportingPropertyOfRule¶
-
VisualReportBuilder.
SetReportingPropertyOfRule
¶ Sets the reporting
NXOpen.VisualReporting.Property
for the activeNXOpen.VisualReporting.Classifier
in thisNXOpen.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 thisNXOpen.VisualReporting.Rule
whoseNXOpen.VisualReporting.ClassifierTypeOption
isNXOpen.VisualReporting.ClassifierTypeOption.Value
orNXOpen.VisualReporting.ClassifierTypeOption.Range
.Signature
SetReportingPropertyOfRule(rule, reportingProperty)
Parameters: - rule (
NXOpen.VisualReporting.Rule
) – The rule - reportingProperty (
NXOpen.VisualReporting.Property
) – The property being set
New in version NX7.0.0.
License requirements: None.
- rule (
SetTagPriorityOfGroupLabel¶
-
VisualReportBuilder.
SetTagPriorityOfGroupLabel
¶ Sets the priority of the given:py:class:NXOpen.VisualReporting.GroupLabel.
Signature
SetTagPriorityOfGroupLabel(groupLabel, tagPriority)
Parameters: - groupLabel (
NXOpen.VisualReporting.GroupLabel
) – The group label - tagPriority (
NXOpen.VisualReporting.GroupLabelTagPriorityOption
) – The priority
New in version NX8.0.0.
License requirements: None.
- groupLabel (
SetUpperBoundOfGroupLabel¶
-
VisualReportBuilder.
SetUpperBoundOfGroupLabel
¶ Sets the
NXOpen.VisualReporting.GroupLabel.UpperBound()
of the givenNXOpen.VisualReporting.GroupLabel
.Signature
SetUpperBoundOfGroupLabel(groupLabel, upperBound)
Parameters: - groupLabel (
NXOpen.VisualReporting.GroupLabel
) – The group label - upperBound (str) – The upper bound
New in version NX8.0.0.
License requirements: None.
- groupLabel (
SetUserNameOfGroupLabel¶
-
VisualReportBuilder.
SetUserNameOfGroupLabel
¶ Sets the
NXOpen.NXObject.Name()
of the givenNXOpen.VisualReporting.GroupLabel
.Calling this function will cause
NXOpen.VisualReporting.GroupLabel.IsNameUserSpecified()
to return true.Signature
SetUserNameOfGroupLabel(groupLabel, name)
Parameters: - groupLabel (
NXOpen.VisualReporting.GroupLabel
) – The group label - name (str) – The name
New in version NX7.0.0.
License requirements: None.
- groupLabel (
SetUserPromptOfCondition¶
-
VisualReportBuilder.
SetUserPromptOfCondition
¶ Sets the
NXOpen.VisualReporting.Condition.UserPrompt()
of the specifiedNXOpen.VisualReporting.Condition
.Only valid for a
NXOpen.VisualReporting.Condition
whoseNXOpen.VisualReporting.Condition.Type()
isNXOpen.VisualReporting.ConditionTypeOption.ValueCondition
Signature
SetUserPromptOfCondition(condition, userPrompt)
Parameters: - condition (
NXOpen.VisualReporting.Condition
) – The condition - userPrompt (str) – The user-prompt
New in version NX7.0.0.
License requirements: None.
- condition (
SetValueOfCondition¶
-
VisualReportBuilder.
SetValueOfCondition
¶ Sets the value of this
NXOpen.VisualReporting.Condition
.Only valid for a
NXOpen.VisualReporting.Condition
whoseNXOpen.VisualReporting.Condition.Type()
isNXOpen.VisualReporting.ConditionTypeOption.ValueCondition
Signature
SetValueOfCondition(condition, value)
Parameters: - condition (
NXOpen.VisualReporting.Condition
) – - value (str) –
New in version NX8.0.0.
License requirements: None.
- condition (
SetValueOfGroupLabel¶
-
VisualReportBuilder.
SetValueOfGroupLabel
¶ Sets the
NXOpen.VisualReporting.GroupLabel.Value()
of the givenNXOpen.VisualReporting.GroupLabel
.Signature
SetValueOfGroupLabel(groupLabel, value)
Parameters: - groupLabel (
NXOpen.VisualReporting.GroupLabel
) – The group label - value (str) – The value
New in version NX7.0.0.
License requirements: None.
- groupLabel (
UnsetUserNameOfGroupLabel¶
-
VisualReportBuilder.
UnsetUserNameOfGroupLabel
¶ Resets the
NXOpen.VisualReporting.GroupLabel.IsNameUserSpecified()
status of the givenNXOpen.VisualReporting.GroupLabel
so that the name is now system-generated.Signature
UnsetUserNameOfGroupLabel(groupLabel)
Parameters: groupLabel ( NXOpen.VisualReporting.GroupLabel
) – The group labelNew 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.