Product Documentation
Virtuoso ADE SKILL Reference
Product Version IC23.1, November 2023

maeSaveImagesUsingPlottingTemplate

maeSaveImagesUsingPlottingTemplate(
[ ?session t_sessionName ] 
[ ?history t_historyName ] 
[ ?replaceMode t_replaceMode ] 
[ ?name t_templateName ] 
[ ?dir t_dirPath ] 
[ ?saveEachSubwindowSeparately t_saveEachSubwindowSeparately ] 
)
=> t / nil

Description

Plots and saves the results for the given history using the specified plotting template.

Arguments

?session t_sessionName

Name of the maestro session.

If not specified, the current session is used.

?history t_historyName

Name of the history for which the results are to be plotted

If not specified, the history saved for the last run is used.

?replaceMode t_replaceMode

Specifies the plotting mode.

  • t: Specifies that the currently open window should be replaced with the plotted template.
  • nil: Specifies that the template should open in a new window. This is the default.

?name t_templateName

Name of the template to be used for plotting.

?dir t_dirPath

Path to the directory in which plots are to be saved.

?saveEachSubwindowSeparately t_saveEachSubwindowSeparately

Specifies whether to save each subwindow in a separate image.

  • t: Saves each subwindow in a separate image. This is the default.
  • nil: The subwindows are not saved in separate images.

Value Returned

t

The windows are successfully plotted.

nil

Indicates an error.

Examples

Returns a list of templates and use those for plotting for results saved in a history. 

maeGetAllPlottingTemplates()
=> (("p2" "Interactive.28" "May 14 12:19:12 2019" "") 
   ("p1" "Interactive.29" "May 14 12:19:58 2019" "test")
)

Plots the templates and saves the windows as images, for example, window:33.png, in the current project directory.

maeSaveImagesUsingPlottingTemplate(?history "Interactive.29" ?replaceMode nil ?name "p1" ?dir "." ?saveEachSubwindowSeparately t)
=> t

Return to top
 ⠀
X