lePlot

lePlot(
[ t_fileName ]
)
=> t / nil

Description

Generates the plot defined in the t_fileName plot template file. Plot options are stored in a disembodied property list called lePlotOptions. When lePlot() loads the plot template file, it reads the plot options from the lePlotOptions property list. There are two ways to create the plot template file: use vi, or save the options in the Submit Plot form to a file. The plot template file is used by lePlot() and by the Load command in the Submit Plot form. However, the following options are ignored by the Load command: library, cell, view, and plotSize.

Arguments

t_fileName

A plot template file that stores plot options in a disembodied property list named lePlotOptions.

Value Returned

`t`	The operation was successful.
`nil`	The operation was not successful.

Examples

Plots a cellview as specified in myPlotTemplateFile.

lePlot("myPlotTemplateFile")

Sample lePlotOptions template file

lePlotOptions = '(nil
    area             "whole"
    view             "layout"
    cell             "Inv"
    library          "master"
    plot             "cellview"
    bBox             ((0.0 0.0) (10.0 36.0))
    noteText         "For Your Review"
    notes            t
    header           t
    plotterType      "postscript1"
    papersize        "A"
    plotter          "HP"
    plotToFile       nil
    display          "display"
    outputfile       ""
    time             "now"
    tmpdir           "/usr/tmp"
    copy             1
    scale            7408.333333
    center           nil
    mailto           "user_name"
    mail             t
    orientation      "automatic"
    plotsize         (2.916667 10.5)
    offset           (0.0 0.0)
    unit             "inches"
    gridMultiple     5
    gridSpacing      1.000000
    gridType         "Dots"
    stopLevel        32
    startLevel       0
    arrayDisplay     "Full"
    instName         "instance"
    pathCL           "yes"
    drawAxesOn       t
    iconsOn          nil
)

You can also insert the lePlotOptions into the .cdsinit file. Each time you print, the options from that template file are used. However, the library name, cell name, and the view name in the lePlotOptions template file are not used, they are generated by the cellview window from which you are printing.

Additional Information

The following table describes the various plot options.

Plot Option	Type	Description
`area`	String	`whole` plots entire cellview, `select` plots selected area, `reselect` plots a reselected area.
`arrayDisplay`	String	`Full` prints all instances in the array, `Border` prints only the instances around the outside edge of the array, `Source` prints only the instance in the lower left corner of the array.
`bBox`	Floating	Specifies in user units the part of the cellview to be plotted. Defaults to the cellview’s bounding box.
`cell`	String	Name of the cell to be plotted. Used by `lePlot()` only.
`center`	Boolean	If `t`, the design is centered on the page.
`copy`	Integer	Number of copies to print.
`display`	String	Display name that specifies the display packets to use when generating the plot.
`drawAxesOn`	Boolean	If `t`, the axes are plotted.
`gridMultiple`	Integer	Major grid lines or dots are displayed every `gridMultiple` units. Major grid lines are thicker than minor grid lines. Major grid dots are larger than minor grid dots. This corresponds to the Major Spacing field in the Plot Display Options form.
`gridSpacing`	Integer	Minor grid lines or dots are displayed every `gridSpacing` units. Minor grid lines are thinner than major grid lines. Minor grid dots are smaller than major grid dots. This corresponds to the Minor Spacing field in the plot Display Options form.
`gridType`	String	Specifies grid type of `None`, `Dots`, or `Lines`.
`header`	Boolean	If `t`, displays a header and legend on the plot.
`iconsOn`	Boolean	If `t`, displays only outlines of instances in arrays.
`instName`	Boolean	If `t`, displays instance name.
`library`	String	Name of the cell’s library to be plotted. Used by `lePlot()` only.
`mail`	Boolean	If `t`, plot notification is e-mailed to addresses specified by `mailto`. If `nil`, plot notification is not e-mailed.
`mailto`	String	Addresses to receive plot notification. Separate addresses with spaces.
`notes`	Boolean	If `t`, displays information specified by `noteText`.
`noteText`	String	Text displayed on the plot if `notes` is `t`.
`offset`	Floating	Specifies the X and Y origin of the cellview or viewing area in measurements specified by `unit`. The offset is a pair of floating-point values. If the plot spans more than one page, the offset is from the bottom left corner.
`orientation`	String	Sets what edge of the paper to use as the top. `portrait` plots the cellview as it appears in window, `landscape` rotates the cellview 90 degrees counterclockwise, `automatic` plots the cellview whichever way fits best.
`outputfile`	String	Saves plot information to the specified file instead of sending it to the printer.
`papersize`	String	Name of paper size for specified plotter.
`pathCL`	String	If `yes`, plots paths with center lines; if `no`, plots paths without centerlines; if `only`, plots centerlines only.
`plotsize`	Floating	Specifies the width and height of the resulting plot in inches. If `plotsize` is not specified, one of the following occurs: If `scale` is specified, the `plotsize` is the `bBox` size scaled. If area is `whole`, the `plotsize` is the size of the `bBox` for the plotter and `papersize`. If none of the above is true, the `plotsize` defaults to 8x10.5 inches. Used by `lePlot()` only.
`plot`	String	Name of the cellview to be plotted.
`plotter`	String	Name of the plotter specified in the `.cdsplotinit` file.
`plotterType`	String	Specifies the type of file the printer expects.
`plotToFile`	Boolean	If `t`, the design is plotted to a file.
`scale`	Floating	Specifies the magnification of the plot in measurements specified by `unit`.
`startLevel`	Integer	Specifies the first level in the design hierarchy to be plotted.
`stopLevel`	Integer	Specifies the last level in the design hierarchy to be plotted.
`time`	String	Specifies the time to plot the design. The plot is stored in `tmpdir` until it is plotted. Use one of the following formats to set time: - `now` (plot immediately) - hh`:`mm `am/pm` day (plot at specified time, for example: `03:15 PM Wed`)
`tmpdir`	String	Specifies the directory where the plot is to be stored if it is not sent to the plotter.
`unit`	String	Specifies the type of measurement for `plotsize`, `scale`, and `offset`. Valid units are `inches`, `cm`, `mm`, and `feet`. Default is `inches`.
`view`	String	Name of the cell’s view to be plotted. Used by `lePlot()` only.

Return to top

Virtuoso Layout Suite SKILL ReferenceProduct Version IC23.1, November 2023