GroupLabel Class¶
-
class
NXOpen.VisualReporting.
GroupLabel
¶ Bases:
NXOpen.NXObject
A group label corresponds to a group of objects in the results of an applied
NXOpen.VisualReporting.VisualReport
.New in version NX7.0.0.
Properties¶
Property | Description |
---|---|
BitmapName | Returns or sets the bitmap name of this NXOpen.VisualReporting.GroupLabel . |
Color | Returns or sets the color of the NXOpen.VisualReporting.GroupLabel |
CustomMessage | Returns or sets the custom message of this NXOpen.VisualReporting.GroupLabel . |
DisplayStyle | Returns or sets the NXOpen.VisualReporting.GroupLabelDisplayStyleOption of the NXOpen.VisualReporting.GroupLabel |
IsManual | Returns or sets whether the NXOpen.VisualReporting.GroupLabel is manual. |
IsNameUserSpecified | Returns or sets whether the NXOpen.VisualReporting.GroupLabel has a user-specified NXOpen.NXObject.Name . |
IsOccurrence | Returns whether this object is an occurrence or not. |
JournalIdentifier | Returns the identifier that would be recorded in a journal for this object. |
LowerBound | Returns or sets the lower bound value of the NXOpen.VisualReporting.GroupLabel (if it is being grouped by range) |
Name | Returns the custom name of the object. |
OwningComponent | Returns the owning component, if this object is an occurrence. |
OwningPart | Returns the owning part of this object |
Prototype | Returns the prototype of this object if it is an occurrence. |
Tag | Returns the Tag for this object. |
TagPriority | Returns or sets the Tag Priority of this NXOpen.VisualReporting.GroupLabel . |
UpperBound | Returns or sets the upper bound value of the NXOpen.VisualReporting.GroupLabel (if it is being grouped by range) |
Value | Returns or sets the value of the NXOpen.VisualReporting.GroupLabel (if it is being grouped by value) |
Methods¶
Method | Description |
---|---|
DeleteAllAttributesByType | Deletes all attributes of a specific type. |
DeleteAttributeByTypeAndTitle | Deletes an attribute by type and title. |
DeleteUserAttribute | Deletes the first attribute encountered with the given Type, Title. |
DeleteUserAttributes | Deletes the attributes encountered with the given Type with option to update or not. |
FindObject | Finds the NXOpen.NXObject with the given identifier as recorded in a journal. |
GetAttributeTitlesByType | Gets all the attribute titles of a specific type. |
GetBooleanUserAttribute | Gets a boolean attribute by Title and array Index. |
GetComputationalTimeUserAttribute | Gets a time attribute by Title and array Index. |
GetIntegerAttribute | Gets an integer attribute by title. |
GetIntegerUserAttribute | Gets an integer attribute by Title and array Index. |
GetRealAttribute | Gets a real attribute by title. |
GetRealUserAttribute | Gets a real attribute by Title and array Index. |
GetReferenceAttribute | Gets the reference string (not the calculated value) of a string attribute that uses a reference string. |
GetStringAttribute | Gets a string attribute value by title. |
GetStringUserAttribute | Gets a string attribute by Title and array Index. |
GetTimeAttribute | Gets a time attribute by title. |
GetTimeUserAttribute | Gets a time attribute by Title and array Index. |
GetUserAttribute | Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. |
GetUserAttributeAsString | Gets the first attribute encountered on the object, if any, with a given title, type and array index. |
GetUserAttributeCount | Gets the count of set attributes on the object, if any, of the given type. |
GetUserAttributeLock | Determine the lock of the given attribute. |
GetUserAttributeSize | Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. |
GetUserAttributeSourceObjects | Returns an array of objects from which this object presents attributes. |
GetUserAttributes | Gets all the attributes that have been set on the given object. |
GetUserAttributesAsStrings | Gets all the attributes that have been set on the given object. |
HasUserAttribute | Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. |
Prints a representation of this object to the system log file. | |
SetAttribute | Creates or modifies an integer attribute. |
SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not. |
SetName | Sets the custom name of the object. |
SetReferenceAttribute | Creates or modifies a string attribute which uses a reference string. |
SetTimeAttribute | Creates or modifies a time attribute. |
SetTimeUserAttribute | Creates or modifies a time attribute with the option to update or not. |
SetUserAttribute | Creates or modifies an attribute with the option to update or not. |
SetUserAttributeLock | Lock or unlock the given attribute. |
Enumerations¶
GroupLabelDisplayStyleOption Enumeration | Represents the possible display style options for a NXOpen.VisualReporting.GroupLabel . |
GroupLabelTagPriorityOption Enumeration | Represents the possible priority options for a NXOpen.VisualReporting.GroupLabel . |
Property Detail¶
BitmapName¶
-
GroupLabel.
BitmapName
¶ Returns or sets the bitmap name of this
NXOpen.VisualReporting.GroupLabel
.-------------------------------------
Getter Method
Signature
BitmapName()
Returns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
BitmapName(bitmapName)
Parameters: bitmapName (str) – New in version NX8.0.0.
License requirements: nx_visual_reporting (“Visual Reporting”)
Color¶
-
GroupLabel.
Color
¶ Returns or sets the color of the
NXOpen.VisualReporting.GroupLabel
-------------------------------------
Getter Method
Signature
Color()
Returns: Return type: NXOpen.NXColorRgb_Struct
New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Color(color)
Parameters: color ( NXOpen.NXColorRgb_Struct
) –New in version NX7.5.0.
License requirements: nx_visual_reporting (“Visual Reporting”)
CustomMessage¶
-
GroupLabel.
CustomMessage
¶ Returns or sets the custom message of this
NXOpen.VisualReporting.GroupLabel
.-------------------------------------
Getter Method
Signature
CustomMessage()
Returns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CustomMessage(customMessage)
Parameters: customMessage (str) – New in version NX8.0.0.
License requirements: nx_visual_reporting (“Visual Reporting”)
DisplayStyle¶
-
GroupLabel.
DisplayStyle
¶ Returns or sets the
NXOpen.VisualReporting.GroupLabelDisplayStyleOption
of theNXOpen.VisualReporting.GroupLabel
-------------------------------------
Getter Method
Signature
DisplayStyle()
Returns: Return type: NXOpen.VisualReporting.GroupLabelDisplayStyleOption
New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DisplayStyle(displayStyle)
Parameters: displayStyle ( NXOpen.VisualReporting.GroupLabelDisplayStyleOption
) –New in version NX7.5.0.
License requirements: nx_visual_reporting (“Visual Reporting”)
IsManual¶
-
GroupLabel.
IsManual
¶ Returns or sets whether the
NXOpen.VisualReporting.GroupLabel
is manual.It is manual if it either has a user-specified
NXOpen.NXObject.Name
or if itsNXOpen.VisualReporting.GroupLabel.DisplayStyle
is notNXOpen.VisualReporting.GroupLabelDisplayStyleOption.AutomaticColor
. You can change aNXOpen.VisualReporting.GroupLabel
from automatic to manual, but you cannot changeNXOpen.VisualReporting.GroupLabel
from manual to automatic.-------------------------------------
Getter Method
Signature
IsManual()
Returns: Return type: bool New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsManual(isManual)
Parameters: isManual (bool) – New in version NX8.0.0.
License requirements: nx_visual_reporting (“Visual Reporting”)
IsNameUserSpecified¶
-
GroupLabel.
IsNameUserSpecified
¶ Returns or sets whether the
NXOpen.VisualReporting.GroupLabel
has a user-specifiedNXOpen.NXObject.Name
.If it isn’t user-specified, then the system will generate its name automatically.
-------------------------------------
Getter Method
Signature
IsNameUserSpecified()
Returns: Return type: bool New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsNameUserSpecified(isNameUserSpecified)
Parameters: isNameUserSpecified (bool) – New in version NX8.0.0.
License requirements: nx_visual_reporting (“Visual Reporting”)
IsOccurrence¶
-
GroupLabel.
IsOccurrence
¶ Returns whether this object is an occurrence or not.
-------------------------------------
Getter Method
Signature
IsOccurrence()
Returns: This object is an occurrence Return type: bool New in version NX3.0.0.
License requirements: None.
JournalIdentifier¶
-
GroupLabel.
JournalIdentifier
¶ Returns the identifier that would be recorded in a journal for this object.
This may not be the same across different releases of the software.
-------------------------------------
Getter Method
Signature
JournalIdentifier()
Returns: Return type: str New in version NX3.0.0.
License requirements: None.
LowerBound¶
-
GroupLabel.
LowerBound
¶ Returns or sets the lower bound value of the
NXOpen.VisualReporting.GroupLabel
(if it is being grouped by range)-------------------------------------
Getter Method
Signature
LowerBound()
Returns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LowerBound(fromValue)
Parameters: fromValue (str) – New in version NX8.0.0.
License requirements: nx_visual_reporting (“Visual Reporting”)
Name¶
-
GroupLabel.
Name
¶ Returns the custom name of the object.
-------------------------------------
Getter Method
Signature
Name()
Returns: Return type: str New in version NX3.0.0.
License requirements: None.
OwningComponent¶
-
GroupLabel.
OwningComponent
¶ Returns the owning component, if this object is an occurrence.
-------------------------------------
Getter Method
Signature
OwningComponent()
Returns: Return type: NXOpen.Assemblies.Component
New in version NX3.0.0.
License requirements: None.
OwningPart¶
-
GroupLabel.
OwningPart
¶ Returns the owning part of this object
-------------------------------------
Getter Method
Signature
OwningPart()
Returns: The owning part of this object or null if it does not have an owner Return type: NXOpen.BasePart
New in version NX3.0.0.
License requirements: None.
Prototype¶
-
GroupLabel.
Prototype
¶ Returns the prototype of this object if it is an occurrence.
-------------------------------------
Getter Method
Signature
Prototype()
Returns: The prototype of this object or null if this object is not an occurrence Return type: NXOpen.INXObject
New in version NX3.0.0.
License requirements: None.
TagPriority¶
-
GroupLabel.
TagPriority
¶ Returns or sets the Tag Priority of this
NXOpen.VisualReporting.GroupLabel
.-------------------------------------
Getter Method
Signature
TagPriority()
Returns: Return type: NXOpen.VisualReporting.GroupLabelTagPriorityOption
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TagPriority(tagPriority)
Parameters: tagPriority ( NXOpen.VisualReporting.GroupLabelTagPriorityOption
) –New in version NX8.0.0.
License requirements: nx_visual_reporting (“Visual Reporting”)
UpperBound¶
-
GroupLabel.
UpperBound
¶ Returns or sets the upper bound value of the
NXOpen.VisualReporting.GroupLabel
(if it is being grouped by range)-------------------------------------
Getter Method
Signature
UpperBound()
Returns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
UpperBound(upperBound)
Parameters: upperBound (str) – New in version NX8.0.0.
License requirements: nx_visual_reporting (“Visual Reporting”)
Value¶
-
GroupLabel.
Value
¶ Returns or sets the value of the
NXOpen.VisualReporting.GroupLabel
(if it is being grouped by value)-------------------------------------
Getter Method
Signature
Value()
Returns: Return type: str New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Value(groupLabelValue)
Parameters: groupLabelValue (str) – New in version NX8.0.0.
License requirements: nx_visual_reporting (“Visual Reporting”)
Method Detail¶
FindObject¶
-
GroupLabel.
FindObject
¶ Finds the
NXOpen.NXObject
with the given identifier as recorded in a journal.An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.
An exception will be thrown if no object can be found with the given journal identifier.
Signature
FindObject(journalIdentifier)
Parameters: journalIdentifier (str) – Journal identifier of the object Returns: Return type: NXOpen.INXObject
New in version NX3.0.0.
License requirements: None.
Print¶
-
GroupLabel.
Print
¶ Prints a representation of this object to the system log file.
Signature
Print()
New in version NX3.0.0.
License requirements: None.
SetName¶
-
GroupLabel.
SetName
¶ Sets the custom name of the object.
NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Signature
SetName(name)
Parameters: name (str) – New in version NX3.0.0.
License requirements: None.