PlotBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# PlotBuilder Class

class `NXOpen.``PlotBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.PlotBuilder`.

  This class contains all information relating to plotting. The user must specify the sheets to be plotted by setting the appropriate fields through the `NXOpen.PlotSourceBuilder`. For each sheet selected, a temporary CGM file name must be supplied. Once the sheets are selected, the user must set the plotter and profile fields. If the plotter selected is an image file (JPEG, TIFF, EMF, CGM, or PNG), then a graphic filename must also be supplied for each sheet selected. The PlotBuilder class also handles all Banner data and Manufacturing data to be used during plotting. This class is created using `NXOpen.PlotManager`.

  All sheets provided must be in the displayed part.

  To create a new instance of this class, use `NXOpen.PlotManager.CreatePlotBuilder()`

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
BannerMessage | Returns or sets the banner message.
CharacterSize | Returns or sets the character size of the banner.
ClsfData | Returns or sets the option to plot clsf data.
ColorsWidthsBuilder | Returns the Colors Widths builder.
Copies | Returns or sets the number of copies to be plotted.
CustomSymbolsInForeground | Returns or sets the plotting custom symbols in the foreground option.
DisplayBanner | Returns or sets the display banner.
ImageResolution | Returns or sets the resolution of images created for plotting shaded views.
JobName | Returns or sets the job name to be used for plotting.
Justification | Returns or sets the justification of the banner text.
PlotType | Returns or sets the type of plot.
PlotterText | Returns or sets the plotter text.
PrinterGroupText | Returns or sets the printer group text.
ProfileText | Returns or sets the profile text.
RasterImages | Returns or sets the raster images option.
Rotation | Returns or sets the rotation of the banner.
ShadedGeometry | Returns or sets the shaded geometry as wireframe option.
SourceBuilder | Returns the Source builder.
Tag | Returns the Tag for this object.
Tolerance | Returns or sets the plotting tolerance.
Units | Returns or sets the units used to create the banner.
XDisplay | Returns or sets the X coordinate of a banner.
XOffset | Returns or sets the X coordinate offset of a banner.
YDisplay | Returns or sets the Y coordinate of a banner.
YOffset | Returns or sets the Y coordinate offset of a banner.

# Methods

Method | Description
--- | ---
AddToPlotLayout | Add Plot to Layout.
AdvancedPlot | Initialize the SDI dialog.
ClearPlotLayout | Clear Plot from Layout.
Commit | Commits any edits that have been applied to the builder.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetFilenames | Gets all the temporary CGM filenames to be plotted.
GetGraphicFilenames | Gets all the Graphic filenames to be saved.
GetObject | Returns the object currently being edited by this builder.
SaveCgm | Saves the selected sheets as CGM files.
SetFilenames | Sets all the temporary CGM filenames to be plotted.
SetGraphicFilenames | Sets all the Graphic filenames to be saved.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

PlotBuilderImageResolutionOption Enumeration | Specifies the plot image resolution
PlotBuilderJustificationOption Enumeration | Specifies the justification of the banner
PlotBuilderPlotTypes Enumeration | Specifies the type of plot
PlotBuilderRotationOption Enumeration | Specifies the rotation of the banner
PlotBuilderUnitsOption Enumeration | Specifies which units are associated to the dimensions
PlotBuilderXdisplayOption Enumeration | Specifies the x-coordinate for the banner location
PlotBuilderYdisplayOption Enumeration | Specifies the y-coordinate for the banner location

# Property Detail

## BannerMessage

`PlotBuilder.``BannerMessage`

  Returns or sets the banner message.

  This text field will be added to the banner if Display Banner is set to true.

  `-------------------------------------`

  Getter Method

  Signature `BannerMessage`

  Returns: |
  Return type: | str

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `BannerMessage`

  Parameters: | bannerMessage (str) –

  New in version NX5.0.0.

  License requirements: None.

## CharacterSize

`PlotBuilder.``CharacterSize`

  Returns or sets the character size of the banner.

  If Display Banner is true, the character size value will be used to determine the size of the banner text.

  `-------------------------------------`

  Getter Method

  Signature `CharacterSize`

  Returns: |
  Return type: | float

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `CharacterSize`

  Parameters: | characterSize (float) –

  New in version NX5.0.0.

  License requirements: None.

## ClsfData

`PlotBuilder.``ClsfData`

  Returns or sets the option to plot clsf data.

  If clsf data is true, the current clsf data will be included in the plot.

  `-------------------------------------`

  Getter Method

  Signature `ClsfData`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ClsfData`

  Parameters: | clsfData (bool) –

  New in version NX5.0.0.

  License requirements: None.

## ColorsWidthsBuilder

`PlotBuilder.``ColorsWidthsBuilder`

  Returns the Colors Widths builder.

  The Colors Widths builder contains all information relating to both colors and widths.

  `-------------------------------------`

  Getter Method

  Signature `ColorsWidthsBuilder`

  Returns: | New ColorsWidthsBuilder object
  Return type: | `NXOpen.PlotColorsWidthsBuilder`

  New in version NX5.0.0.

  License requirements: None.

## Copies

`PlotBuilder.``Copies`

  Returns or sets the number of copies to be plotted.

  `-------------------------------------`

  Getter Method

  Signature `Copies`

  Returns: |
  Return type: | int

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Copies`

  Parameters: | copies (int) –

  New in version NX5.0.0.

  License requirements: None.

## CustomSymbolsInForeground

`PlotBuilder.``CustomSymbolsInForeground`

  Returns or sets the plotting custom symbols in the foreground option.

  Setting this option on will cause custom symbols to be plotted in the foreground. When this option is off, geometry may overlap custom symbols when plotted.

  `-------------------------------------`

  Getter Method

  Signature `CustomSymbolsInForeground`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `CustomSymbolsInForeground`

  Parameters: | customSymbolsInForeground (bool) –

  New in version NX11.0.0.

  License requirements: None.

## DisplayBanner

`PlotBuilder.``DisplayBanner`

  Returns or sets the display banner.

  If true, the specified banner options will be used in adding a banner to the plot. If false, no banner will be used to plot.

  `-------------------------------------`

  Getter Method

  Signature `DisplayBanner`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `DisplayBanner`

  Parameters: | displayBanner (bool) –

  New in version NX5.0.0.

  License requirements: None.

## ImageResolution

`PlotBuilder.``ImageResolution`

  Returns or sets the resolution of images created for plotting shaded views.

  `-------------------------------------`

  Getter Method

  Signature `ImageResolution`

  Returns: |
  Return type: | `NXOpen.PlotBuilderImageResolutionOption`

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ImageResolution`

  Parameters: | imageResolution (`NXOpen.PlotBuilderImageResolutionOption`) –

  New in version NX5.0.0.

  License requirements: None.

## JobName

`PlotBuilder.``JobName`

  Returns or sets the job name to be used for plotting.

  `-------------------------------------`

  Getter Method

  Signature `JobName`

  Returns: |
  Return type: | str

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `JobName`

  Parameters: | jobName (str) –

  New in version NX5.0.0.

  License requirements: None.

## Justification

`PlotBuilder.``Justification`

  Returns or sets the justification of the banner text.

  If Display Banner is true, the justification will be used to position the banner text. This can be set to Left Justify, Center Justify, or Right Justify.

  `-------------------------------------`

  Getter Method

  Signature `Justification`

  Returns: |
  Return type: | `NXOpen.PlotBuilderJustificationOption`

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Justification`

  Parameters: | justification (`NXOpen.PlotBuilderJustificationOption`) –

  New in version NX5.0.0.

  License requirements: None.

## PlotType

`PlotBuilder.``PlotType`

  Returns or sets the type of plot.

  This can be Standard or Plot Using a Layout.

  `-------------------------------------`

  Getter Method

  Signature `PlotType`

  Returns: |
  Return type: | `NXOpen.PlotBuilderPlotTypes`

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `PlotType`

  Parameters: | plotType (`NXOpen.PlotBuilderPlotTypes`) –

  New in version NX5.0.0.

  License requirements: None.

## PlotterText

`PlotBuilder.``PlotterText`

  Returns or sets the plotter text.

  The plotter field represents which plotter the user wishes to plot to, it can be an available printer or an image type (JPEG, CGM, TIFF, EMF, or PNG). If the plotter is a printer, then the appropriate printer group containing the chosen printer must also be set.

  `-------------------------------------`

  Getter Method

  Signature `PlotterText`

  Returns: |
  Return type: | str

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `PlotterText`

  Parameters: | plotter (str) –

  New in version NX5.0.0.

  License requirements: None.

## PrinterGroupText

`PlotBuilder.``PrinterGroupText`

  Returns or sets the printer group text.

  The printer group must be set if a printer is used as the plotter.

  `-------------------------------------`

  Getter Method

  Signature `PrinterGroupText`

  Returns: |
  Return type: | str

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `PrinterGroupText`

  Parameters: | printerGroup (str) –

  New in version NX5.0.0.

  License requirements: None.

## ProfileText

`PlotBuilder.``ProfileText`

  Returns or sets the profile text.

  The profile must be a valid SDI created profile associated with the current plotter.

  `-------------------------------------`

  Getter Method

  Signature `ProfileText`

  Returns: |
  Return type: | str

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ProfileText`

  Parameters: | profile (str) –

  New in version NX5.0.0.

  License requirements: None.

## RasterImages

`PlotBuilder.``RasterImages`

  Returns or sets the raster images option.

  This option determines whether or not raster images will be used when plotting.

  `-------------------------------------`

  Getter Method

  Signature `RasterImages`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `RasterImages`

  Parameters: | rasterImages (bool) –

  New in version NX5.0.0.

  License requirements: None.

## Rotation

`PlotBuilder.``Rotation`

  Returns or sets the rotation of the banner.

  This can be set to 0, 90, 180, or 270 and will determine the rotation of the banner if Display Banner is true.

  `-------------------------------------`

  Getter Method

  Signature `Rotation`

  Returns: |
  Return type: | `NXOpen.PlotBuilderRotationOption`

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Rotation`

  Parameters: | rotation (`NXOpen.PlotBuilderRotationOption`) –

  New in version NX5.0.0.

  License requirements: None.

## ShadedGeometry

`PlotBuilder.``ShadedGeometry`

  Returns or sets the shaded geometry as wireframe option.

  If set to true, this option will show shaded objects as wireframes. The shaded objects will be represented as shaded if this option is set to false.

  `-------------------------------------`

  Getter Method

  Signature `ShadedGeometry`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ShadedGeometry`

  Parameters: | shadedGeometry (bool) –

  New in version NX5.0.0.

  License requirements: None.

## SourceBuilder

`PlotBuilder.``SourceBuilder`

  Returns the Source builder.

  The Source builder contains all data involving the sheets to to be plotted.

  `-------------------------------------`

  Getter Method

  Signature `SourceBuilder`

  Returns: | New SourceBuilder object
  Return type: | `NXOpen.PlotSourceBuilder`

  New in version NX5.0.0.

  License requirements: None.

## Tolerance

`PlotBuilder.``Tolerance`

  Returns or sets the plotting tolerance.

  The tolerance is a unitless value that controls the accuracy or smoothness of plotted curve geometry. Values must be greater than or equal to 0.0001. Smaller values produce smoother curves.

  `-------------------------------------`

  Getter Method

  Signature `Tolerance`

  Returns: |
  Return type: | float

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Tolerance`

  Parameters: | tolerance (float) –

  New in version NX5.0.0.

  License requirements: None.

## Units

`PlotBuilder.``Units`

  Returns or sets the units used to create the banner.

  The units can be either English or Metric and they pertain to the X-offset, the Y-offset, and the character size when creating a banner.

  `-------------------------------------`

  Getter Method

  Signature `Units`

  Returns: |
  Return type: | `NXOpen.PlotBuilderUnitsOption`

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Units`

  Parameters: | units (`NXOpen.PlotBuilderUnitsOption`) –

  New in version NX5.0.0.

  License requirements: None.

## XDisplay

`PlotBuilder.``XDisplay`

  Returns or sets the X coordinate of a banner.

  If Display Banner is true, the X and Y coordinates will determine where the banner will appear when plotting. This can be set to Left, Center, or Right.

  `-------------------------------------`

  Getter Method

  Signature `XDisplay`

  Returns: |
  Return type: | `NXOpen.PlotBuilderXdisplayOption`

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `XDisplay`

  Parameters: | xDisplay (`NXOpen.PlotBuilderXdisplayOption`) –

  New in version NX5.0.0.

  License requirements: None.

## XOffset

`PlotBuilder.``XOffset`

  Returns or sets the X coordinate offset of a banner.

  If Display Banner is true, the X offset will be used as the offset value in combination with the X coordinate to determine where the banner will appear when plotting.

  `-------------------------------------`

  Getter Method

  Signature `XOffset`

  Returns: |
  Return type: | float

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `XOffset`

  Parameters: | xOffset (float) –

  New in version NX5.0.0.

  License requirements: None.

## YDisplay

`PlotBuilder.``YDisplay`

  Returns or sets the Y coordinate of a banner.

  If Display Banner is true, the X and Y coordinates will determine where the banner will appear when plotting. This can be set to Bottom, Center, or Top.

  `-------------------------------------`

  Getter Method

  Signature `YDisplay`

  Returns: |
  Return type: | `NXOpen.PlotBuilderYdisplayOption`

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `YDisplay`

  Parameters: | yDisplay (`NXOpen.PlotBuilderYdisplayOption`) –

  New in version NX5.0.0.

  License requirements: None.

## YOffset

`PlotBuilder.``YOffset`

  Returns or sets the Y coordinate offset of a banner.

  If Display Banner is true, the Y offset will be used as the offset value in combination with the Y coordinate to determine where the banner will appear when plotting.

  `-------------------------------------`

  Getter Method

  Signature `YOffset`

  Returns: |
  Return type: | float

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `YOffset`

  Parameters: | yOffset (float) –

  New in version NX5.0.0.

  License requirements: None.

# Method Detail

## AddToPlotLayout

`PlotBuilder.``AddToPlotLayout`

  Add Plot to Layout.

  This routine adds a sheet to the plot layout.

  Signature `AddToPlotLayout()`

  New in version NX5.0.0.

  License requirements: None.

## AdvancedPlot

`PlotBuilder.``AdvancedPlot`

  Initialize the SDI dialog.

  Signature `AdvancedPlot()`

  New in version NX5.0.0.

  License requirements: None.

## ClearPlotLayout

`PlotBuilder.``ClearPlotLayout`

  Clear Plot from Layout.

  This routine clears all sheets from the plot layout.

  Signature `ClearPlotLayout()`

  New in version NX5.0.0.

  License requirements: None.

## GetFilenames

`PlotBuilder.``GetFilenames`

  Gets all the temporary CGM filenames to be plotted.

  This list will contain the full path of the temporary CGM file to be used during plotting. This list must equal the number of sheets selected to plot and these files will be deleted after the plotting operation is finished.

  Signature `GetFilenames()`

  Returns: |
  Return type: | list of str

  New in version NX5.0.0.

  License requirements: None.

## GetGraphicFilenames

`PlotBuilder.``GetGraphicFilenames`

  Gets all the Graphic filenames to be saved.

  If the plotter selected is an image type (JPEG, CGM, TIFF, EMF, or PNG) then the graphic filenames text list will contain the full path of where these images will be saved to disk. This list must equal the number of sheets selected to plot.

  Signature `GetGraphicFilenames()`

  Returns: |
  Return type: | list of str

  New in version NX5.0.0.

  License requirements: None.

## SaveCgm

`PlotBuilder.``SaveCgm`

  Saves the selected sheets as CGM files.

  Signature `SaveCgm()`

  New in version NX5.0.0.

  License requirements: None.

## SetFilenames

`PlotBuilder.``SetFilenames`

  Sets all the temporary CGM filenames to be plotted.

  This list will contain the full path of the temporary CGM file to be used during plotting. This list must equal the number of sheets selected to plot and the files will be deleted after the plotting operation is finished.

  Signature `SetFilenames(filenames)`

  Parameters: | filenames (list of str) –

  New in version NX5.0.0.

  License requirements: None.

## SetGraphicFilenames

`PlotBuilder.``SetGraphicFilenames`

  Sets all the Graphic filenames to be saved.

  If the plotter selected is an image type (JPEG, CGM, TIFF, EMF, or PNG) then the graphic filenames text list will contain the full path of where these images will be saved to disk. This list must equal the number of sheets selected to plot.

  Signature `SetGraphicFilenames(filenames)`

  Parameters: | filenames (list of str) –

  New in version NX5.0.0.

  License requirements: None.

## Validate

`PlotBuilder.``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.