PlotWriter

Inherits: PlotWriter < ScriptObject

The PlotWriter is used to generate CAMPlot data from a design with your script.

The methods provided by this object will use the CAMPlot items that are already in the design, so they are useful for performing ‘batch’ style operations to regenerate particular plots or types of plot from existing designs. If you need to alter the contents of plots, or create new ones, you will need to acquire the CAMPlots list from the Document, then use that to manipulate the plot entries in the design.

Methods

Name	Returns	Arguments
SetPrinter	bool	printerName : str
WriteDevicePlots	bool	deviceTypeName : DeviceType outputFolder : Variant[str, none] reportPath : Variant[str, none] onlyEnabledPlots : Variant[bool, none]
WriteGroupPlots	bool	groupName : str outputFolder : Variant[str, none] reportPath : Variant[str, none] onlyEnabledPlots : Variant[bool, none]
WritePlot	bool	plotName : str outputPath : Variant[str, none] reportPath : Variant[str, none]

Method Details

SetPrinter

Set the name of the printer to which Windows plots should be written.

Returns bool.

Arguments:

• printerName : str

---

WriteDevicePlots

Generate all the plots for the specified device type, optionally specifying the output path and report path.

Returns bool.

Arguments:

• deviceTypeName : DeviceType
• outputFolder : Variant[str, none]
• reportPath : Variant[str, none]
• onlyEnabledPlots : Variant[bool, none]

---

WriteGroupPlots

Generate all the plots with the given Plot Group name, optionally specifying the output path and report path.

Returns bool.

Arguments:

• groupName : str
• outputFolder : Variant[str, none]
• reportPath : Variant[str, none]
• onlyEnabledPlots : Variant[bool, none]

---

WritePlot

Generate an existing plot by specifying its name, and optionally the output path and report path.

Returns bool.

Arguments:

• plotName : str
• outputPath : Variant[str, none]
• reportPath : Variant[str, none]