PlotColorsWidthsBuilder Class

class NXOpen.PlotColorsWidthsBuilder

Bases: NXOpen.NXObject

Represents a NXOpen.PlotColorsWidthsBuilder to be used for plotting.

The PlotColorsWidthsBuilder class maintains all colors and widths data, which will be used by the PlotBuilder. If the color option is set to Custom Palette or Colors By Width, the PlotBuilder will translate the CDF object maintained by PlotColorsWidthsBuilder in order to plot with the user-defined colors. If the width option is set to Single Width, Custom Three Width, or Custom Palette, the PlotBuilder will translate the WidthDefinition object maintained by PlotColorsWidthsBuilder in order to plot with the user-defined widths.

New in version NX5.0.0.

Properties

Property	Description
Colors	Returns or sets the color option to be used when plotting.
IsOccurrence	Returns whether this object is an occurrence or not.
JournalIdentifier	Returns the identifier that would be recorded in a journal for this object.
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.
UseDrawingSheetColors	Returns or sets the use drawing sheet colors.
UseDrawingSheetWidths	Returns or sets the use drawing sheet widths.
Widths	Returns or sets the width option.

Methods

Method	Description
CreateAttributeIterator	Create an attribute iterator
CreateCdf	Creates and returns a NXOpen.CDF object representing the Color Palette.
CreateWidthDefinition	Creates and returns a NXOpen.WidthDefinition object representing the Width Palette.
DefinePalette	Initialize the Color Palette.
DefineWidths	Initialize the Width dialog.
DeleteAllAttributesByType	Deletes all attributes of a specific type.
DeleteAttributeByTypeAndTitle	Deletes an attribute by type and title.
DeleteColors	Delete drawing sheet colors
DeleteUserAttribute	Deletes the first attribute encountered with the given Type, Title.
DeleteUserAttributes	Deletes the attributes on the object, if any, that satisfy the given iterator
DeleteWidths	Delete drawing sheet widths
EditColors	Edit drawing sheet colors
EditWidths	Edit drawing sheet widths
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.
GetCdf	Returns a NXOpen.CDF object representing the Color Palette.
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.
GetNextUserAttribute	Gets the next attribute encountered on the object, if any, that satisfies the given iterator.
GetPdmReferenceAttributeValue	Gets the value of PDM Reference attribute for given object.
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, that satisfy the given iterator.
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, if any, that satisfy the given iterator.
GetUserAttributesAsStrings	Gets all the attributes that have been set on the given object.
GetWidthDefinition	Returns a NXOpen.WidthDefinition object representing the Width Palette.
HasUserAttribute	Determines if an attribute exists on the object, that satisfies the given iterator
Print	Prints a representation of this object to the system log file.
ResetColors	Reset drawing sheet colors
ResetWidths	Reset drawing sheet widths
RetrieveColors	Retrieve drawing sheet colors
RetrieveWidths	Retrieve drawing sheet widths
SaveColors	Save drawing sheet colors
SaveWidths	Save drawing sheet widths
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.
SetPdmReferenceAttribute	Sets the value of PDM Reference attribute on 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

PlotColorsWidthsBuilderColor Enumeration	Specifies the color option to use when plotting.
PlotColorsWidthsBuilderWidth Enumeration	Specifies the primary selection of which type of width assignment to use.

Property Detail

Colors

PlotColorsWidthsBuilder.Colors

Returns or sets the color option to be used when plotting.

If the color option is set to Custom Palette or Colors By Width then the plotter will use the user defined color attributes belonging to the CDF object.

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

Getter Method

Signature Colors

Returns: Return type:NXOpen.PlotColorsWidthsBuilderColor

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature Colors

Parameters:colors (NXOpen.PlotColorsWidthsBuilderColor) –

New in version NX5.0.0.

License requirements: None.

IsOccurrence

PlotColorsWidthsBuilder.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

PlotColorsWidthsBuilder.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.

Name

PlotColorsWidthsBuilder.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

PlotColorsWidthsBuilder.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

PlotColorsWidthsBuilder.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

PlotColorsWidthsBuilder.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.

UseDrawingSheetColors

PlotColorsWidthsBuilder.UseDrawingSheetColors

Returns or sets the use drawing sheet colors.

When this option is set to true, the plotter will use the user-defined drawing sheet colors.

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

Getter Method

Signature UseDrawingSheetColors

Returns: Return type:bool

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature UseDrawingSheetColors

Parameters:useDrawingSheetColors (bool) –

New in version NX5.0.0.

License requirements: None.

UseDrawingSheetWidths

PlotColorsWidthsBuilder.UseDrawingSheetWidths

Returns or sets the use drawing sheet widths.

When this option is set to true, the plotter will use the user-defined drawing sheet widths.

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

Getter Method

Signature UseDrawingSheetWidths

Returns: Return type:bool

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature UseDrawingSheetWidths

Parameters:useDrawingSheetWidths (bool) –

New in version NX5.0.0.

License requirements: None.

Widths

PlotColorsWidthsBuilder.Widths

Returns or sets the width option.

If the width option is set to Single Width, Custom Three Widths, or Custom Palette then the plotter will use the user defined width attributes belonging to the WidthDefinition object.

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

Getter Method

Signature Widths

Returns: Return type:NXOpen.PlotColorsWidthsBuilderWidth

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature Widths

Parameters:widths (NXOpen.PlotColorsWidthsBuilderWidth) –

New in version NX5.0.0.

License requirements: None.

Method Detail

CreateCdf

PlotColorsWidthsBuilder.CreateCdf

Creates and returns a NXOpen.CDF object representing the Color Palette.

This object contains all custom color information to be used when Custom Palette or Colors By Width is selected from the Color option.

Signature CreateCdf()

Returns:CDF object Return type:NXOpen.CDF

New in version NX5.0.0.

License requirements: None.

CreateWidthDefinition

PlotColorsWidthsBuilder.CreateWidthDefinition

Creates and returns a NXOpen.WidthDefinition object representing the Width Palette.

This object contains all custom width information to be used when Single Width, Custom Three Widths, or Custom Palette is selected from the Width option.

Signature CreateWidthDefinition()

Returns:WidthDefinition object Return type:NXOpen.WidthDefinition

New in version NX5.0.0.

License requirements: None.

DefinePalette

PlotColorsWidthsBuilder.DefinePalette

Initialize the Color Palette.

This allows the user to change the attributes of any color. These changed colors will be used if Custom Palette or Colors By Width is selected as the color option.

Signature DefinePalette()

New in version NX5.0.0.

License requirements: None.

DefineWidths

PlotColorsWidthsBuilder.DefineWidths

Initialize the Width dialog.

This allows the user to change the attributes of Single Width, Custom Three Widths, or Custom Palette. These changed width values will be used depending on the width option selected.

Signature DefineWidths()

New in version NX5.0.0.

License requirements: None.

DeleteColors

PlotColorsWidthsBuilder.DeleteColors

Delete drawing sheet colors

Signature DeleteColors()

New in version NX5.0.0.

License requirements: None.

DeleteWidths

PlotColorsWidthsBuilder.DeleteWidths

Delete drawing sheet widths

Signature DeleteWidths()

New in version NX5.0.0.

License requirements: None.

EditColors

PlotColorsWidthsBuilder.EditColors

Edit drawing sheet colors

Signature EditColors()

New in version NX5.0.0.

License requirements: None.

EditWidths

PlotColorsWidthsBuilder.EditWidths

Edit drawing sheet widths

Signature EditWidths()

New in version NX5.0.0.

License requirements: None.

FindObject

PlotColorsWidthsBuilder.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.

GetCdf

PlotColorsWidthsBuilder.GetCdf

Returns a NXOpen.CDF object representing the Color Palette.

This object contains all custom color information to be used when Custom Palette or Colors By Width is selected from the Color option.

Signature GetCdf()

Returns:CDF object Return type:NXOpen.CDF

New in version NX5.0.0.

License requirements: None.

GetWidthDefinition

PlotColorsWidthsBuilder.GetWidthDefinition

Returns a NXOpen.WidthDefinition object representing the Width Palette.

This object contains all custom width information to be used when Single Width, Custom Three Widths, or Custom Palette is selected from the Width option.

Signature GetWidthDefinition()

Returns:WidthDefinition object Return type:NXOpen.WidthDefinition

New in version NX5.0.0.

License requirements: None.

Print

PlotColorsWidthsBuilder.Print

Prints a representation of this object to the system log file.

Signature Print()

New in version NX3.0.0.

License requirements: None.

ResetColors

PlotColorsWidthsBuilder.ResetColors

Reset drawing sheet colors

Signature ResetColors()

New in version NX5.0.0.

License requirements: None.

ResetWidths

PlotColorsWidthsBuilder.ResetWidths

Reset drawing sheet widths

Signature ResetWidths()

New in version NX5.0.0.

License requirements: None.

RetrieveColors

PlotColorsWidthsBuilder.RetrieveColors

Retrieve drawing sheet colors

Signature RetrieveColors()

New in version NX5.0.0.

License requirements: None.

RetrieveWidths

PlotColorsWidthsBuilder.RetrieveWidths

Retrieve drawing sheet widths

Signature RetrieveWidths()

New in version NX5.0.0.

License requirements: None.

SaveColors

PlotColorsWidthsBuilder.SaveColors

Save drawing sheet colors

Signature SaveColors()

New in version NX5.0.0.

License requirements: None.

SaveWidths

PlotColorsWidthsBuilder.SaveWidths

Save drawing sheet widths

Signature SaveWidths()

New in version NX5.0.0.

License requirements: None.

SetName

PlotColorsWidthsBuilder.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.